Interface ISolid

A single color fill.

interface ISolid {
    isIFill: true;
    getColor(): IColor;
    getType(): "solid";
    hasVisibleStyling(): boolean;
    isEqual(other: IFill | null): boolean;
    setColor(color: Serializable | null, options?: UpdateOptions): ISolid;
    toCSS(mode?: CSSMode, size?: Size): Properties;
    toJSON(): IFill.JSON;
}

Hierarchy (View Summary)

IFill
- ISolid

Index

Properties

Methods

getColor getType hasVisibleStyling isEqual setColor toCSS toJSON

Properties

`Readonly`isIFill

isIFill: true

For type checking.

Methods

getColor

getColor(): IColor

Returns the color of the fill.

Returns IColor

Overrides IFill.getColor

getType

getType(): "solid"

Fill type is always IFill.Type.Solid.

Returns "solid"

Overrides IFill.getType

hasVisibleStyling

hasVisibleStyling(): boolean

Returns true if the fill has any visible styling

Returns boolean

Inherited from IFill.hasVisibleStyling

isEqual

isEqual(other: IFill | null): boolean
Returns true if the fill is equal to the other fill.
Parameters
- other: IFill | null
Returns boolean

Inherited from IFill.isEqual

setColor

setColor(color: Serializable | null, options?: UpdateOptions): ISolid
Sets the stroke color.
Parameters
- color: Serializable | null
  The stroke color.
- Optionaloptions: UpdateOptions
Returns ISolid

Overrides IFill.setColor

toCSS

toCSS(mode?: CSSMode, size?: Size): Properties
Returns the fill as a set of css string that are suitable for css.
Parameters
- Optionalmode: CSSMode
  The color rendering mode (see IColor.CSSMode): a boolean bakes that mode; 'adaptive' emits light-dark() so a light/dark flip needs no re-render. (Pattern fills bake their SVG data-URI body regardless — a data-URI never sees the host color-scheme.)
- Optionalsize: Size
  Indicates the size of the area being filled.
Returns Properties

Remarks
Size is used for determining the scaling or tiling of the fill within the specified area. (e.g. Scaled Gradient Fill).

Inherited from IFill.toCSS

toJSON

toJSON(): IFill.JSON

Returns the fill as a JSON object.

Returns IFill.JSON

Inherited from IFill.toJSON