ShapeItem

Classes

ShapeItem

Extends

• Item

Extended by

• EllipseItem
• PlaceholderItem
• RectangleItem

Constructors

Constructor

new ShapeItem(sourcePath?): ShapeItem;

Parameters

Parameter	Type
sourcePath?	Path

Returns

ShapeItem

Overrides

Item.constructor

Properties

containerName

containerName: string;

Inherited from

Item.containerName

id

id: string;

Inherited from

Item.id

sourcePathId

sourcePathId: string = null;

sourcePathLoaded

sourcePathLoaded: boolean = false;

themeBinding

themeBinding: ThemeBinding;

Inherited from

Item.themeBinding

type

type: string = ShapeItem.type;

Overrides

Item.type

type

static type: string = "ShapeItem";

Overrides

Item.type

Accessors

altBorderColor

Get Signature

get altBorderColor(): Color;

Returns

Color

Set Signature

set altBorderColor(value): void;

Parameters

Parameter	Type
value	Color

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

Item.blendMode

borderColor

Get Signature

get borderColor(): Color;

Returns

Color

Set Signature

set borderColor(value): void;

Parameters

Parameter	Type
value	Color

Returns

void

borderWidth

Get Signature

get borderWidth(): number;

Returns

number

Set Signature

set borderWidth(value): void;

Parameters

Parameter	Type
value	number

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

Item.class

dash

Get Signature

get dash(): number[];

Returns

number[]

Set Signature

set dash(value): void;

Parameters

Parameter	Type
value	number[]

Returns

void

fillColor

Get Signature

get fillColor(): Color;

Returns

Color

Set Signature

set fillColor(value): void;

Parameters

Parameter	Type
value	Color

Returns

void

fixedBorderWidth

Get Signature

get fixedBorderWidth(): boolean;

Returns

boolean

Set Signature

set fixedBorderWidth(value): void;

Parameters

Parameter	Type
value	boolean

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

Item.fromLayout

frontendPermissions

Get Signature

get frontendPermissions(): FrontendPermissions;

Returns

FrontendPermissions

Set Signature

set frontendPermissions(value): void;

Parameters

Parameter	Type
value	FrontendPermissions

Returns

void

Inherited from

Item.frontendPermissions

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

Item.isVariable

itemPermissions

Get Signature

get itemPermissions(): ItemPermissions;

Returns

ItemPermissions

Set Signature

set itemPermissions(value): void;

Parameters

Parameter	Type
value	ItemPermissions

Returns

void

Inherited from

Item.itemPermissions

locked

Get Signature

get locked(): boolean;

Returns

boolean

Set Signature

