Interface IListStyleSheetManager
Package: @aurigma/design-atoms-text
Methods
clearAllStyleSheets()
Clears all style sheets.
Declaration
clearAllStyleSheets(): void;Returns
| Type | Description |
|---|---|
| void |
createDefaultBulletedStyleSheet(bulletCharCode)
Creates a new style sheet with default style for bulleted list.
Declaration
createDefaultBulletedStyleSheet(bulletCharCode: number): IListStyleSheetAccessor;Parameters
| Type | Name | Description |
|---|---|---|
| number | bulletCharCode |
character code used as 'bullet' (e.g., code 8225 used for “‡“). stylesheet with unique name. |
Returns
| Type | Description |
|---|---|
| IListStyleSheetAccessor |
createDefaultNumberedStyleSheet(numberingFormat)
Creates a new style sheet with default style for numbered list.
Declaration
createDefaultNumberedStyleSheet(numberingFormat: NumberingFormatType): IListStyleSheetAccessor;Parameters
| Type | Name | Description |
|---|---|---|
| NumberingFormatType | numberingFormat |
numbering format. stylesheet with unique name. |
Returns
| Type | Description |
|---|---|
| IListStyleSheetAccessor |
createEmptyStyleSheet()
Creates a new empty stylesheet. stylesheet with unique name.
Declaration
createEmptyStyleSheet(): IListStyleSheetAccessor;Returns
| Type | Description |
|---|---|
| IListStyleSheetAccessor |
createStyleSheet(listStyles)
Creates a new style sheet by existing list styles.
Declaration
createStyleSheet(listStyles: IListStyle[]): IListStyleSheetAccessor;Parameters
| Type | Name | Description |
|---|---|---|
| IListStyle[] | listStyles |
list styles. stylesheet with unique name. |
Returns
| Type | Description |
|---|---|
| IListStyleSheetAccessor |
getAllStyleSheets()
Returns all style sheets.
Declaration
getAllStyleSheets(): IListStyleSheetAccessor[];Returns
| Type | Description |
|---|---|
| IListStyleSheetAccessor[] |
getDefaultListLevelGap(type)
Returns the default gap between list levels.
Declaration
getDefaultListLevelGap(type: ListType): number;Parameters
| Type | Name | Description |
|---|---|---|
| ListType | type |
list type. |
Returns
| Type | Description |
|---|---|
| number |
getDefaultListStyle(type, level)
Returns the default list style by type.
Declaration
getDefaultListStyle(type: ListType, level: number): IListStyle;Parameters
| Type | Name | Description |
|---|---|---|
| ListType | type |
list type. |
| number | level |
list level. |
Returns
| Type | Description |
|---|---|
| IListStyle |
getListSetting()
Returns list settings.
Declaration
getListSetting(): IListSetting;Returns
| Type | Description |
|---|---|
| IListSetting |
getStyleSheet(name)
Returns the list style sheet by name.
Declaration
getStyleSheet(name: string): IListStyleSheetAccessor | null;Parameters
| Type | Name | Description |
|---|---|---|
| string | name |
unique name of stylesheet. |
Returns
| Type | Description |
|---|---|
| IListStyleSheetAccessor | null |
getStyleSheetsCount()
Returns the number of style sheets.
Declaration
getStyleSheetsCount(): number;Returns
| Type | Description |
|---|---|
| number |
initialize(styleSheets)
Clears and initializes list style sheets.
Declaration
initialize(styleSheets?: IListStyleSheet[]): void;Parameters
| Type | Name | Description |
|---|---|---|
| IListStyleSheet[] | styleSheets |
Returns
| Type | Description |
|---|---|
| void |
isStyleSheetExists(name)
Checks for the existence of a style sheet.
Declaration
isStyleSheetExists(name: string): boolean;Parameters
| Type | Name | Description |
|---|---|---|
| string | name |
unique name of stylesheet. |
Returns
| Type | Description |
|---|---|
| boolean | true if the style sheet exists, false otherwise. |