BaseTextItem

Namespaces

• BaseTextItem

Classes

BaseTextItem

Extends

• RectangleItem

Extended by

• ArchedTextItem
• AutoScaledTextItem
• BoundedTextItem
• CurvedTextItem
• PathBoundedTextItem
• PlainTextItem

Constructors

Constructor

new BaseTextItem(
   text?, 
   fontPostScriptName?, 
   fontSize?): BaseTextItem;

Parameters

Parameter	Type
text?	string
fontPostScriptName?	string
fontSize?	number

Returns

BaseTextItem

Overrides

RectangleItem.constructor

Properties

containerName

containerName: string;

Inherited from

RectangleItem.containerName

id

id: string;

Inherited from

RectangleItem.id

isTextPlaceholder

isTextPlaceholder: boolean = false;

listStyles

listStyles: string;

sourcePathId

sourcePathId: string = null;

Inherited from

RectangleItem.sourcePathId

sourcePathLoaded

sourcePathLoaded: boolean = false;

Inherited from

ShapeItem.sourcePathLoaded

textColorForAbnormalRendering

textColorForAbnormalRendering: RgbColor = RgbColors.black;

themeBinding

themeBinding: ThemeBinding;

Inherited from

Item.themeBinding

type

type: string = BaseTextItem.type;

Overrides

RectangleItem.type

values

values: BaseTextValue[] = [];

type

static type: string = "baseText";

Overrides

RectangleItem.type

Accessors

alignment

Get Signature

get alignment(): TextAlignment;

Returns

TextAlignment

Set Signature

set alignment(value): void;

Parameters

Parameter	Type
value	TextAlignment

Returns

void

altBorderColor

Get Signature

get altBorderColor(): Color;

Returns

Color

Set Signature

set altBorderColor(value): void;

Parameters

Parameter	Type
value	Color

Returns

void

Inherited from

RectangleItem.altBorderColor

baselineShift

Get Signature

get baselineShift(): number;

Returns

number

Set Signature

set baselineShift(value): void;

Parameters

Parameter	Type
value	number

Returns

void

blendMode

Get Signature

get blendMode(): BlendMode;

Returns

BlendMode

Set Signature

set blendMode(value): void;

Parameters

Parameter	Type
value	BlendMode

Returns

void

Inherited from

RectangleItem.blendMode

borderColor

Get Signature

get borderColor(): Color;

Returns

Color

Set Signature

set borderColor(value): void;

Parameters

Parameter	Type
value	Color

Returns

void

Inherited from

RectangleItem.borderColor

borderWidth

Get Signature

get borderWidth(): number;

Returns

number

Set Signature

set borderWidth(value): void;

Parameters

Parameter	Type
value	number

Returns

void

Inherited from

RectangleItem.borderWidth

characterLimit

Get Signature

get characterLimit(): number;

Returns

number

Set Signature

set characterLimit(value): void;

Parameters

Parameter	Type
value	number

Returns

void

checkTextCrop

Get Signature

get checkTextCrop(): boolean;

Returns

boolean

Set Signature

