ItemUtils

Enumerations

UpdatePhase

Enumeration Members

Enumeration Member	Value
Final	1
InProgress	0

Classes

ItemUtils

Constructors

Constructor

new ItemUtils(): ItemUtils;

Returns

ItemUtils

Accessors

designAtomsApiClient

Set Signature

set static designAtomsApiClient(designAtomsApiClient): void;

Parameters

Parameter	Type
designAtomsApiClient	IDesignAtomsApiClient

Returns

void

Methods

alignHandlerToRect()

static alignHandlerToRect(
   itemHandler, 
   rectangle, 
   item): void;

Parameters

Parameter	Type
itemHandler	BaseRectangleItemHandler
rectangle	RotatedRectangleF
item	Item

Returns

void

allowManipulate()

static allowManipulate(item): any;

Parameters

Parameter	Type
item	Item

Returns

any

allowMoveHorizontal()

static allowMoveHorizontal(item): any;

Parameters

Parameter	Type
item	Item

Returns

any

allowMoveVertical()

static allowMoveVertical(item): any;

Parameters

Parameter	Type
item	Item

Returns

any

applyGroupItemsChanges()

static applyGroupItemsChanges(
   groupItems, 
   targetItems, 
   addToTarget, 
   options): void;

Parameters

Parameter	Type
groupItems	IChangedGroupItem[]
targetItems	Item[]
addToTarget	(item) => void
options	IApplyGroupChangesOptions

Returns

void

applyOverlayEffect()

static applyOverlayEffect(item, overlayEffect): void;

Parameters

Parameter	Type
item	any
overlayEffect	OverlayEffect

Returns

void

changeItemsContent()

static changeItemsContent(
   product, 
   productHandler, 
   commandManager, 
   oldItems, 
   newItems, 
   replaceAll): void;

Parameters

Parameter	Type
product	Product
productHandler	ProductHandler
commandManager	ICommandManager
oldItems	Item[]
newItems	Item[]
replaceAll	boolean

Returns

void

clearImageContent()

static clearImageContent(placeHolder): void;

Parameters

Parameter	Type
placeHolder	PlaceholderItem

Returns

void

createCloneName()

static createCloneName(
   item, 
   variableItemHelper, 
   productHandler): string;

Parameters

Parameter	Type
item	any
variableItemHelper	VariableItemHelper
productHandler	ProductHandler

Returns

string

createImageContentForPlaceholder()

static createImageContentForPlaceholder(
   placeholder, 
   metadata, 
   productHandler, 
   hiResOutputDpi?): any;

Parameters

Parameter	Type
placeholder	PlaceholderItem
metadata	any
productHandler	ProductHandler
hiResOutputDpi?	number

Returns

any

getAllowChangeContent()

static getAllowChangeContent(item): boolean;

Parameters

Parameter	Type
item	any

Returns

boolean

getAllowTextFormatting()

static getAllowTextFormatting(textItem?, defaultValue?): any;

Parameters

Parameter	Type
textItem?	BaseTextItem
defaultValue?	boolean

Returns

any

getBarcodeItem()

static getBarcodeItem(item): BarcodeItem;

Parameters

Parameter	Type
item	any

Returns

BarcodeItem

getBarcodePermissions()

static getBarcodePermissions(item): BarcodePermissions;

Parameters

Parameter	Type
item	any

Returns

BarcodePermissions

getColorPalette()

static getColorPalette(item, colorPreviewService): Promise<IColorData[]>;

Parameters

Parameter	Type
item	BaseTextItem
colorPreviewService	IColorPreviewService

Returns

Promise<IColorData[]>

getContentEffect()

static getContentEffect(item): ImageEffect;

Parameters

Parameter	Type
item	PlaceholderItem

Returns

ImageEffect

getEmptyPlaceholdersFromProduct()

static getEmptyPlaceholdersFromProduct(product, skipLinked?): PlaceholderItem[];

Parameters

Parameter	Type	Default value
product	Product	undefined
skipLinked	boolean	false

Returns

PlaceholderItem[]

getImageItem()

static getImageItem(item): ImageItem;

Parameters

Parameter	Type
item	any

Returns

ImageItem

getImageMetaDataFromDesignImage()

static getImageMetaDataFromDesignImage(appDomainUrl?, designImageName): Promise<any>;

Parameters

Parameter	Type	Default value
appDomainUrl	string	undefined
designImageName	string	undefined

Returns

Promise<any>

getImageMetaDataFromFile()

static getImageMetaDataFromFile(
   appDomainUrl?, 
   filePath, 
userId?): Promise<any>;

Parameters

Parameter	Type	Default value
appDomainUrl	string	undefined
filePath	string	undefined
userId	string	null

Returns

Promise<any>

getImageMetadataFromRemoteFile()

static getImageMetadataFromRemoteFile(appDomainUrl?, url): Promise<any>;

Parameters

Parameter	Type	Default value
appDomainUrl	string	undefined
url	string	undefined

Returns

Promise<any>

getImagePermissions()

static getImagePermissions(item): ImagePermissions;

Parameters

Parameter	Type
item	any

Returns

ImagePermissions

getImageSizeInPoints()

