Class LinearGradientBrush

Represents a linear gradient brush.

Hierarchy (View Summary)

Brush
- LinearGradientBrush

Index

Constructors

Accessors

endColor endPoint gradientStops id om startColor startPoint type

Methods

Constructors

constructor

new LinearGradientBrush(
linearGradientBrushProperties: LinearGradientBrushProperties,
): LinearGradientBrush
Creates a linear gradient brush with specified properties.
Parameters
- linearGradientBrushProperties: LinearGradientBrushProperties
  The settings for creating a linear gradient brush.
Returns LinearGradientBrush
Example
```
const brush = new LinearGradientBrush({
    startColor: "ForestGreen",
    startPoint: { x: 0, y: 0 },
    endColor: "Yellow",
    endPoint: { x: 1, y: 0 }
});
```
Overrides Brush.constructor
new LinearGradientBrush(
om: ObjectManager,
linearGradientBrushProperties: LinearGradientBrushProperties,
): LinearGradientBrush
Creates a linear gradient brush with specified properties.
Parameters
- om: ObjectManager
  An object manager that controls the lifetime of the LinearGradientBrush object.
- linearGradientBrushProperties: LinearGradientBrushProperties
  The settings for creating a linear gradient brush.
Returns LinearGradientBrush
Overrides Brush.constructor

Accessors

endColor

get endColor(): Color
Gets the ending gradient color.

Returns Color

endPoint

get endPoint(): Point
Gets the end point of the linear gradient brush. (0, 0) is the top-left corner, (1, 1) is the bottom-right corner.

Returns Point

gradientStops

get gradientStops(): GradientStop[] | null
Gets the array of gradient stops.

Returns GradientStop[] | null

id

get id(): number
Gets the reference to the object.

Returns number
Inherited from Brush.id

om

get om(): ObjectManager
Gets the owner ObjectManager instance.

Returns ObjectManager
Inherited from Brush.om

startColor

get startColor(): Color
Gets the starting gradient color.

Returns Color

startPoint

get startPoint(): Point
Gets the start point of the linear gradient brush. (0, 0) is the top-left corner, (1, 1) is the bottom-right corner.

Returns Point

type

get type(): BrushType
Gets the type of the brush.

Returns BrushType
Overrides Brush.type

Methods

free

free(): void
Detaches the object from the ObjectManager and deallocates its memory, if possible.

Returns void
Inherited from Brush.free

rebind

rebind(omTo: ObjectManager): void
Rebinds the object from the current ObjectManager to the specified one.
Parameters
- omTo: ObjectManager
  The new ObjectManager for the object.
Returns void
Inherited from Brush.rebind