Class BaseTextItem

Inheritance

BaseTextItem

Package: @aurigma/design-atoms-model

Constructors

(constructor)(text, fontPostScriptName, fontSize)

Constructs a new instance of the BaseTextItem class

Declaration

constructor(text?: string, fontPostScriptName?: string, fontSize?: number);

Parameters

Type	Name	Description
string	text
string	fontPostScriptName
number	fontSize

Properties

alignment

Declaration

get alignment(): TextAlignment;

set alignment(value: TextAlignment);

Property Value

Type	Description
TextAlignment

baselineShift

Declaration

get baselineShift(): number;

set baselineShift(value: number);

Property Value

Type	Description
number

characterLimit

Declaration

get characterLimit(): number;

set characterLimit(value: number);

Property Value

Type	Description
number

checkTextCrop

Declaration

get checkTextCrop(): boolean;

set checkTextCrop(value: boolean);

Property Value

Type	Description
boolean

color

Declaration

get color(): Color;

set color(value: Color);

Property Value

Type	Description
Color

colorPalette

Declaration

get colorPalette(): Collection<Color>;

Property Value

Type	Description
Collection<Color>

font

Declaration

get font(): BaseTextItem.FontSettings;

set font(value: BaseTextItem.FontSettings);

Property Value

Type	Description
FontSettings

horizontalScale

Declaration

get horizontalScale(): number;

set horizontalScale(value: number);

Property Value

Type	Description
number

isTextPlaceholder

Declaration

isTextPlaceholder: boolean;

Property Value

Type	Description
boolean

leading

Declaration

get leading(): number;

set leading(value: number);

Property Value

Type	Description
number

listStyles

Declaration

listStyles: string;

Property Value

Type	Description
string

maxLineCount

Declaration

get maxLineCount(): number;

set maxLineCount(value: number);

Property Value

Type	Description
number

maxLineLength

Declaration

get maxLineLength(): number;

set maxLineLength(value: number);

Property Value

Type	Description
number

originalText

Declaration

get originalText(): string;

set originalText(value: string);

Property Value

Type	Description
string

overlapLinesEnabled

Declaration

get overlapLinesEnabled(): boolean;

set overlapLinesEnabled(value: boolean);

Property Value

Type	Description
boolean

overprintText

Declaration

get overprintText(): boolean;

set overprintText(value: boolean);

Property Value

Type	Description
boolean

placeholders

Declaration

get placeholders(): Collection<InStringPlaceholder>;

Property Value

Type	Description
Collection<InStringPlaceholder>

previewFontSize

Declaration

get previewFontSize(): number;

set previewFontSize(value: number);

Property Value

Type	Description
number

previewLeading

Declaration

get previewLeading(): number;

set previewLeading(value: number);

Property Value

Type	Description
number

previewScale

Declaration

get previewScale(): number;

set previewScale(value: number);

Property Value

Type	Description
number

shadow

Declaration

get shadow(): ShadowSettings;

set shadow(value: ShadowSettings);

Property Value

Type	Description
ShadowSettings

stroke

Declaration

get stroke(): StrokeSettings;

set stroke(value: StrokeSettings);

Property Value

Type	Description
StrokeSettings

text

Declaration

get text(): string;

set text(value: string);

Property Value

Type	Description
string

textColorForAbnormalRendering

Declaration

textColorForAbnormalRendering: RgbColor;

Property Value

Type	Description
RgbColor

textPermissions

Declaration

get textPermissions(): TextPermissions;

set textPermissions(value: TextPermissions);

Property Value

Type	Description
TextPermissions

tracking

Declaration

get tracking(): number;

set tracking(value: number);

Property Value

Type	Description
number

type

Declaration

type: string;

Property Value

Type	Description
string

type

Declaration

static type: string;

Property Value

Type	Description
string

underline

Declaration

get underline(): boolean;

set underline(value: boolean);

Property Value

Type	Description
boolean

values

Declaration

values: BaseTextItem.BaseTextValue[];

Property Value

Type	Description
BaseTextItem.BaseTextValue[]

verticalScale

Declaration

get verticalScale(): number;

set verticalScale(value: number);

Property Value

Type	Description
number

violationSettings

Declaration

get violationSettings(): TextViolationSettings;

set violationSettings(value: TextViolationSettings);

Property Value

Type	Description
TextViolationSettings

Methods

_canSetIsVariable()

Declaration

protected _canSetIsVariable(): boolean;

Returns

Type	Description
boolean

_copy(source, destination, generateNewIds, appropriateParentContainer)

Declaration

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

Parameters

Type	Name	Description
BaseTextItem	source
BaseTextItem	destination
boolean	generateNewIds
boolean	appropriateParentContainer

Returns

Type	Description
void

_setViolationSettings(value, skipTypeCheck)

Declaration

protected _setViolationSettings(value: TextViolationSettings, skipTypeCheck?: boolean): void;

Parameters

Type	Name	Description
TextViolationSettings	value
boolean	skipTypeCheck

Returns

Type	Description
void

applyPermissionsConstrain()

Declaration

applyPermissionsConstrain(): void;

Returns

Type	Description
void

equals(other)

Declaration

equals(other: BaseTextItem): boolean;

Parameters

Type	Name	Description
BaseTextItem	other

Returns

Type	Description
boolean

getSimplifiedObject(omitProperties)

Declaration

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

Parameters

Type	Name	Description
string[] \| string	omitProperties

Returns

Type	Description
Object

getUpdatedText(text)

Declaration

getUpdatedText(text: string): string;

Parameters

Type	Name	Description
string	text

Returns

Type	Description
string

isEmpty()

Declaration

isEmpty(): boolean;

Returns

Type	Description
boolean

isEmptyText()

Declaration

isEmptyText(): boolean;

Returns

Type	Description
boolean

isEmptyXmlText()

Declaration

isEmptyXmlText(): boolean;

Returns

Type	Description
boolean