Class GradientAbstract

constructor

• new Gradient(stops?, options?): Gradient

• Parameters

  • Optionalstops: (Stop | [offset: number, color: string, opacity: number])[]
  • Optionaloptions: GradientOptions

  Returns Gradient

Readonly_change

_flagStops

Readonlychange$

spreadMethod

• get spreadMethod(): "pad" | "reflect" | "repeat"

• Indicates what happens if the gradient starts or ends inside the bounds of the target rectangle.

  Returns "pad" | "reflect" | "repeat"

  See

  https://www.w3.org/TR/SVG11/pservers.html#LinearGradientElementSpreadMethodAttribute for more information

• set spreadMethod(spread): void

• Parameters

  • spread: "pad" | "reflect" | "repeat"

  Returns void

stops

• get stops(): Stop[]

• Returns Stop[]

• set stops(stops): void

• Parameters

  • stops: Stop[]

  Returns void

units

• get units(): "userSpaceOnUse" | "objectBoundingBox"

• Indicates how coordinate values are interpreted by the renderer.

  Returns "userSpaceOnUse" | "objectBoundingBox"

  See

  https://www.w3.org/TR/SVG11/pservers.html#RadialGradientElementGradientUnitsAttribute for more information

• set units(units): void

• Parameters

  • units: "userSpaceOnUse" | "objectBoundingBox"

  Returns void

decrementUse

• decrementUse<T>(viewDOM, defs): void

• Indicates to the ColorProvider that it is being used in one less fill or stroke property. The ColorProvider is expected to remove itself from the SVG defs element when no longer used.

  Type Parameters

  • T

  Parameters

  • viewDOM: ViewDOM<T>
  • defs: T

  Returns void

dispose

• dispose(): void

• Returns void

flagReset

• flagReset(dirtyFlag?): this

• Parameters

  • OptionaldirtyFlag: boolean

  Returns this

incrementUse

• incrementUse<T>(viewDOM, defs): void

• Indicates to the ColorProvider that it is being used in one more fill or stroke property. The ColorProvider is expected to add itself to the SVG defs element when being used.

  Type Parameters

  • T

  Parameters

  • viewDOM: ViewDOM<T>
  • defs: T

  Returns void

render

• render<T>(viewDOM, defs): void

• Type Parameters

  • T

  Parameters

  • viewDOM: ViewDOM<T>
  • defs: T

  Returns void

serialize

• serialize(): string

• Provide the value that will be used in the fill or stroke attribute of the consuming element. Usually url(#${this.id}) for gradients and textures but may be e.g. an rgb() or #RRGGBB value.

  Returns string

update

• update(): this

• Returns this