Class VariableItemHelper

Package: @aurigma/design-atoms

Constructors

(constructor)(_productHandler, _canvas, _eventManager)

Constructs a new instance of the VariableItemHelper class

Declaration

constructor(_productHandler: ProductHandler, _canvas: Canvas, _eventManager: EventManager);

Parameters

Type	Name	Description
ProductHandler	_productHandler
Canvas	_canvas
EventManager	_eventManager

Properties

maskSymbol

Declaration

maskSymbol: string;

Property Value

Type	Description
string

Methods

createNewItemName(item, newRealName)

Declaration

createNewItemName(item: Item, newRealName: string): string;

Parameters

Type	Name	Description
Item	item
string	newRealName

Returns

Type	Description
string

getInterpolationVariables(textItem)

Declaration

static getInterpolationVariables(textItem: BaseTextItem): IInterpolationPlaceholderVariable[];

Parameters

Type	Name	Description
BaseTextItem	textItem

Returns

Type	Description
IInterpolationPlaceholderVariable[]

getRealItemName(item)

Declaration

getRealItemName(item: Item): string;

Parameters

Type	Name	Description
Item	item

Returns

Type	Description
string

getVariableItemDisplayName(name)

Declaration

getVariableItemDisplayName(name: string): string;

Parameters

Type	Name	Description
string	name

Returns

Type	Description
string

getVariablesFromBarcodeItem(item, ignoreIsVariableMarker)

Declaration

static getVariablesFromBarcodeItem(item: BarcodeItem, ignoreIsVariableMarker?: boolean): IBarcodeVariable[];

Parameters

Type	Name	Description
BarcodeItem	item
boolean	ignoreIsVariableMarker

Returns

Type	Description
IBarcodeVariable[]

getVariablesFromEllipseItem(item)

Declaration

static getVariablesFromEllipseItem(item: EllipseItem): IVariable[];

Parameters

Type	Name	Description
EllipseItem	item

Returns

Type	Description
IVariable[]

getVariablesFromGroupItem(item)

Declaration

static getVariablesFromGroupItem(item: GroupItem): IVariable[];

Parameters

Type	Name	Description
GroupItem	item

Returns

Type	Description
IVariable[]

getVariablesFromImageItem(item)

Declaration

static getVariablesFromImageItem(item: ImageItem): IVariable[];

Parameters

Type	Name	Description
ImageItem	item

Returns

Type	Description
IVariable[]

getVariablesFromItems(items)

Declaration

static getVariablesFromItems(items: BaseItem[]): IVariable[];

Parameters

Type	Name	Description
BaseItem[]	items

Returns

Type	Description
IVariable[]

getVariablesFromLayoutItem(item)

Declaration

static getVariablesFromLayoutItem(item: LayoutItem): IVariable[];

Parameters

Type	Name	Description
LayoutItem	item

Returns

Type	Description
IVariable[]

getVariablesFromPlaceholderItem(item)

Declaration

static getVariablesFromPlaceholderItem(item: PlaceholderItem): IVariable[];

Parameters

Type	Name	Description
PlaceholderItem	item

Returns

Type	Description
IVariable[]

getVariablesFromRectangleItem(item)

Declaration

static getVariablesFromRectangleItem(item: RectangleItem): IVariable[];

Parameters

Type	Name	Description
RectangleItem	item

Returns

Type	Description
IVariable[]

getVariablesFromShapeItem(item)

Declaration

static getVariablesFromShapeItem(item: ShapeItem): IVariable[];

Parameters

Type	Name	Description
ShapeItem	item

Returns

Type	Description
IVariable[]

getVariablesFromTextItem(item)

Declaration

static getVariablesFromTextItem(item: BaseTextItem): IVariable[];

Parameters

Type	Name	Description
BaseTextItem	item

Returns

Type	Description
IVariable[]

initVariableItem(item)

Declaration

initVariableItem(item: BaseItem): void;

Parameters

Type	Name	Description
BaseItem	item

Returns

Type	Description
void

initVariableItems(product)

Declaration

initVariableItems(product: Product): void;

Parameters

Type	Name	Description
Product	product

Returns

Type	Description
void

isInStringPlacehodler(item)

Declaration

static isInStringPlacehodler(item: Item): boolean;

Parameters

Type	Name	Description
Item	item

Returns

Type	Description
boolean

setVariableValue(item, value, supressUpdate)

Declaration

setVariableValue(item: Item, value: boolean, supressUpdate?: boolean): void;

Parameters

Type	Name	Description
Item	item
boolean	value
boolean	supressUpdate

Returns

Type	Description
void

setVariableValues(items, value)

Declaration

setVariableValues(items: Array<Item>, value: boolean): void;

Parameters

Type	Name	Description
Array<Item>	items
boolean	value

Returns

Type	Description
void