Class LinearGradient

Abstraction of a Gradient or Texture.

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_change _flagStops change$ parent zzz

Accessors

id point1 point2 spreadMethod stops units

Methods

decrementUse dispose flagReset incrementUse render serialize update

Constructors

constructor

  • new LinearGradient(point1, point2, stops, options?): LinearGradient

  • Parameters

    • point1: VectorLike

      The position of the first end point of the linear gradient.

    • point2: VectorLike

      The position of the second end point of the linear gradient.

    • stops: (Stop | [offset: number, color: string, opacity: number])[]

      A list of Stops that contain the gradient fill pattern for the gradient. The linear gradient lives within the space of the parent object's matrix space.

    • Optionaloptions: LinearGradientOptions

    Returns LinearGradient

Properties

Readonly_change

_change: Variable<LinearGradient>

_flagStops

_flagStops: boolean

Readonlychange$

change$: Observable<LinearGradient>

parent

parent: unknown

Readonlyzzz

zzz: ZZZ

Accessors

id

  • get id(): string

  • Returns string

  • set id(id): void

  • Parameters

    • id: string

    Returns void

point1

  • get point1(): G20

  • Returns G20

  • set point1(point1): void

  • Parameters

    Returns void

point2

  • get point2(): G20

  • Returns G20

  • set point2(point2): void

  • Parameters

    Returns void

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

    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

Methods

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

    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

    Returns void

render

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

  • Type Parameters

    • T

    Parameters

    Returns this

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

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods