Class Gradient

constructor

• new Gradient(): Gradient

• Returns Gradient

mode

alphaKeys

• get alphaKeys(): readonly GradientAlphaKey[]

• Get the alpha keys of the gradient.

  Returns readonly GradientAlphaKey[]

  Memberof

  Gradient

colorKeys

• get colorKeys(): readonly GradientColorKey[]

• Get the color keys of the gradient.

  Returns readonly GradientColorKey[]

  Memberof

  Gradient

addAlphaKey

• addAlphaKey(key): void

• Add an alpha key to the gradient.

  Parameters

  • key: GradientAlphaKey

    The key

  Returns void

  Memberof

  Gradient

• addAlphaKey(time, alpha): void

• Add an alpha key to the gradient.

  Parameters

  • time: number

    The key time
  • alpha: number

    The key alpha

  Returns void

  Memberof

  Gradient

addColorKey

• addColorKey(key): void

• Add a color key to the gradient.

  Parameters

  • key: GradientColorKey

    The key

  Returns void

  Memberof

  Gradient

• addColorKey(time, color): void

• Add a color key to the gradient.

  Parameters

  • time: number

    The key time.
  • color: ColorRepresentation

    The key color.

  Returns void

  Memberof

  Gradient

clear

• clear(): void

• Clear all color and alpha keys.

  Returns void

  Memberof

  Gradient

clearAlphaKeys

• clearAlphaKeys(): void

• Clear all alpha keys.

  Returns void

  Memberof

  Gradient

clearColorKeys

• clearColorKeys(): void

• Clear all color keys.

  Returns void

  Memberof

  Gradient

evaluate

• evaluate(time): Color4

• Evaluate Color4

  Parameters

  • time: number

  Returns Color4

  Memberof

  Gradient

evaluateAlpha

• evaluateAlpha(time): number

• Evaluate alpha

  Parameters

  • time: number

  Returns number

  Memberof

  Gradient

evaluateColor

• evaluateColor(time): Color

• Evaluate color

  Parameters

  • time: number

  Returns Color

  Memberof

  Gradient

random

• random(): Color4

• Random Color4

  Returns Color4

  Memberof

  Gradient

randomAlpha

• randomAlpha(): number

• Random alpha

  Returns number

  Memberof

  Gradient

randomColor

• randomColor(): Color

• Random color

  Returns Color

  Memberof

  Gradient

removeAlphaKey

• removeAlphaKey(index): void

• Remove a alpha key.

  Parameters

  • index: number

    The key index

  Returns void

  Memberof

  Gradient

removeColorKey

• removeColorKey(index): void

• Remove a color key.

  Parameters

  • index: number

    The key index

  Returns void

  Memberof

  Gradient

setAlphaKeys

• setAlphaKeys(alphaKeys): void

• Set alpha keys

  Parameters

  • alphaKeys: GradientAlphaKey[]

    Alpha key array

  Returns void

  Memberof

  Gradient

setColorKeys

• setColorKeys(colorKeys): void

• Set color keys

  Parameters

  • colorKeys: GradientColorKey[]

    Color key array

  Returns void

  Memberof

  Gradient

setKeys

• setKeys(colorKeys, alphaKeys): void

• Set color and alpha keys

  Parameters

  • colorKeys: GradientColorKey[]

    Color key array
  • alphaKeys: GradientAlphaKey[]

    Alpha key array

  Returns void

  Memberof

  Gradient

toJSON

• toJSON(): {
      [key: string]: any;
  }

• Serialize

  Returns {
      [key: string]: any;
  }

  • [key: string]: any

  Memberof

  Gradient

StaticfromJSON

• fromJSON(json): Gradient

• Deserialize

  Parameters

  • json: {
        [key: string]: any;
    }

    • [key: string]: any

  Returns Gradient

  Memberof

  Gradient