VariableItemHelper

Classes

VariableItemHelper

Constructors

Constructor

new VariableItemHelper(
   productHandler, 
   canvas, 
   eventManager): VariableItemHelper;

Parameters

Parameter	Type
productHandler	ProductHandler
canvas	Canvas
eventManager	EventManager

Returns

VariableItemHelper

Properties

maskSymbol

maskSymbol: string = "%";

Methods

createNewItemName()

createNewItemName(item, newRealName): string;

Parameters

Parameter	Type
item	Item
newRealName	string

Returns

string

getRealItemName()

getRealItemName(item): string;

Parameters

Parameter	Type
item	Item

Returns

string

getVariableItemDisplayName()

getVariableItemDisplayName(name): string;

Parameters

Parameter	Type
name	string

Returns

string

initVariableItem()

initVariableItem(item): void;

Parameters

Parameter	Type
item	BaseItem

Returns

void

initVariableItems()

initVariableItems(product): void;

Parameters

Parameter	Type
product	Product

Returns

void

setVariableName()

setVariableName(
   item, 
   name, 
   supressUpdate?): void;

Parameters

Parameter	Type
item	Item
name	string
supressUpdate?	boolean

Returns

void

setVariableValue()

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

Parameters

Parameter	Type
item	Item
value	boolean
supressUpdate?	boolean

Returns

void

setVariableValues()

setVariableValues(items, value): void;

Parameters

Parameter	Type
items	Item[]
value	boolean

Returns

void

getInterpolationVariables()

static getInterpolationVariables(textItem): IInterpolationPlaceholderVariable[];

Parameters

Parameter	Type
textItem	BaseTextItem

Returns

IInterpolationPlaceholderVariable[]

getVariablesFromBarcodeItem()

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

Parameters

Parameter	Type	Default value
item	BarcodeItem	undefined
ignoreIsVariableMarker	boolean	false

Returns

IBarcodeVariable[]

getVariablesFromEllipseItem()

static getVariablesFromEllipseItem(item): IVariable[];

Parameters

Parameter	Type
item	EllipseItem

Returns

IVariable[]

getVariablesFromGroupItem()

static getVariablesFromGroupItem(item): IVariable[];

Parameters

Parameter	Type
item	GroupItem

Returns

IVariable[]

getVariablesFromImageItem()

static getVariablesFromImageItem(item): IVariable[];

Parameters

Parameter	Type
item	ImageItem

Returns

IVariable[]

getVariablesFromItems()

static getVariablesFromItems(items): IVariable[];

Parameters

Parameter	Type
items	BaseItem[]

Returns

IVariable[]

getVariablesFromLayoutItem()

static getVariablesFromLayoutItem(item): IVariable[];

Parameters

Parameter	Type
item	LayoutItem

Returns

IVariable[]

getVariablesFromPlaceholderItem()

static getVariablesFromPlaceholderItem(item): IVariable[];

Parameters

Parameter	Type
item	PlaceholderItem

Returns

IVariable[]

getVariablesFromRectangleItem()

static getVariablesFromRectangleItem(item): IVariable[];

Parameters

Parameter	Type
item	RectangleItem

Returns

IVariable[]

getVariablesFromShapeItem()

static getVariablesFromShapeItem(item): IVariable[];

Parameters

Parameter	Type
item	ShapeItem

Returns

IVariable[]

getVariablesFromTextItem()

static getVariablesFromTextItem(item): IVariable[];

Parameters

Parameter	Type
item	BaseTextItem

Returns

IVariable[]

isInStringPlacehodler()

static isInStringPlacehodler(item): boolean;

Parameters

Parameter	Type
item	Item

Returns

boolean

Interfaces

IBarcodeVariable

Extends

• IVariable

Properties

barcodeFormat

barcodeFormat: BarcodeFormat;

barcodeSubType

barcodeSubType: BarcodeSubType;

name

name: string;

Inherited from

IVariable.name

type

type: "Barcode" | "BarcodePlaceholder";

Overrides

IVariable.type

value

value: string;

Inherited from

IVariable.value

---

IInterpolationPlaceholderVariable

Extends

• IVariable

Properties

mask

mask: string;

name

name: string;

Inherited from

IVariable.name

type

type: 
  | "Barcode"
  | "BarcodePlaceholder"
  | "Image"
  | "ImagePlaceholder"
  | "Text"
  | "InString";

Inherited from

IVariable.type

value

value: string;

Inherited from

IVariable.value

values

values: string[];

---

IVariable

Extended by

• IBarcodeVariable
• IInterpolationPlaceholderVariable

Properties

name

name: string;

type

type: 
  | "Barcode"
  | "BarcodePlaceholder"
  | "Image"
  | "ImagePlaceholder"
  | "Text"
  | "InString";

value

value: string;