set checkTextCrop(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

class

Get Signature

get class(): string;

Returns

string

Set Signature

set class(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

RectangleItem.class

color

Get Signature

get color(): Color;

Returns

Color

Set Signature

set color(value): void;

Parameters

Parameter	Type
value	Color

Returns

void

colorPalette

Get Signature

get colorPalette(): Collection<Color>;

Returns

Collection<Color>

dash

Get Signature

get dash(): number[];

Returns

number[]

Set Signature

set dash(value): void;

Parameters

Parameter	Type
value	number[]

Returns

void

Inherited from

RectangleItem.dash

fillColor

Get Signature

get fillColor(): Color;

Returns

Color

Set Signature

set fillColor(value): void;

Parameters

Parameter	Type
value	Color

Returns

void

Inherited from

RectangleItem.fillColor

fixedBorderWidth

Get Signature

get fixedBorderWidth(): boolean;

Returns

boolean

Set Signature

set fixedBorderWidth(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

RectangleItem.fixedBorderWidth

font

Get Signature

get font(): FontSettings;

Returns

FontSettings

Set Signature

set font(value): void;

Parameters

Parameter	Type
value	FontSettings

Returns

void

fromLayout

Get Signature

get fromLayout(): boolean;

Returns

boolean

Set Signature

set fromLayout(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

RectangleItem.fromLayout

frontendPermissions

Get Signature

get frontendPermissions(): FrontendPermissions;

Returns

FrontendPermissions

Set Signature

set frontendPermissions(value): void;

Parameters

Parameter	Type
value	FrontendPermissions

Returns

void

Inherited from

RectangleItem.frontendPermissions

horizontalScale

Get Signature

get horizontalScale(): number;

Returns

number

Set Signature

set horizontalScale(value): void;

Parameters

Parameter	Type
value	number

Returns

void

isRenderTypeIsNormal

Get Signature

get isRenderTypeIsNormal(): boolean;

Returns

boolean

Inherited from

Item.isRenderTypeIsNormal

isVariable

Get Signature

get isVariable(): boolean;

Returns

boolean

Set Signature

set isVariable(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

RectangleItem.isVariable

itemPermissions

Get Signature

get itemPermissions(): ItemPermissions;

Returns

ItemPermissions

Set Signature

set itemPermissions(value): void;

Parameters

Parameter	Type
value	ItemPermissions

Returns

void

Inherited from

RectangleItem.itemPermissions

leading

Get Signature

get leading(): number;

Returns

number

Set Signature

set leading(value): void;

Parameters

Parameter	Type
value	number

Returns

void

locked

Get Signature

get locked(): boolean;

Returns

boolean

Set Signature

set locked(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

RectangleItem.locked

manipulationPermissions

Get Signature

get manipulationPermissions(): ManipulationPermissions;

Returns

ManipulationPermissions

Set Signature

set manipulationPermissions(value): void;

Parameters

Parameter	Type
value	ManipulationPermissions

Returns

void

Inherited from

RectangleItem.manipulationPermissions

mask

Get Signature

get mask(): ItemMask;

Returns

ItemMask

Set Signature

set mask(value): void;

Parameters

Parameter	Type
value	ItemMask

Returns

void

Inherited from

RectangleItem.mask

maxLineCount

Get Signature

get maxLineCount(): number;

Returns

number

Set Signature

set maxLineCount(value): void;

Parameters

Parameter	Type
value	number

Returns

void

maxLineLength

Get Signature

get maxLineLength(): number;

Returns

number

Set Signature

set maxLineLength(value): void;

Parameters

Parameter	Type
value	number

Returns

void

name

Get Signature

get name(): string;

Returns

string

Set Signature

set name(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

RectangleItem.name

opacity

Get Signature

get opacity(): number;

Returns

number

Set Signature

set opacity(value): void;

Parameters

Parameter	Type
value	number

Returns

void

Inherited from

RectangleItem.opacity

originalText

Get Signature

get originalText(): string;

Returns

string

Set Signature

set originalText(value): void;

Parameters

Parameter	Type
value	string

Returns

void

overlapLinesEnabled

Get Signature

get overlapLinesEnabled(): boolean;

Returns

boolean

Set Signature

set overlapLinesEnabled(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

overprintFill

Get Signature

get overprintFill(): boolean;

Returns

boolean

Set Signature

set overprintFill(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

RectangleItem.overprintFill

overprintStroke

Get Signature

get overprintStroke(): boolean;

Returns

boolean

Set Signature

set overprintStroke(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

RectangleItem.overprintStroke

overprintText

Get Signature

get overprintText(): boolean;

Returns

boolean

Set Signature

set overprintText(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

parentContainer

Get Signature

get parentContainer(): Container;

Returns

Container

Set Signature

set parentContainer(value): void;

Parameters

Parameter	Type
value	Container

Returns

void

Inherited from

RectangleItem.parentContainer

parentGroupItem

Get Signature

get parentGroupItem(): GroupItem;

Returns

GroupItem

Set Signature

set parentGroupItem(value): void;

Parameters

Parameter	Type
value	GroupItem

Returns

void

Inherited from

RectangleItem.parentGroupItem

placeholders

Get Signature

get placeholders(): Collection<InStringPlaceholder>;

Returns

Collection<InStringPlaceholder>

previewFontSize

Get Signature

get previewFontSize(): number;

Returns

number

Set Signature

set previewFontSize(value): void;

Parameters

Parameter	Type
value	number

Returns

void

previewLeading

Get Signature

get previewLeading(): number;

Returns

number

Set Signature

set previewLeading(value): void;

Parameters

Parameter	Type
value	number

Returns

void

previewScale

Get Signature

get previewScale(): number;

Returns

number

Set Signature

set previewScale(value): void;

Parameters

Parameter	Type
value	number

Returns

void

renderingType

Get Signature

get renderingType(): RenderingType;

Returns

RenderingType

Inherited from

Item.renderingType

shadow

Get Signature

get shadow(): ShadowSettings;

Returns

ShadowSettings

Set Signature

set shadow(value): void;

Parameters

Parameter	Type
value	ShadowSettings

Returns

void

shapePermissions

Get Signature

get shapePermissions(): ShapePermissions;

Returns

ShapePermissions

Set Signature

set shapePermissions(value): void;

Parameters

Parameter	Type
value	ShapePermissions

Returns

void

Inherited from

RectangleItem.shapePermissions

sourcePath

Get Signature

get sourcePath(): Path;

Returns

Path

Set Signature

set sourcePath(value): void;

Parameters

Parameter	Type
value	Path

Returns

void

Inherited from

RectangleItem.sourcePath

sourceRectangle

Get Signature

get sourceRectangle(): RectangleF;

Returns

RectangleF

Set Signature

set sourceRectangle(value): void;

Parameters

Parameter	Type
value	RectangleF

Returns

void

Inherited from

RectangleItem.sourceRectangle

stroke

Get Signature

get stroke(): StrokeSettings;

Returns

StrokeSettings

Set Signature

set stroke(value): void;

Parameters

Parameter	Type
value	StrokeSettings

Returns

void

tags

Get Signature

get tags(): object;

Returns

object

Set Signature

set tags(value): void;

Parameters

Parameter	Type
value	{ [key: string]: any; }

Returns

void

Inherited from

RectangleItem.tags

text

Get Signature

get text(): string;

Returns

string

Set Signature

set text(value): void;

Parameters

Parameter	Type
value	string

Returns

void

textPermissions

Get Signature

get textPermissions(): TextPermissions;

Returns

TextPermissions

Set Signature

set textPermissions(value): void;

Parameters

Parameter	Type
value	TextPermissions

Returns

void

textWrappingMode

Get Signature

get textWrappingMode(): WrappingMode;

Returns

WrappingMode

Set Signature

set textWrappingMode(value): void;

Parameters

Parameter	Type
value	WrappingMode

Returns

void

Inherited from

RectangleItem.textWrappingMode

tracking

Get Signature

get tracking(): number;

Returns

number

Set Signature

set tracking(value): void;

Parameters

Parameter	Type
value	number

Returns

void

transform

Get Signature

get transform(): Transform;

Returns

Transform

Set Signature

set transform(value): void;

Parameters

Parameter	Type
value	Transform

Returns

void

Inherited from

RectangleItem.transform

underline

Get Signature

get underline(): boolean;

Returns

boolean

Set Signature

set underline(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

version

Get Signature

get version(): string;

Returns

string

Inherited from

RectangleItem.version

verticalScale

Get Signature

get verticalScale(): number;

Returns

number

Set Signature

set verticalScale(value): void;

Parameters

Parameter	Type
value	number

Returns

void

violationSettings

Get Signature

get violationSettings(): TextViolationSettings;

Returns

TextViolationSettings

Set Signature

set violationSettings(value): void;

Parameters

Parameter	Type
value	TextViolationSettings

Returns

void

Overrides

RectangleItem.violationSettings

visible

Get Signature

get visible(): boolean;

Returns

boolean

Set Signature

set visible(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

RectangleItem.visible

visualizationPermissions

Get Signature

get visualizationPermissions(): VisualizationPermissions;

Returns

VisualizationPermissions

Set Signature

set visualizationPermissions(value): void;

Parameters

Parameter	Type
value	VisualizationPermissions

Returns

void

Inherited from

RectangleItem.visualizationPermissions

Methods

addPropertyChanged()

addPropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

RectangleItem.addPropertyChanged

applyPermissionsConstrain()

applyPermissionsConstrain(): void;

Returns

void

Overrides

RectangleItem.applyPermissionsConstrain

canSetIsVariable()

canSetIsVariable(): boolean;

Returns

boolean

Inherited from

RectangleItem.canSetIsVariable

clone()

clone(generateNewIds?, appropriateParentContainer?): RectangleItem;

Parameters

Parameter	Type	Default value
generateNewIds	boolean	false
appropriateParentContainer	boolean	false

Returns

RectangleItem

Inherited from

RectangleItem.clone

copyTo()

copyTo(destination): void;

Parameters

Parameter	Type
destination	BaseItem

Returns

void

Inherited from

RectangleItem.copyTo

equals()

equals(other): any;

Parameters

Parameter	Type
other	BaseTextItem

Returns

any

Overrides

RectangleItem.equals

generateNewIds()

generateNewIds(): void;

Returns

void

Inherited from

RectangleItem.generateNewIds

getItemChangedEvent()

getItemChangedEvent(): EventWithAutoSenderArg<Item, Item>;

Returns

EventWithAutoSenderArg<Item, Item>

Inherited from

RectangleItem.getItemChangedEvent

getItemChangingEvent()

getItemChangingEvent(): EventObject<Item>;

Returns

EventObject<Item>

Inherited from

RectangleItem.getItemChangingEvent

getPathLoadedEvent()

getPathLoadedEvent(): EventObject<unknown>;

Returns

EventObject<unknown>

Inherited from

RectangleItem.getPathLoadedEvent

getSimplifiedObject()

getSimplifiedObject(omitProperties?): Object;

Parameters

Parameter	Type
omitProperties?	string | string[]

Returns

Object

Overrides

RectangleItem.getSimplifiedObject

getUpdatedText()

getUpdatedText(text): string;

Parameters

Parameter	Type
text	string

Returns

string

isEmpty()

isEmpty(): boolean;

Returns

boolean

isEmptyText()

isEmptyText(): boolean;

Returns

boolean

isEmptyXmlText()

isEmptyXmlText(): boolean;

Returns

boolean

removePropertyChanged()

removePropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

RectangleItem.removePropertyChanged

setTransform()

setTransform(value, suppressOnChanged?): void;

Parameters

Parameter	Type	Default value
value	Transform	undefined
suppressOnChanged	boolean	false

Returns

void

Inherited from

RectangleItem.setTransform

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

Inherited from

RectangleItem.toString

update()

update(item): void;

Parameters

Parameter	Type
item	BaseItem

Returns

void

Inherited from

RectangleItem.update