ProductHandler
Classes
ProductHandler
Constructors
Constructor
new ProductHandler(viewer, eventManager): ProductHandler;
Parameters
| Parameter | Type |
|---|---|
viewer | Viewer |
eventManager | EventManager |
Returns
Accessors
contentAngle
Get Signature
get contentAngle(): number;
Returns
number
currentSurface
Get Signature
get currentSurface(): Surface;
Returns
Surface
Set Signature
set currentSurface(surface): void;
Parameters
| Parameter | Type |
|---|---|
surface | Surface |
Returns
void
interactiveContainers
Get Signature
get interactiveContainers(): Container[];
Gets or sets interactive containers of the Product.
Remarks
Interactive containers allows to define product containers which items can be selected by user. If this property is null or empty then items from any containers can be selected by user.
Returns
Container[]
Set Signature
set interactiveContainers(value): void;
Parameters
| Parameter | Type |
|---|---|
value | Container[] |
Returns
void
product
Get Signature
get product(): any;
Returns
any
regionForCurrentContainer
Get Signature
get regionForCurrentContainer(): any;
Returns
any
selectedItems
Get Signature
get selectedItems(): Item[];
Returns
Item[]
suppressOutOfRegionManipulation
Get Signature
get suppressOutOfRegionManipulation(): boolean;
Returns
boolean
userEditContainer
Get Signature
get userEditContainer(): Container;
Returns
Container
userEditPrintArea
Get Signature
get userEditPrintArea(): any;
Returns
any
Methods
applyLayout()
applyLayout(product, surfaceFilterFunc?): Promise<void>;
Parameters
| Parameter | Type |
|---|---|
product | Product |
surfaceFilterFunc? | (index, surface) => boolean |
Returns
Promise<void>
beginMultiCall()
beginMultiCall(): void;
Returns
void
checkSelectionByHitTest()
checkSelectionByHitTest(x, y): boolean;
Parameters
| Parameter | Type |
|---|---|
x | number |
y | number |
Returns
boolean
endMultiCall()
endMultiCall(): void;
Returns
void
exitEditMode()
exitEditMode(): void;
Returns
void
getHandler()
getHandler<T>(item): T;
Type Parameters
| Type Parameter |
|---|
T extends ItemHandler |
Parameters
| Parameter | Type |
|---|---|
item | Item |
Returns
T
getPrintAreaBounds()
getPrintAreaBounds(container?, printArea?): any;
Parameters
| Parameter | Type |
|---|---|
container? | Container |
printArea? | PrintArea |
Returns
any
getPrintAreaVisualSize()
getPrintAreaVisualSize(targetContainer?, printArea?): ISize;
Parameters
| Parameter | Type |
|---|---|
targetContainer? | Container |
printArea? | PrintArea |
Returns
getProductColors()
getProductColors(initialProduct): Color[];
Parameters
| Parameter | Type |
|---|---|
initialProduct | Product |
Returns
Color[]
getVisualSize()
getVisualSize(size): any;
Parameters
| Parameter | Type |
|---|---|
size | ISize |
Returns
any
isInteractive()
isInteractive(object): boolean;
Parameters
| Parameter | Type |
|---|---|
object | any |
Returns
boolean
isItemSelected()
isItemSelected(item): any;
Parameters
| Parameter | Type |
|---|---|
item | Item |
Returns
any
isMasked()
isMasked(container): boolean;
Parameters
| Parameter | Type |
|---|---|
container | Container |
Returns
boolean
queryItems()
queryItems(selectors, queryOptions?): Item[];
Parameters
| Parameter | Type |
|---|---|
selectors | string |
queryOptions? | IQueryOptions |
Returns
Item[]
redraw()
redraw(): void;
Returns
void
updateMaskedContainers()
updateMaskedContainers(): void;
Returns
void
updateSelection()
updateSelection(): void;
Returns
void
waitUpdate()
waitUpdate(): Promise<void[]>;
Returns
Promise<void[]>