Class TextWhizzInitData

Data required to initialize the text engine wrapper.

Package: @aurigma/design-atoms

Remarks

The TextWhizz is used as a text engine.

Constructors

(constructor)(itemHandler, colorPreviewService)

Constructs a new instance of the TextWhizzInitData class

Declaration

constructor(itemHandler: NewBaseTextItemHandler, colorPreviewService: IColorPreviewService);

Parameters

Type	Name	Description
NewBaseTextItemHandler	itemHandler
IColorPreviewService	colorPreviewService

Properties

colorPalette

Declaration

get colorPalette(): Collection<IColorData>;

Property Value

Type	Description
Collection<unknown>

defaultCharStyle

Declaration

get defaultCharStyle(): ICharStyle | null;

Property Value

Type	Description
unknown | null

defaultParagraphStyle

Declaration

get defaultParagraphStyle(): IParagraphStyle | null;

Property Value

Type	Description
IParagraphStyle | null

end

Declaration

get end(): number | null;

Property Value

Type	Description
number | null

firstBaselineMinOffset

Declaration

get firstBaselineMinOffset(): number | null;

Property Value

Type	Description
number | null

firstBaselineOffset

Declaration

get firstBaselineOffset(): FirstBaselineOffset | null;

Property Value

Type	Description
FirstBaselineOffset | null

frames

Declaration

get frames(): ITextFrameData;

Property Value

Type	Description
IFontRegistry

isFitToPath

Declaration

get isFitToPath(): boolean | null;

Property Value

Type	Description
boolean | null

isTextBounded

Declaration

get isTextBounded(): boolean;

Property Value

Type	Description
boolean

isTextVertical

Declaration

get isTextVertical(): boolean;

Property Value

Type	Description
boolean

overflowStrategy

Declaration

get overflowStrategy(): OverflowStrategy | null;

Property Value

Type	Description
OverflowStrategy | null

previewScale

Declaration

get previewScale(): number;

Property Value

Type	Description
number

rectangle

Declaration

get rectangle(): RectangleF;

Property Value

Type	Description
RectangleF

start

Declaration

get start(): number | null;

Property Value

Type	Description
number | null

text

Declaration

get text(): string | Text;

set text(value: string | Text);

Property Value

Type	Description
string | unknown

verticalAlignment

Declaration

get verticalAlignment(): TextVerticalAlignment | null;

Property Value

Type	Description
TextVerticalAlignment | null

wrappingPath

Declaration

get wrappingPath(): IWrappingPathData;

Property Value

Type	Description
IFontRegistry

Methods

getActualFrames()

Declaration

getActualFrames(): ITextFrameData;

Returns

Type	Description
IFontRegistry

getDefaultInlineStyle(item, colorPreviewService)

Declaration

static getDefaultInlineStyle(item: BaseTextItem, colorPreviewService: IColorPreviewService): Promise<ICharStyle>;

Parameters

Type	Name	Description
BaseTextItem	item
IColorPreviewService	colorPreviewService

Returns

Type	Description
Promise<unknown>

getDefaultParagraphStyle(item)

Declaration

static getDefaultParagraphStyle(item: BaseTextItem): IParagraphStyle;

Parameters

Type	Name	Description
BaseTextItem	item

Returns

Type	Description
IParagraphStyle

update(customText)

Declaration

update(customText?: string): Promise<void>;

Parameters

Type	Name	Description
string	customText

Returns

Type	Description
Promise<void>