Interface IStroke

interface IStroke {
    isIStroke: true;
    getColor(): IColor;
    getProperties(): StrokeProperties;
    getStyle(): IBorders.StrokeStyle;
    isNone(): boolean;
    setColor(
        color: Serializable | null,
        options?: UpdateOptions,
    ): IBorders.IStroke;
    setStyle(style: string | null, options?: UpdateOptions): IBorders.IStroke;
    toCSS(): Partial<CSSStyleDeclaration>;
}

Index

Properties

Methods

getColor getProperties getStyle isNone setColor setStyle toCSS

Properties

`Readonly`isIStroke

isIStroke: true

For runtime type checking.

Methods

getColor

getColor(): IColor

Returns IColor

getProperties

getProperties(): StrokeProperties

Returns all the set properties and their values for the border.

Returns StrokeProperties

getStyle

getStyle(): IBorders.StrokeStyle

Returns IBorders.StrokeStyle

isNone

isNone(): boolean

Returns boolean
true StrokeStyle is None.

setColor

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

setStyle

setStyle(style: string | null, options?: UpdateOptions): IBorders.IStroke
Sets the stroke style.
Parameters
- style: string | null
  The stroke style.
- Optionaloptions: UpdateOptions
Returns IBorders.IStroke

toCSS

toCSS(): Partial<CSSStyleDeclaration>

Returns a set of CSSStyleDeclaration that approximate the stroke.

Returns Partial<CSSStyleDeclaration>