Class BoundedTextItem

Inheritance

BaseTextItem

BoundedTextItem

Package: @aurigma/design-atoms-model

Constructors

(constructor)(text, rectangle, postScriptFontName, fontSize)

Constructs a new instance of the BoundedTextItem class

Declaration

constructor(text?: string, rectangle?: RectangleF, postScriptFontName?: string, fontSize?: number);

Parameters

Type	Name	Description
string	text
RectangleF	rectangle
string	postScriptFontName
number	fontSize

Properties

firstBaselineMinOffset

Declaration

get firstBaselineMinOffset(): number;

set firstBaselineMinOffset(value: number);

Property Value

Type	Description
number

firstBaselineOffset

Declaration

get firstBaselineOffset(): FirstBaselineOffset;

set firstBaselineOffset(value: FirstBaselineOffset);

Property Value

Type	Description
FirstBaselineOffset

isVertical

Declaration

get isVertical(): boolean;

set isVertical(value: boolean);

Property Value

Type	Description
boolean

originalHorizontalScale

Declaration

get originalHorizontalScale(): number;

set originalHorizontalScale(value: number);

Property Value

Type	Description
number

originalVerticalScale

Declaration

get originalVerticalScale(): number;

set originalVerticalScale(value: number);

Property Value

Type	Description
number

overflowStrategy

Declaration

get overflowStrategy(): OverflowStrategy;

set overflowStrategy(value: OverflowStrategy);

Property Value

Type	Description
OverflowStrategy

paragraphSettings

Declaration

get paragraphSettings(): ParagraphSettings;

set paragraphSettings(value: ParagraphSettings);

Property Value

Type	Description
ParagraphSettings

scheduledFitMode

Declaration

get scheduledFitMode(): FitMode;

set scheduledFitMode(value: FitMode);

Property Value

Type	Description
FitMode

shrinkMode

Declaration

get shrinkMode(): ShrinkMode;

set shrinkMode(value: ShrinkMode);

Property Value

Type	Description
ShrinkMode

textRectangle

Declaration

get textRectangle(): RectangleF;

set textRectangle(value: RectangleF);

Property Value

Type	Description
RectangleF

type

Declaration

type: string;

Property Value

Type	Description
string

type

Declaration

static type: string;

Property Value

Type	Description
string

verticalAlignment

Declaration

get verticalAlignment(): TextVerticalAlignment;

set verticalAlignment(value: TextVerticalAlignment);

Property Value

Type	Description
TextVerticalAlignment

wrappingMargin

Declaration

get wrappingMargin(): number;

set wrappingMargin(value: number);

Property Value

Type	Description
number

wrappingPath

Declaration

get wrappingPath(): Path;

set wrappingPath(value: Path);

Property Value

Type	Description
Path

Methods

_copy(source, destination, generateNewIds, appropriateParentContainer)

Declaration

protected _copy(source: BoundedTextItem, destination: BaseTextItem, generateNewIds: boolean, appropriateParentContainer: boolean): void;

Parameters

Type	Name	Description
BoundedTextItem	source
BaseTextItem	destination
boolean	generateNewIds
boolean	appropriateParentContainer

Returns

Type	Description
void

clone(generateNewIds, appropriateParentContainer)

Declaration

clone(generateNewIds?: boolean, appropriateParentContainer?: boolean): BoundedTextItem;

Parameters

Type	Name	Description
boolean	generateNewIds
boolean	appropriateParentContainer

Returns

Type	Description
BoundedTextItem

equals(other)

Declaration

equals(other: BoundedTextItem): boolean;

Parameters

Type	Name	Description
BoundedTextItem	other

Returns

Type	Description
boolean