Item

Classes

Item

Extends

• BaseItem

Extended by

• GridItem
• GroupItem
• LineItem
• PolylineItem
• ShapeItem

Constructors

Constructor

new Item(): Item;

Returns

Item

Overrides

BaseItem.constructor

Properties

containerName

containerName: string;

id

id: string;

Inherited from

BaseItem.id

themeBinding

themeBinding: ThemeBinding;

type

type: string = Item.type;

Overrides

BaseItem.type

type

static type: string = "item";

Overrides

BaseItem.type

Accessors

blendMode

Get Signature

get blendMode(): BlendMode;

Returns

BlendMode

Set Signature

set blendMode(value): void;

Parameters

Parameter	Type
value	BlendMode

Returns

void

class

Get Signature

get class(): string;

Returns

string

Set Signature

set class(value): void;

Parameters

Parameter	Type
value	string

Returns

void

fromLayout

Get Signature

get fromLayout(): boolean;

Returns

boolean

Set Signature

set fromLayout(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

frontendPermissions

Get Signature

get frontendPermissions(): FrontendPermissions;

Returns

FrontendPermissions

Set Signature

set frontendPermissions(value): void;

Parameters

Parameter	Type
value	FrontendPermissions

Returns

void

isRenderTypeIsNormal

Get Signature

get isRenderTypeIsNormal(): boolean;

Returns

boolean

isVariable

Get Signature

get isVariable(): boolean;

Returns

boolean

Set Signature

set isVariable(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

itemPermissions

Get Signature

get itemPermissions(): ItemPermissions;

Returns

ItemPermissions

Set Signature

set itemPermissions(value): void;

Parameters

Parameter	Type
value	ItemPermissions

Returns

void

locked

Get Signature

get locked(): boolean;

Returns

boolean

Set Signature

set locked(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

manipulationPermissions

Get Signature

get manipulationPermissions(): ManipulationPermissions;

Returns

ManipulationPermissions

Set Signature

set manipulationPermissions(value): void;

Parameters

Parameter	Type
value	ManipulationPermissions

Returns

void

mask

Get Signature

get mask(): ItemMask;

Returns

ItemMask

Set Signature

set mask(value): void;

Parameters

Parameter	Type
value	ItemMask

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

BaseItem.name

opacity

Get Signature

get opacity(): number;

Returns

number

Set Signature

set opacity(value): void;

Parameters

Parameter	Type
value	number

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

BaseItem.parentContainer

parentGroupItem

Get Signature

get parentGroupItem(): GroupItem;

Returns

GroupItem

Set Signature

set parentGroupItem(value): void;

Parameters

Parameter	Type
value	GroupItem

Returns

void

renderingType

Get Signature

get renderingType(): RenderingType;

Returns

RenderingType

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

BaseItem.tags

textWrappingMode

Get Signature

get textWrappingMode(): WrappingMode;

Returns

WrappingMode

Set Signature

set textWrappingMode(value): void;

Parameters

Parameter	Type
value	WrappingMode

Returns

void

transform

Get Signature

get transform(): Transform;

Returns

Transform

Set Signature

set transform(value): void;

Parameters

Parameter	Type
value	Transform

Returns

void

version

Get Signature

get version(): string;

Returns

string

Inherited from

BaseItem.version

violationSettings

Get Signature

get violationSettings(): ViolationSettings;

Returns

ViolationSettings

Set Signature

set violationSettings(value): void;

Parameters

Parameter	Type
value	ViolationSettings

Returns

void

visible

Get Signature

get visible(): boolean;

Returns

boolean

Set Signature

set visible(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

visualizationPermissions

Get Signature

get visualizationPermissions(): VisualizationPermissions;

Returns

VisualizationPermissions

Set Signature

set visualizationPermissions(value): void;

Parameters

Parameter	Type
value	VisualizationPermissions

Returns

void

Methods

addPropertyChanged()

addPropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

BaseItem.addPropertyChanged

applyPermissionsConstrain()

applyPermissionsConstrain(): void;

Returns

void

canSetIsVariable()

canSetIsVariable(): boolean;

Returns

boolean

clone()

clone(generateNewIds?, appropriateParentContainer?): BaseItem;

Parameters

Parameter	Type	Default value
generateNewIds	boolean	false
appropriateParentContainer	boolean	false

Returns

BaseItem

Inherited from

BaseItem.clone

copyTo()

copyTo(destination): void;

Parameters

Parameter	Type
destination	BaseItem

Returns

void

Inherited from

BaseItem.copyTo

equals()

equals(other): boolean;

Parameters

Parameter	Type
other	Item

Returns

boolean

Overrides

BaseItem.equals

generateNewIds()

generateNewIds(): void;

Returns

void

Inherited from

BaseItem.generateNewIds

getItemChangedEvent()

getItemChangedEvent(): EventWithAutoSenderArg<Item, Item>;

Returns

EventWithAutoSenderArg<Item, Item>

getItemChangingEvent()

getItemChangingEvent(): EventObject<Item>;

Returns

EventObject<Item>

getSimplifiedObject()

getSimplifiedObject(omitProperties?): Object;

Parameters

Parameter	Type
omitProperties?	string | string[]

Returns

Object

Overrides

BaseItem.getSimplifiedObject

removePropertyChanged()

removePropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

BaseItem.removePropertyChanged

setTransform()

setTransform(value, suppressOnChanged?): void;

Parameters

Parameter	Type	Default value
value	Transform	undefined
suppressOnChanged	boolean	false

Returns

void

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

Inherited from

BaseItem.toString

update()

update(item): void;

Parameters

Parameter	Type
item	BaseItem

Returns

void

Inherited from

BaseItem.update