Class ProductHandler

Package: @aurigma/design-atoms

Constructors

(constructor)(_viewer, _eventManager)

Constructs a new instance of the ProductHandler class

Declaration

constructor(_viewer: Viewer, _eventManager: EventManager);

Parameters

Type	Name	Description
Viewer	_viewer
EventManager	_eventManager

Properties

contentAngle

Declaration

get contentAngle(): number;

Property Value

Type	Description
number

currentSurface

Declaration

get currentSurface(): Surface;

set currentSurface(surface: Surface);

Property Value

Type	Description
Surface

getHandler

Declaration

getHandler: <T extends ItemHandler>(item: Item) => T;

Property Value

Type	Description
<T extends ItemHandler>(item: Item) => T

interactiveContainers

Gets or sets interactive containers of the Product.

Declaration

get interactiveContainers(): Container[];

set interactiveContainers(value: Container[]);

Property Value

Type	Description
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.

product

Declaration

get product(): Product;

Property Value

Type	Description
Product

regionForCurrentContainer

Declaration

get regionForCurrentContainer(): import("@aurigma/design-atoms-model").RectangleF;

Property Value

Type	Description
import("@aurigma/design-atoms-model").RectangleF

selectedItems

Declaration

get selectedItems(): Item[];

Property Value

Type	Description
Item[]

suppressOutOfRegionManipulation

Declaration

get suppressOutOfRegionManipulation(): boolean;

Property Value

Type	Description
boolean

userEditContainer

Declaration

get userEditContainer(): SurfaceContainer;

Property Value

Type	Description
SurfaceContainer

userEditPrintArea

Declaration

get userEditPrintArea(): PrintArea;

Property Value

Type	Description
PrintArea

Methods

applyLayout(product, surfaceFilterFunc)

Declaration

applyLayout(product: Product, surfaceFilterFunc?: (index: number, surface: Surface) => boolean): Promise<void>;

Parameters

Type	Name	Description
Product	product
(index: number, surface: Surface) => boolean	surfaceFilterFunc

Returns

Type	Description
Promise<void>

beginMultiCall()

Declaration

beginMultiCall(): void;

Returns

Type	Description
void

checkSelectionByHitTest(x, y)

Declaration

checkSelectionByHitTest(x: number, y: number): boolean;

Parameters

Type	Name	Description
number	x
number	y

Returns

Type	Description
boolean

endMultiCall()

Declaration

endMultiCall(): void;

Returns

Type	Description
void

exitEditMode()

Declaration

exitEditMode(): void;

Returns

Type	Description
void

getPrintAreaBounds(container, printArea)

Declaration

getPrintAreaBounds(container?: SurfaceContainer, printArea?: PrintArea): import("@aurigma/design-atoms-model").RectangleF;

Parameters

Type	Name	Description
SurfaceContainer	container
PrintArea	printArea

Returns

Type	Description
import("@aurigma/design-atoms-model").RectangleF

getPrintAreaVisualSize(targetContainer, printArea)

Declaration

getPrintAreaVisualSize(targetContainer?: SurfaceContainer, printArea?: PrintArea): ISize;

Parameters

Type	Name	Description
SurfaceContainer	targetContainer
PrintArea	printArea

Returns

Type	Description
ISize

getProductColors(initialProduct)

Declaration

getProductColors(initialProduct: Product): Color[];

Parameters

Type	Name	Description
Product	initialProduct

Returns

Type	Description
Color[]

getVisualSize(size)

Declaration

getVisualSize(size: ISize): ISize;

Parameters

Type	Name	Description
ISize	size

Returns

Type	Description
ISize

isInteractive(object)

Declaration

isInteractive(object: Container | Item): boolean;

Parameters

Type	Name	Description
Container | Item	object

Returns

Type	Description
boolean

isItemSelected(item)

Declaration

isItemSelected(item: Item): boolean;

Parameters

Type	Name	Description
Item	item

Returns

Type	Description
boolean

isMasked(container)

Declaration

isMasked(container: Container): boolean;

Parameters

Type	Name	Description
Container	container

Returns

Type	Description
boolean

queryItems(selectors, queryOptions)

Declaration

queryItems(selectors: string, queryOptions?: IQueryOptions): Item[];

Parameters

Type	Name	Description
string	selectors
IQueryOptions	queryOptions

Returns

Type	Description
Item[]

redraw()

Declaration

redraw(): void;

Returns

Type	Description
void

updateMaskedContainers()

Declaration

updateMaskedContainers(): void;

Returns

Type	Description
void

updateSelection()

Declaration

updateSelection(): void;

Returns

Type	Description
void

waitUpdate()

Declaration

waitUpdate(): Promise<void[]>;

Returns

Type	Description
Promise<void[]>