Class ShapeItem

Inheritance

ShapeItem

Package: @aurigma/design-atoms-model

Constructors

(constructor)(sourcePath)

Constructs a new instance of the ShapeItem class

Declaration

constructor(sourcePath?: Path);

Parameters

Type	Name	Description
Path	sourcePath

Properties

altBorderColor

Declaration

get altBorderColor(): Color;

set altBorderColor(value: Color);

Property Value

Type	Description
Color

borderColor

Declaration

get borderColor(): Color;

set borderColor(value: Color);

Property Value

Type	Description
Color

borderWidth

Declaration

get borderWidth(): number;

set borderWidth(value: number);

Property Value

Type	Description
number

dash

Declaration

get dash(): number[];

set dash(value: number[]);

Property Value

Type	Description
number[]

fillColor

Declaration

get fillColor(): Color;

set fillColor(value: Color);

Property Value

Type	Description
Color

fixedBorderWidth

Declaration

get fixedBorderWidth(): boolean;

set fixedBorderWidth(value: boolean);

Property Value

Type	Description
boolean

overprintFill

Declaration

get overprintFill(): boolean;

set overprintFill(value: boolean);

Property Value

Type	Description
boolean

overprintStroke

Declaration

get overprintStroke(): boolean;

set overprintStroke(value: boolean);

Property Value

Type	Description
boolean

shapePermissions

Declaration

get shapePermissions(): ShapePermissions;

set shapePermissions(value: ShapePermissions);

Property Value

Type	Description
ShapePermissions

sourcePath

Declaration

get sourcePath(): Path;

set sourcePath(value: Path);

Property Value

Type	Description
Path

sourcePathId

Declaration

sourcePathId: string;

Property Value

Type	Description
string

sourcePathLoaded

Declaration

sourcePathLoaded: boolean;

Property Value

Type	Description
boolean

sourceRectangle

Declaration

get sourceRectangle(): RectangleF;

set sourceRectangle(value: RectangleF);

Property Value

Type	Description
RectangleF

type

Declaration

type: string;

Property Value

Type	Description
string

type

Declaration

static type: string;

Property Value

Type	Description
string

violationSettings

Declaration

get violationSettings(): ShapeViolationSettings;

set violationSettings(value: ShapeViolationSettings);

Property Value

Type	Description
ShapeViolationSettings

Methods

_copy(source, destination, generateNewIds, appropriateParentContainer)

Declaration

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

Parameters

Type	Name	Description
ShapeItem	source
ShapeItem	destination
boolean	generateNewIds
boolean	appropriateParentContainer

Returns

Type	Description
void

_setViolationSettings(value, skipTypeCheck)

Declaration

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

Parameters

Type	Name	Description
ShapeViolationSettings	value
boolean	skipTypeCheck

Returns

Type	Description
void

applyPermissionsConstrain()

Declaration

applyPermissionsConstrain(): void;

Returns

Type	Description
void

clone(generateNewIds, appropriateParentContainer)

Declaration

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

Parameters

Type	Name	Description
boolean	generateNewIds
boolean	appropriateParentContainer

Returns

Type	Description
ShapeItem

equals(other)

Declaration

equals(other: ShapeItem): boolean;

Parameters

Type	Name	Description
ShapeItem	other

Returns

Type	Description
boolean

getPathLoadedEvent()

Declaration

getPathLoadedEvent(): EventObject<unknown>;

Returns

Type	Description
EventObject<unknown>

getSimplifiedObject(omitProperties)

Declaration

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

Parameters

Type	Name	Description
string[] \| string	omitProperties

Returns

Type	Description
Object