Interface IPattern

A pattern fill, using a repeating pattern to fill the area.

interface IPattern {
    getBackground(): IColor;
    getForeground(): IColor;
    getPatternType(): BuiltInSheetPattern;
    getType(): "pattern";
    toCSS(darkMode?: boolean, bounds?: Bounds): Properties;
    toJSON(): PatternJSON;
}

Hierarchy (View Summary)

IFill
- IPattern

Index

Methods

getBackground getForeground getPatternType getType toCSS toJSON

Methods

getBackground

getBackground(): IColor
The background color for the pattern.

Returns IColor

getForeground

getForeground(): IColor
The foreground color for the pattern.

Returns IColor

getPatternType

getPatternType(): BuiltInSheetPattern
The type of pattern used.

Returns BuiltInSheetPattern

getType

getType(): "pattern"
Fill type is always IFill.Type.Pattern.

Returns "pattern"
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(): PatternJSON
Returns PatternJSON
Overrides IFill.toJSON