set locked(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

Item.locked

manipulationPermissions

Get Signature

get manipulationPermissions(): ManipulationPermissions;

Returns

ManipulationPermissions

Set Signature

set manipulationPermissions(value): void;

Parameters

Parameter	Type
value	ManipulationPermissions

Returns

void

Inherited from

Item.manipulationPermissions

mask

Get Signature

get mask(): ItemMask;

Returns

ItemMask

Set Signature

set mask(value): void;

Parameters

Parameter	Type
value	ItemMask

Returns

void

Inherited from

Item.mask

name

Get Signature

get name(): string;

Returns

string

Set Signature

set name(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Inherited from

Item.name

opacity

Get Signature

get opacity(): number;

Returns

number

Set Signature

set opacity(value): void;

Parameters

Parameter	Type
value	number

Returns

void

Inherited from

Item.opacity

overprintFill

Get Signature

get overprintFill(): boolean;

Returns

boolean

Set Signature

set overprintFill(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

overprintStroke

Get Signature

get overprintStroke(): boolean;

Returns

boolean

Set Signature

set overprintStroke(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

Item.parentContainer

parentGroupItem

Get Signature

get parentGroupItem(): GroupItem;

Returns

GroupItem

Set Signature

set parentGroupItem(value): void;

Parameters

Parameter	Type
value	GroupItem

Returns

void

Inherited from

Item.parentGroupItem

renderingType

Get Signature

get renderingType(): RenderingType;

Returns

RenderingType

Inherited from

Item.renderingType

shapePermissions

Get Signature

get shapePermissions(): ShapePermissions;

Returns

ShapePermissions

Set Signature

set shapePermissions(value): void;

Parameters

Parameter	Type
value	ShapePermissions

Returns

void

sourcePath

Get Signature

get sourcePath(): Path;

Returns

Path

Set Signature

set sourcePath(value): void;

Parameters

Parameter	Type
value	Path

Returns

void

sourceRectangle

Get Signature

get sourceRectangle(): RectangleF;

Returns

RectangleF

Set Signature

set sourceRectangle(value): void;

Parameters

Parameter	Type
value	RectangleF

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

Item.tags

textWrappingMode

Get Signature

get textWrappingMode(): WrappingMode;

Returns

WrappingMode

Set Signature

set textWrappingMode(value): void;

Parameters

Parameter	Type
value	WrappingMode

Returns

void

Inherited from

Item.textWrappingMode

transform

Get Signature

get transform(): Transform;

Returns

Transform

Set Signature

set transform(value): void;

Parameters

Parameter	Type
value	Transform

Returns

void

Inherited from

Item.transform

version

Get Signature

get version(): string;

Returns

string

Inherited from

Item.version

violationSettings

Get Signature

get violationSettings(): ShapeViolationSettings;

Returns

ShapeViolationSettings

Set Signature

set violationSettings(value): void;

Parameters

Parameter	Type
value	ShapeViolationSettings

Returns

void

Overrides

Item.violationSettings

visible

Get Signature

get visible(): boolean;

Returns

boolean

Set Signature

set visible(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Inherited from

Item.visible

visualizationPermissions

Get Signature

get visualizationPermissions(): VisualizationPermissions;

Returns

VisualizationPermissions

Set Signature

set visualizationPermissions(value): void;

Parameters

Parameter	Type
value	VisualizationPermissions

Returns

void

Inherited from

Item.visualizationPermissions

Methods

addPropertyChanged()

addPropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

Item.addPropertyChanged

applyPermissionsConstrain()

applyPermissionsConstrain(): void;

Returns

void

Overrides

Item.applyPermissionsConstrain

canSetIsVariable()

canSetIsVariable(): boolean;

Returns

boolean

Inherited from

Item.canSetIsVariable

clone()

clone(generateNewIds?, appropriateParentContainer?): ShapeItem;

Parameters

Parameter	Type	Default value
generateNewIds	boolean	false
appropriateParentContainer	boolean	false

Returns

ShapeItem

Overrides

Item.clone

copyTo()

copyTo(destination): void;

Parameters

Parameter	Type
destination	BaseItem

Returns

void

Inherited from

Item.copyTo

equals()

equals(other): any;

Parameters

Parameter	Type
other	ShapeItem

Returns

any

Overrides

Item.equals

generateNewIds()

generateNewIds(): void;

Returns

void

Inherited from

Item.generateNewIds

getItemChangedEvent()

getItemChangedEvent(): EventWithAutoSenderArg<Item, Item>;

Returns

EventWithAutoSenderArg<Item, Item>

Inherited from

Item.getItemChangedEvent

getItemChangingEvent()

getItemChangingEvent(): EventObject<Item>;

Returns

EventObject<Item>

Inherited from

Item.getItemChangingEvent

getPathLoadedEvent()

getPathLoadedEvent(): EventObject<unknown>;

Returns

EventObject<unknown>

getSimplifiedObject()

getSimplifiedObject(omitProperties?): Object;

Parameters

Parameter	Type
omitProperties?	string | string[]

Returns

Object

Overrides

Item.getSimplifiedObject

removePropertyChanged()

removePropertyChanged(listener): void;

Parameters

Parameter	Type
listener	(sender, eventArgs) => void

Returns

void

Inherited from

Item.removePropertyChanged

setTransform()

setTransform(value, suppressOnChanged?): void;

Parameters

Parameter	Type	Default value
value	Transform	undefined
suppressOnChanged	boolean	false

Returns

void

Inherited from

Item.setTransform

toString()

toString(): string;

Returns a string representation of an object.

Returns

string

Inherited from

Item.toString

update()

update(item): void;

Parameters

Parameter	Type
item	BaseItem

Returns

void

Inherited from

Item.update