Class Item

Inheritance

ModelComponent

BaseItem

Item

Package: @aurigma/design-atoms-model

Constructors

(constructor)()

Constructs a new instance of the Item class

Declaration

constructor();

Properties

_ignorePermissionsChange

Declaration

protected _ignorePermissionsChange: boolean;

Property Value

Type	Description
boolean

_onPermissionsChanged

Declaration

protected _onPermissionsChanged: () => void;

Property Value

Type	Description
() => void

_violationSettings

Declaration

protected _violationSettings: ViolationSettings;

Property Value

Type	Description
ViolationSettings

blendMode

Declaration

get blendMode(): BlendMode;

set blendMode(value: BlendMode);

Property Value

Type	Description
BlendMode

class

Declaration

get class(): string;

set class(value: string);

Property Value

Type	Description
string

containerName

Declaration

containerName: string;

Property Value

Type	Description
string

fromLayout

Declaration

get fromLayout(): boolean;

set fromLayout(value: boolean);

Property Value

Type	Description
boolean

frontendPermissions

Declaration

get frontendPermissions(): FrontendPermissions;

set frontendPermissions(value: FrontendPermissions);

Property Value

Type	Description
FrontendPermissions

isRenderTypeIsNormal

Declaration

get isRenderTypeIsNormal(): boolean;

Property Value

Type	Description
boolean

isVariable

Declaration

get isVariable(): boolean;

set isVariable(value: boolean);

Property Value

Type	Description
boolean

itemPermissions

Declaration

get itemPermissions(): ItemPermissions;

set itemPermissions(value: ItemPermissions);

Property Value

Type	Description
ItemPermissions

locked

Declaration

get locked(): boolean;

set locked(value: boolean);

Property Value

Type	Description
boolean

manipulationPermissions

Declaration

get manipulationPermissions(): ManipulationPermissions;

set manipulationPermissions(value: ManipulationPermissions);

Property Value

Type	Description
ManipulationPermissions

mask

Declaration

get mask(): ItemMask;

set mask(value: ItemMask);

Property Value

Type	Description
ItemMask

opacity

Declaration

get opacity(): number;

set opacity(value: number);

Property Value

Type	Description
number

parentGroupItem

Declaration

get parentGroupItem(): GroupItem;

set parentGroupItem(value: GroupItem);

Property Value

Type	Description
GroupItem

renderingType

Declaration

get renderingType(): RenderingType.Normal | RenderingType;

Property Value

Type	Description
RenderingType.Normal | RenderingType

textWrappingMode

Declaration

get textWrappingMode(): WrappingMode;

set textWrappingMode(value: WrappingMode);

Property Value

Type	Description
WrappingMode

themeBinding

Declaration

themeBinding: ThemeBinding;

Property Value

Type	Description
ThemeBinding

transform

Declaration

get transform(): Transform;

set transform(value: Transform);

Property Value

Type	Description
Transform

type

Declaration

type: string;

Property Value

Type	Description
string

type

Declaration

static type: string;

Property Value

Type	Description
string

violationSettings

Declaration

get violationSettings(): ViolationSettings;

set violationSettings(value: ViolationSettings);

Property Value

Type	Description
ViolationSettings

visible

Declaration

get visible(): boolean;

set visible(value: boolean);

Property Value

Type	Description
boolean

visualizationPermissions

Declaration

get visualizationPermissions(): VisualizationPermissions;

set visualizationPermissions(value: VisualizationPermissions);

Property Value

Type	Description
VisualizationPermissions

Methods

_applyThemeColor(colorName, theme, updateFunc)

Declaration

protected _applyThemeColor(colorName: string, theme: IProductThemeConfig, updateFunc: (color: Color) => void): boolean;

Parameters

Type	Name	Description
string	colorName
IProductThemeConfig	theme
(color: Color) => void	updateFunc

Returns

Type	Description
boolean

_canSetIsVariable()

Declaration

protected _canSetIsVariable(): boolean;

Returns

Type	Description
boolean

_copy(source, destination, generateNewIds, appropriateParentContainer)

Declaration

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

Parameters

Type	Name	Description
Item	source
Item	destination
boolean	generateNewIds
boolean	appropriateParentContainer

Returns

Type	Description
void

_getParentContainer()

Declaration

protected _getParentContainer(): Container;

Returns

Type	Description
Container

_getThemeBinding(themeBinding)

Declaration

protected _getThemeBinding(themeBinding: ThemeBinding): ThemeBinding;

Parameters

Type	Name	Description
ThemeBinding	themeBinding

Returns

Type	Description
ThemeBinding

_onContainerChanged()

Declaration

protected _onContainerChanged(): void;

Returns

Type	Description
void

_setViolationSettings(value, skipTypeCheck)

Declaration

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

Parameters

Type	Name	Description
ViolationSettings	value
boolean	skipTypeCheck

Returns

Type	Description
void

applyPermissionsConstrain()

Declaration

applyPermissionsConstrain(): void;

Returns

Type	Description
void

canSetIsVariable()

Declaration

canSetIsVariable(): boolean;

Returns

Type	Description
boolean

equals(other)

Declaration

equals(other: Item): boolean;

Parameters

Type	Name	Description
Item	other

Returns

Type	Description
boolean

getItemChangedEvent()

Declaration

getItemChangedEvent(): EventWithAutoSenderArg<Item, Item>;

Returns

Type	Description
EventWithAutoSenderArg<Item, Item>

getItemChangingEvent()

Declaration

getItemChangingEvent(): EventObject<Item>;

Returns

Type	Description
EventObject<Item>

getManipulationPermissions()

Declaration

protected getManipulationPermissions(): ManipulationPermissions;

Returns

Type	Description
ManipulationPermissions

getSimplifiedObject(omitProperties)

Declaration

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

Parameters

Type	Name	Description
string[] | string	omitProperties

Returns

Type	Description
Object

setManipulationPermissions(value)

Declaration

protected setManipulationPermissions(value: any): void;

Parameters

Type	Name	Description
any	value

Returns

Type	Description
void

setTransform(value, suppressOnChanged)

Declaration

setTransform(value: Transform, suppressOnChanged?: boolean): void;

Parameters

Type	Name	Description
Transform	value
boolean	suppressOnChanged

Returns

Type	Description
void