static getImageSizeInPoints(source): object;

Parameters

Parameter	Type
source	ImageSource

Returns

object

height

height: any;

width

width: any;

getImageUrlFromImageMetadata()

static getImageUrlFromImageMetadata(
   imageMetadata, 
   canvas, 
   width?, 
   height?, 
   keepProportions?): string;

Parameters

Parameter	Type
imageMetadata	ImageMetaData
canvas	Canvas
width?	number
height?	number
keepProportions?	boolean

Returns

string

getItemBoundsForViolationCheck()

static getItemBoundsForViolationCheck(handler): RectangleF;

Parameters

Parameter	Type
handler	ItemHandler

Returns

RectangleF

getMaxFontSize()

static getMaxFontSize(textItem): any;

Parameters

Parameter	Type
textItem	BaseTextItem

Returns

any

getTextFromRichTextItem()

static getTextFromRichTextItem(item): any;

Parameters

Parameter	Type
item	BaseTextItem

Returns

any

isBgContainerItem()

static isBgContainerItem(item): boolean;

Parameters

Parameter	Type
item	Item

Returns

boolean

isDataMatrixBarcode()

static isDataMatrixBarcode(item): boolean;

Parameters

Parameter	Type
item	Item

Returns

boolean

isEmptyPlaceholder()

static isEmptyPlaceholder(item): boolean;

Parameters

Parameter	Type
item	Item

Returns

boolean

isFgContainerItem()

static isFgContainerItem(item): boolean;

Parameters

Parameter	Type
item	Item

Returns

boolean

isImage()

static isImage(item): item is any;

Parameters

Parameter	Type
item	Item

Returns

item is any

isLinearBarcode()

static isLinearBarcode(item): boolean;

Parameters

Parameter	Type
item	Item

Returns

boolean

isMultiValueItem()

static isMultiValueItem(item): boolean;

Parameters

Parameter	Type
item	Item

Returns

boolean

isQrCode()

static isQrCode(item): boolean;

Parameters

Parameter	Type
item	Item

Returns

boolean

isRotated()

static isRotated(item, contentAngle): boolean;

Parameters

Parameter	Type
item	Item
contentAngle	number

Returns

boolean

isTextItemHandlerReady()

static isTextItemHandlerReady(item, productHandler): boolean;

Parameters

Parameter	Type
item	Item
productHandler	ProductHandler

Returns

boolean

isTextType()

static isTextType(type): any;

Parameters

Parameter	Type
type	any

Returns

any

isVariableItem()

static isVariableItem(item): boolean;

Parameters

Parameter	Type
item	Item

Returns

boolean

positionItemInArea()

static positionItemInArea(
   productHandler, 
   item, 
   boundsWidth, 
   boundsHeight, 
   ignoreRotate?, 
   targetRegion?, 
   oldCenterPoint?, 
   relativeToPrintArea?): any;

Parameters

Parameter	Type	Default value
productHandler	ProductHandler	undefined
item	Item	undefined
boundsWidth	number	undefined
boundsHeight	number	undefined
ignoreRotate	boolean	true
targetRegion	RotatedRectangleF	null
oldCenterPoint	PointF	null
relativeToPrintArea	boolean	true

Returns

any

promoteImageMetaData()

static promoteImageMetaData(appDomainUrl?, metaDataList): Promise<void>;

Parameters

Parameter	Type	Default value
appDomainUrl	string	undefined
metaDataList	ImageMetaData[]	undefined

Returns

Promise<void>

removeDeletedItems()

static removeDeletedItems(
   targetItems, 
   removedItems, 
   groupItems): void;

Parameters

Parameter	Type
targetItems	Item[]
removedItems	Item[]
groupItems	IChangedGroupItem[]

Returns

void

rotateItems()

static rotateItems(
   productHandler, 
   items, 
   rotateCenter, 
   angle): void;

Parameters

Parameter	Type
productHandler	ProductHandler
items	Item[]
rotateCenter	PointF
angle	number

Returns

void

setOverlayEffectColor()

static setOverlayEffectColor(item, color): void;

Parameters

Parameter	Type
item	any
color	Color

Returns

void

updateItems()

static updateItems(
   items, 
   productHandler, 
   canvas, 
   options?): void;

Parameters

Parameter	Type
items	Item[]
productHandler	ProductHandler
canvas	Canvas
options?	UpdateItemsOptions

Returns

void

waitForItemsUpdated()

static waitForItemsUpdated(items, canvas): Promise<void>;

Parameters

Parameter	Type
items	Item[]
canvas	ICanvas

Returns

Promise<void>

Interfaces

IApplyGroupChangesOptions

Properties

commandManager

commandManager: ICommandManager;

product

product: Product;

productHandler

productHandler: ProductHandler;

replaceAll

replaceAll: boolean;

transformItem

transformItem: (item) => void;

Parameters

Parameter	Type
item	Item

Returns

void

Type Aliases

UpdateItemsOptions

type UpdateItemsOptions = object;

Properties

addToHistory?

optional addToHistory?: boolean;

redraw?

optional redraw?: boolean;

updatePhase?

optional updatePhase?: UpdatePhase;