Class PathBoundedTextItem

Inheritance

BaseTextItem

PathBoundedTextItem

Package: @aurigma/design-atoms-model

Constructors

(constructor)(text, paths, postScriptFontName, fontSize)

Constructs a new instance of the PathBoundedTextItem class

Declaration

constructor(text?: string, paths?: Path[], postScriptFontName?: string, fontSize?: number);

Parameters

Type	Name	Description
string	text
Path[]	paths
string	postScriptFontName
number	fontSize

Properties

boundingPaths

Declaration

get boundingPaths(): Path[];

set boundingPaths(value: Path[]);

Property Value

Type	Description
Path[]

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

paragraphSettings

Declaration

get paragraphSettings(): ParagraphSettings;

set paragraphSettings(value: ParagraphSettings);

Property Value

Type	Description
ParagraphSettings

pathBoundedTextPermissions

Declaration

get pathBoundedTextPermissions(): PathBoundedTextPermissions;

set pathBoundedTextPermissions(value: PathBoundedTextPermissions);

Property Value

Type	Description
PathBoundedTextPermissions

type

Declaration

type: string;

Property Value

Type	Description
string

type

Declaration

static type: string;

Property Value

Type	Description
string

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: PathBoundedTextItem, destination: BaseTextItem, generateNewIds: boolean, appropriateParentContainer: boolean): void;

Parameters

Type	Name	Description
PathBoundedTextItem	source
BaseTextItem	destination
boolean	generateNewIds
boolean	appropriateParentContainer

Returns

Type	Description
void

clone(generateNewIds, appropriateParentContainer)

Declaration

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

Parameters

Type	Name	Description
boolean	generateNewIds
boolean	appropriateParentContainer

Returns

Type	Description
PathBoundedTextItem

equals(other)

Declaration

equals(other: PathBoundedTextItem): boolean;

Parameters

Type	Name	Description
PathBoundedTextItem	other

Returns

Type	Description
boolean

getSimplifiedObject(omitProperties)

Declaration

getSimplifiedObject(omitProperties?: string[] | string): Object;

Parameters

Type	Name	Description
string[] | string	omitProperties

Returns

Type	Description
Object