Last updated

API / geotoolkit / report / edit / properties / ITextStyleProperties / ITextStyleProperties

Class: ITextStyleProperties

properties.ITextStyleProperties.ITextStyleProperties

Define text style properties interface

Interface

Implemented by

Table of contents

Constructors
Methods

Contents

Constructors

new ITextStyleProperties()

new ITextStyleProperties()

Methods

clearTextFormatting

Abstract clearTextFormatting(): ITextStyleProperties

Clear custom text style (restore to default Report Settings)

Returns

ITextStyleProperties


getBackgroundColor

Abstract getBackgroundColor(): string | RgbaColor

Returns element background color

Returns

string | RgbaColor

return element background color


getColor

Abstract getColor(): string | RgbaColor

Returns text style color

Returns

string | RgbaColor

return text color


getFontFamily

Abstract getFontFamily(): string

Return font family

Returns

string

return font family


getHighlightColor

Abstract getHighlightColor(): string | RgbaColor

Returns text highlight color

Returns

string | RgbaColor

return text highlight color


getTextAlignment

Abstract getTextAlignment(): string

Returns text alignment

Returns

string

return text alignment


getTextSize

Abstract getTextSize(): string | number

Return text size

Returns

string | number

return text size


getTextStyle

Abstract getTextStyle(): TextStyle

Return text style

Returns

TextStyle

return text style


hasCustomTextFormatting

Abstract hasCustomTextFormatting(): boolean

Return true if text has custom text style declared in attribute

Returns

boolean

return true if text has custom format declared in attribute


isBold

Abstract isBold(): boolean

Return true if text style is bold

Returns

boolean

return true if text style is bold


isItalic

Abstract isItalic(): boolean

Return true if text style is italic

Returns

boolean

return true if text style is italic


isStrikethrough

Abstract isStrikethrough(): boolean

Return true if text has strikethrough style

Returns

boolean

return true if text has underline style


isUnderline

Abstract isUnderline(): boolean

Return true if text has underline style

Returns

boolean

return true if text has underline style


setBackgroundColor

Abstract setBackgroundColor(color): ITextStyleProperties

Set element background color

Parameters

Name Type Description
colorstringelement background color

Returns

ITextStyleProperties


setColor

Abstract setColor(color): ITextStyleProperties

Set text style color

Parameters

Name Type Description
colorstringtext style color

Returns

ITextStyleProperties


setDomElements

Abstract setDomElements(domElements): ITextStyleProperties

Set array of DOM Elements

Parameters

Name Type Description
domElementsElement[]DOM Elements

Returns

ITextStyleProperties


setFontFamily

Abstract setFontFamily(fontFamily): ITextStyleProperties

Set font family

Parameters

Name Type Description
fontFamilystringfont family

Returns

ITextStyleProperties


setHighlightColor

Abstract setHighlightColor(color): ITextStyleProperties

Set text highlight color

Parameters

Name Type Description
colorstringtext highlight color

Returns

ITextStyleProperties


setOnCreateState

Abstract setOnCreateState(callBack): ITextStyleProperties

Set Undo/Redo create state delegate

Parameters

Name Type Description
callBack(documentElement: Element | Element[], fullState: boolean) => IStatecreate undo/redo state delegate

Returns

ITextStyleProperties


setTextAlignment

Abstract setTextAlignment(alignment): ITextStyleProperties

Set text alignment

Parameters

Name Type Description
alignmentstringtext alignment

Returns

ITextStyleProperties


setTextSize

Abstract setTextSize(textSize): ITextStyleProperties

Set text size

Parameters

Name Type Description
textSizenumbertext size

Returns

ITextStyleProperties


setTextStyle

Abstract setTextStyle(textStyle): ITextStyleProperties

Set text style

Parameters

Name Type Description
textStyleTextStylePropertiestext style

Returns

ITextStyleProperties


toggleBold

Abstract toggleBold(): ITextStyleProperties

Change bold style

Returns

ITextStyleProperties


toggleItalic

Abstract toggleItalic(): ITextStyleProperties

Change italic style

Returns

ITextStyleProperties


toggleStrikethrough

Abstract toggleStrikethrough(): ITextStyleProperties

Change strikethrough style

Returns

ITextStyleProperties


toggleUnderline

Abstract toggleUnderline(): ITextStyleProperties

Change underline style

Returns

ITextStyleProperties