Interface IGradient

A gradient fill, where colors transition across the area.

interface IGradient {
    getAngle(): number;
    getFillTo(): Rectangle;
    getGradientType(): GradientType;
    getStops(): IGradientStop[];
    getType(): "gradient";
    toCSS(darkMode?: boolean, bounds?: Bounds): Properties;
    toJSON(): GradientJSON;
}

Hierarchy (View Summary)

IFill
- IGradient

Index

Methods

getAngle getFillTo getGradientType getStops getType toCSS toJSON

Methods

getAngle

getAngle(): number
The angle of the gradient in degrees if gradient type is linear.

Returns number

getFillTo

getFillTo(): Rectangle
Used for path and circular gradients.

Returns Rectangle

getGradientType

getGradientType(): GradientType
The type of gradient.

Returns GradientType
Default Value
```
GradientType.Linear
```

getStops

getStops(): IGradientStop[]
The stops for the gradient.

Returns IGradientStop[]
Remarks
- This must be at least two stops.

getType

getType(): "gradient"
Fill type is always IFill.Type.Gradient.

Returns "gradient"
Overrides IFill.getType

toCSS

toCSS(darkMode?: boolean, bounds?: Bounds): Properties
Returns the fill as a set of css string that are suitable for css.
Parameters
- OptionaldarkMode: boolean
- Optionalbounds: Bounds
Returns Properties
Remarks
Not all fill styles will offer an exact css equivalent. Additionally due to the nature of css having different properties for the same logic value (for example color, backgroundColor)

Inherited from IFill.toCSS

toJSON

toJSON(): GradientJSON
Returns GradientJSON
Overrides IFill.toJSON