Class Canvas

Represents the main host object containing a stack of layers.

This client-side class corresponds to the server-side class Canvas and provides access to its primary members in TypeScript.

Package: @aurigma/design-atoms

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Canvas class.

Properties

activeTextCanvasHandler

Declaration

get activeTextCanvasHandler(): IActiveTextCanvasHandler;

Property Value

Type	Description
IActiveTextCanvasHandler

autoPlaceholderEditModeEnabled

Declaration

set autoPlaceholderEditModeEnabled(value: boolean);

Property Value

Type	Description
boolean

background

Declaration

set background(value: string);

Property Value

Type	Description
string

backgroundImage

Declaration

set backgroundImage(value: any);

Property Value

Type	Description
any

badViolationIconCssClass

Declaration

get badViolationIconCssClass(): string;

set badViolationIconCssClass(value: string);

Property Value

Type	Description
string

bigButtonGroupCssClass

Declaration

get bigButtonGroupCssClass(): string;

set bigButtonGroupCssClass(value: string);

Property Value

Type	Description
string

bottomMargin

Declaration

get bottomMargin(): number;

set bottomMargin(v: number);

Property Value

Type	Description
number

canvasElementSize

Declaration

get canvasElementSize(): {
        width?: number;
        height?: number;
    };

Property Value

Type	Description
{ width?: number; height?: number; }

canvasItemHoverEnabled

Declaration

get canvasItemHoverEnabled(): boolean;

set canvasItemHoverEnabled(value: boolean);

Property Value

Type	Description
boolean

constrainedMarginEnabled

Declaration

set constrainedMarginEnabled(v: boolean);

Property Value

Type	Description
boolean

contentAngle

Declaration

get contentAngle(): number;

Property Value

Type	Description
number

contentEditingPlaceholderItemHandler

Declaration

get contentEditingPlaceholderItemHandler(): PlaceholderItemHandler;

Property Value

Type	Description
PlaceholderItemHandler

contentUpdatingPlaceholderItemHandler

Declaration

get contentUpdatingPlaceholderItemHandler(): PlaceholderItemHandler;

Property Value

Type	Description
PlaceholderItemHandler

currentItemHandler

Declaration

get currentItemHandler(): BaseRectangleItemHandler;

Property Value

Type	Description
BaseRectangleItemHandler

designAtomsApiClient

Declaration

get designAtomsApiClient(): IDesignAtomsApiClient;

Property Value

Type	Description
IDesignAtomsApiClient

disableSmoothing

Declaration

get disableSmoothing(): boolean;

set disableSmoothing(value: boolean);

Property Value

Type	Description
boolean

dndHandler

Declaration

get dndHandler(): DragNDropHandler;

Property Value

Type	Description
DragNDropHandler

doneButtonCssClass

Declaration

get doneButtonCssClass(): string;

set doneButtonCssClass(value: string);

Property Value

Type	Description
string

errorInput

Declaration

get errorInput(): boolean;

Property Value

Type	Description
boolean

floatingToolbarManager

Declaration

get floatingToolbarManager(): FloatingToolbarManager;

Property Value

Type	Description
FloatingToolbarManager

fontRegistry

Declaration

get fontRegistry(): FontRegistry;

Property Value

Type	Description
FontRegistry

frontEndTextRenderingEnabled

Declaration

get frontEndTextRenderingEnabled(): boolean;

Property Value

Type	Description
boolean

goodViolationIconCssClass

Declaration

get goodViolationIconCssClass(): string;

set goodViolationIconCssClass(value: string);

Property Value

Type	Description
string

handleButtonCssClass

Declaration

get handleButtonCssClass(): string;

set handleButtonCssClass(value: string);

Property Value

Type	Description
string

handlerFactory

Declaration

readonly handlerFactory: HandlerFactoryByItem;

Property Value

Type	Description
HandlerFactoryByItem

height

Declaration

get height(): number;

Property Value

Type	Description
number

hiddenFieldID

Declaration

get hiddenFieldID(): string;

set hiddenFieldID(value: string);

Property Value

Type	Description
string

history

Declaration

get history(): History;

set history(value: History);

Property Value

Type	Description
History_2

hitTestManager

Declaration

get hitTestManager(): HitTestManager;

Property Value

Type	Description
HitTestManager

hoverColor

Declaration

get hoverColor(): string;

set hoverColor(value: string);

Property Value

Type	Description
string

hoverHandler

Declaration

get hoverHandler(): HoverHandler;

Property Value

Type	Description
HoverHandler

ignorePermissionsMode

Declaration

get ignorePermissionsMode(): boolean;

set ignorePermissionsMode(value: boolean);

Property Value

Type	Description
boolean

initialization

Declaration

get initialization(): boolean;

Property Value

Type	Description
boolean

inPlaceEditingHandler

Declaration

get inPlaceEditingHandler(): NewBaseTextItemHandler;

Property Value

Type	Description
NewBaseTextItemHandler

isInitialized

Declaration

get isInitialized(): boolean;

Property Value

Type	Description
boolean

isSelectionDragging

Declaration

get isSelectionDragging(): boolean;

Property Value

Type	Description
boolean

isSelectionIdle

Declaration

get isSelectionIdle(): boolean;

Property Value

Type	Description
boolean

isSelectionLocked

Declaration

get isSelectionLocked(): boolean;

Property Value

Type	Description
boolean

isSelectionResizing

Declaration

get isSelectionResizing(): boolean;

Property Value

Type	Description
boolean

isSelectionRotating

Declaration

get isSelectionRotating(): boolean;

Property Value

Type	Description
boolean

isUpdating

Declaration

get isUpdating(): boolean;

Property Value

Type	Description
boolean

keyEventEnabled

Declaration

get keyEventEnabled(): boolean;

set keyEventEnabled(v: boolean);

Property Value

Type	Description
boolean

lastLimitsEvent

Declaration

get lastLimitsEvent(): ILimitsViolationEventData;

Property Value

Type	Description
ILimitsViolationEventData

layers

Declaration

get layers(): LayerCollection;

set layers(v: LayerCollection);

Property Value

Type	Description
LayerCollection

leftMargin

Declaration

get leftMargin(): number;

set leftMargin(v: number);

Property Value

Type	Description
number

margin

Declaration

get margin(): number;

set margin(v: number);

Property Value

Type	Description
number

marginColor

Declaration

get marginColor(): string;

set marginColor(v: string);

Property Value

Type	Description
string

marginWidth

Declaration

get marginWidth(): number;

set marginWidth(v: number);

Property Value

Type	Description
number

maxFontSize

Declaration

get maxFontSize(): number;

set maxFontSize(v: number);

Property Value

Type	Description
number

maxLeading

Declaration

get maxLeading(): number;

set maxLeading(v: number);

Property Value

Type	Description
number

minFontSize

Declaration

get minFontSize(): number;

set minFontSize(v: number);

Property Value

Type	Description
number

minLeading

Declaration

get minLeading(): number;

set minLeading(v: number);

Property Value

Type	Description
number

mouseMoveTimeout

Declaration

get mouseMoveTimeout(): number;

set mouseMoveTimeout(value: number);

Property Value

Type	Description
number

mul

Declaration

get mul(): number;

Property Value

Type	Description
number

multipleSelectionEnabled

Declaration

get multipleSelectionEnabled(): boolean;

set multipleSelectionEnabled(value: boolean);

Property Value

Type	Description
boolean

offset

Declaration

get offset(): PointF;

set offset(value: PointF);

Property Value

Type	Description
PointF

parentElement

Declaration

get parentElement(): HTMLElement;

Property Value

Type	Description
HTMLElement

placeholderButtonGroupCssClass

Declaration

get placeholderButtonGroupCssClass(): string;

set placeholderButtonGroupCssClass(value: string);

Property Value

Type	Description
string

previewMode

Declaration

get previewMode(): boolean;

set previewMode(value: boolean);

Property Value

Type	Description
boolean

productHandler

Declaration

get productHandler(): ProductHandler;

Property Value

Type	Description
ProductHandler

qualityBadToGoodChangeScaleBarCssClass

Declaration

get qualityBadToGoodChangeScaleBarCssClass(): string;

set qualityBadToGoodChangeScaleBarCssClass(value: string);

Property Value

Type	Description
string

qualityBadToWarningChangeScaleBarCssClass

Declaration

get qualityBadToWarningChangeScaleBarCssClass(): string;

set qualityBadToWarningChangeScaleBarCssClass(value: string);

Property Value

Type	Description
string

qualityChangeContainerCssClass

Declaration

get qualityChangeContainerCssClass(): string;

set qualityChangeContainerCssClass(value: string);

Property Value

Type	Description
string

qualityChangeContainersEnabled

Declaration

set qualityChangeContainersEnabled(v: boolean);

Property Value

Type	Description
boolean

qualityChangeInfoBarCssClass

Declaration

get qualityChangeInfoBarCssClass(): string;

set qualityChangeInfoBarCssClass(value: string);

Property Value

Type	Description
string

qualityChangeScaleBarCssClass

Declaration

get qualityChangeScaleBarCssClass(): string;

set qualityChangeScaleBarCssClass(value: string);

Property Value

Type	Description
string

qualityNoAnimationChangeScaleBarCssClass

Declaration

get qualityNoAnimationChangeScaleBarCssClass(): string;

set qualityNoAnimationChangeScaleBarCssClass(value: string);

Property Value

Type	Description
string

qualityWarningToGoodChangeScaleBarCssClass

Declaration

get qualityWarningToGoodChangeScaleBarCssClass(): string;

set qualityWarningToGoodChangeScaleBarCssClass(value: string);

Property Value

Type	Description
string

readonlyCanvasMode

Declaration

get readonlyCanvasMode(): boolean;

set readonlyCanvasMode(value: boolean);

Property Value

Type	Description
boolean

ready

Declaration

get ready(): boolean;

Property Value

Type	Description
boolean

redrawDesign

Declaration

redrawDesign: () => void;

Property Value

Type	Description
() => void

renderingConfigProvider

Declaration

get renderingConfigProvider(): IRenderingConfigProvider;

Property Value

Type	Description
IRenderingConfigProvider

resizeGripColor

Declaration

get resizeGripColor(): string;

set resizeGripColor(v: string);

Property Value

Type	Description
string

resizeGripLineColor

Declaration

get resizeGripLineColor(): string;

set resizeGripLineColor(value: string);

Property Value

Type	Description
string

resizeGripSize

Declaration

get resizeGripSize(): number;

set resizeGripSize(v: number);

Property Value

Type	Description
number

rightMargin

Declaration

get rightMargin(): number;

set rightMargin(v: number);

Property Value

Type	Description
number

rotateHandler

Declaration

get rotateHandler(): RotateHandler;

Property Value

Type	Description
RotateHandler

rotationGripColor

Declaration

get rotationGripColor(): string;

set rotationGripColor(v: string);

Property Value

Type	Description
string

rotationGripLineColor

Declaration

get rotationGripLineColor(): string;

set rotationGripLineColor(value: string);

Property Value

Type	Description
string

rotationGripLineLength

Declaration

get rotationGripLineLength(): number;

set rotationGripLineLength(value: number);

Property Value

Type	Description
number

rotationGripSize

Declaration

get rotationGripSize(): number;

set rotationGripSize(v: number);

Property Value

Type	Description
number

rubberbandHandler

Declaration

get rubberbandHandler(): RubberbandHandler;

Property Value

Type	Description
RubberbandHandler

selectBarcodeButtonCssClass

Declaration

get selectBarcodeButtonCssClass(): string;

set selectBarcodeButtonCssClass(value: string);

Property Value

Type	Description
string

selectedHandler

Declaration

get selectedHandler(): ItemHandler;

Property Value

Type	Description
ItemHandler

selectedPlaceholderItemHandler

Declaration

get selectedPlaceholderItemHandler(): PlaceholderItemHandler;

Property Value

Type	Description
PlaceholderItemHandler

selectImageButtonCssClass

Declaration

get selectImageButtonCssClass(): string;

set selectImageButtonCssClass(value: string);

Property Value

Type	Description
string

selection

Declaration

get selection(): SelectionHandler;

Property Value

Type	Description
SelectionHandler

selectionColor

Declaration

get selectionColor(): string;

set selectionColor(value: string);

Property Value

Type	Description
string

selectionVisibleRectangle

Declaration

get selectionVisibleRectangle(): RotatedRectangleF;

Property Value

Type	Description
RotatedRectangleF

selectionWidth

Declaration

get selectionWidth(): number;

set selectionWidth(value: number);

Property Value

Type	Description
number

service

Declaration

get service(): Service;

set service(value: Service);

Property Value

Type	Description
Service

simpleMode

Declaration

get simpleMode(): boolean;

set simpleMode(value: boolean);

Property Value

Type	Description
boolean

snapLinesHandler

Declaration

get snapLinesHandler(): SnapLinesHandler;

Property Value

Type	Description
SnapLinesHandler

status

Declaration

get status(): UpdateStatus;

Property Value

Type	Description
UpdateStatus

style

Declaration

get style(): CanvasRendererStyle;

set style(value: CanvasRendererStyle);

Property Value

Type	Description
CanvasRendererStyle

suppressOutOfRegionManipulation

Declaration

set suppressOutOfRegionManipulation(v: boolean);

Property Value

Type	Description
boolean

tags

Gets an object containing numbers of lines, rectangles, ellipses, texts, images.

Declaration

get tags(): any;

set tags(tags: any);

Property Value

Type	Description
any	Gets an object containing numbers of lines, rectangles, ellipses, texts, images.

targetDpi

Declaration

get targetDpi(): number;

set targetDpi(v: number);

Property Value

Type	Description
number

textEditor

Declaration

get textEditor(): ITextEditor;

set textEditor(value: ITextEditor);

Property Value

Type	Description
ITextEditor

textInputIssueUserConfirmationDelegate

Declaration

get textInputIssueUserConfirmationDelegate(): Func<Promise<boolean>, string>;

Property Value

Type	Description
Func<Promise<boolean>, string>

textRenderer

Declaration

get textRenderer(): TextRenderer;

Property Value

Type	Description
TextRenderer

textWhizz

Declaration

get textWhizz(): typeof TextWhizz;

Property Value

Type	Description
typeof TextWhizz

topMargin

Declaration

get topMargin(): number;

set topMargin(v: number);

Property Value

Type	Description
number

translations

Declaration

translations: Translations;

Property Value

Type	Description
Translations

viewer

Declaration

get viewer(): Viewer;

Property Value

Type	Description
Viewer

viewerConfiguration

Declaration

get viewerConfiguration(): IViewerConfiguration;

set viewerConfiguration(config: IViewerConfiguration);

Property Value

Type	Description
IViewerConfiguration

violationContainerCssClass

Declaration

get violationContainerCssClass(): string;

set violationContainerCssClass(value: string);

Property Value

Type	Description
string

violationWarningButtonCssClass

Declaration

get violationWarningButtonCssClass(): string;

set violationWarningButtonCssClass(value: string);

Property Value

Type	Description
string

violationWarningButtonsEnabled

Declaration

set violationWarningButtonsEnabled(v: boolean);

Property Value

Type	Description
boolean

warningViolationIconCssClass

Declaration

get warningViolationIconCssClass(): string;

set warningViolationIconCssClass(value: string);

Property Value

Type	Description
string

width

Declaration

get width(): number;

Property Value

Type	Description
number

workspace

Declaration

get workspace(): IWorkspace;

Property Value

Type	Description
IWorkspace

workspaceHeight

Declaration

get workspaceHeight(): number;

Property Value

Type	Description
number

workspaceWidth

Declaration

get workspaceWidth(): number;

Property Value

Type	Description
number

zoom

Declaration

get zoom(): number;

Property Value

Type	Description
number

Methods

add_afterReplaceItemHandler(handler)

Declaration

add_afterReplaceItemHandler(handler: (eventArg?: ItemHandler) => any): void;

Parameters

Type	Name	Description
(eventArg?: ItemHandler) => any	handler

Returns

Type	Description
void

add_beforeReplaceItemHandler(handler)

Declaration

add_beforeReplaceItemHandler(handler: (eventArg?: ItemHandler) => any): void;

Parameters

Type	Name	Description
(eventArg?: ItemHandler) => any	handler

Returns

Type	Description
void

add_currentItemHandlerChanged(handler)

Declaration

add_currentItemHandlerChanged(handler: (itemHandler: ItemHandler) => void): void;

Parameters

Type	Name	Description
(itemHandler: ItemHandler) => void	handler

Returns

Type	Description
void

add_dragNDropDone(handler)

Declaration

add_dragNDropDone(handler: (canvas: Canvas, itemHandler: ItemHandler) => void): void;

Parameters

Type	Name	Description
(canvas: Canvas, itemHandler: ItemHandler) => void	handler

Returns

Type	Description
void

add_dragNDropPerformed(handler)

Declaration

add_dragNDropPerformed(handler: any): void;

Parameters

Type	Name	Description
any	handler

Returns

Type	Description
void

add_dragNDropStarting(handler)

Declaration

add_dragNDropStarting(handler: any): void;

Parameters

Type	Name	Description
any	handler

Returns

Type	Description
void

add_initialized(h)

Declaration

add_initialized(h: any): void;

Parameters

Type	Name	Description
any	h

Returns

Type	Description
void

add_layersUpdated(handler)

Declaration

add_layersUpdated(handler: any): void;

Parameters

Type	Name	Description
any	handler

Returns

Type	Description
void

add_onScroll(h)

Declaration

add_onScroll(h: any): void;

Parameters

Type	Name	Description
any	h

Returns

Type	Description
void

add_onSelectionLocked(handler)

Declaration

add_onSelectionLocked(handler: (eventArg?: Canvas) => any): void;

Parameters

Type	Name	Description
(eventArg?: Canvas) => any	handler

Returns

Type	Description
void

add_ready(handler)

Declaration

add_ready(handler: any): void;

Parameters

Type	Name	Description
any	handler

Returns

Type	Description
void

add_selectedItemHandlerChanged(handler)

Declaration

add_selectedItemHandlerChanged(handler: (canvas: Canvas, itemHandler: ItemHandler) => void): void;

Parameters

Type	Name	Description
(canvas: Canvas, itemHandler: ItemHandler) => void	handler

Returns

Type	Description
void

add_workspaceSizeChanged(handler)

Declaration

add_workspaceSizeChanged(handler: any): void;

Parameters

Type	Name	Description
any	handler

Returns

Type	Description
void

add_zoomChanged(h)

Declaration

add_zoomChanged(h: any): void;

Parameters

Type	Name	Description
any	h

Returns

Type	Description
void

addElement(parentElement)

Declaration

addElement(parentElement: ChildNode | HTMLElement): void;

Parameters

Type	Name	Description
ChildNode | HTMLElement	parentElement

Returns

Type	Description
void

addPlaceholderButtonGroup(placeholder)

Declaration

addPlaceholderButtonGroup(placeholder: PlaceholderItemHandler): void;

Parameters

Type	Name	Description
PlaceholderItemHandler	placeholder

Returns

Type	Description
void

addSelectedItemHandler(itemHandler)

Declaration

addSelectedItemHandler(itemHandler: any): void;

Parameters

Type	Name	Description
any	itemHandler

Returns

Type	Description
void

addStyles()

Declaration

addStyles(): void;

Returns

Type	Description
void

addViewport(viewportElement)

Declaration

addViewport(viewportElement: HTMLDivElement): void;

Parameters

Type	Name	Description
HTMLDivElement	viewportElement

Returns

Type	Description
void

addViolationContainer(itemHandler)

Declaration

addViolationContainer(itemHandler: BaseRectangleItemHandler): void;

Parameters

Type	Name	Description
BaseRectangleItemHandler	itemHandler

Returns

Type	Description
void

calcPlatformLimitZoom()

Declaration

calcPlatformLimitZoom(): number;

Returns

Type	Description
number

changeTextEditorDivOutlineColor(toRed)

Declaration

changeTextEditorDivOutlineColor(toRed: boolean): void;

Parameters

Type	Name	Description
boolean	toRed

Returns

Type	Description
void

checkReady()

Declaration

checkReady(): void;

Returns

Type	Description
void

clearSelectedItemHandlers()

Declaration

clearSelectedItemHandlers(): void;

Returns

Type	Description
void

clearTextCursor()

Declaration

clearTextCursor(): void;

Returns

Type	Description
void

continueRedraw()

Declaration

continueRedraw(): void;

Returns

Type	Description
void

controlToWorkspace(pt)

Declaration

controlToWorkspace(pt: PointF): PointF;

Parameters

Type	Name	Description
PointF	pt

Returns

Type	Description
PointF

deleteItemHandler(itemHandler)

Declaration

deleteItemHandler(itemHandler: ItemHandler): void;

Parameters

Type	Name	Description
ItemHandler	itemHandler

Returns

Type	Description
void

deleteSelectedItemHandlers(force)

Declaration

deleteSelectedItemHandlers(force?: boolean): void;

Parameters

Type	Name	Description
boolean	force

Returns

Type	Description
void

disableSelection()

Declaration

disableSelection(): void;

Returns

Type	Description
void

dispose()

Declaration

dispose(): void;

Returns

Type	Description
void

doesContainItem(item)

Declaration

doesContainItem(item: Item): boolean;

Parameters

Type	Name	Description
Item	item

Returns

Type	Description
boolean

drawTextCursor(callback)

Declaration

drawTextCursor(callback: (context: CanvasRenderingContext2D) => void): void;

Parameters

Type	Name	Description
(context: CanvasRenderingContext2D) => void	callback

Returns

Type	Description
void

drawWaitClock(context, center)

Declaration

drawWaitClock(context: CanvasRenderingContext2D, center: PointF): void;

Parameters

Type	Name	Description
CanvasRenderingContext2D	context
PointF	center

Returns

Type	Description
void

enableSelection()

Declaration

enableSelection(): void;

Returns

Type	Description
void

ensureFocus()

Declaration

ensureFocus(): void;

Returns

Type	Description
void

getAllItemHandlers(options)

Declaration

getAllItemHandlers(options?: GetItemHandlersOptions): ItemHandler[];

Parameters

Type	Name	Description
GetItemHandlersOptions	options

Returns

Type	Description
ItemHandler[]

getButtonGroupRectInGripsDiv(div, ignoreRotate)

Declaration

getButtonGroupRectInGripsDiv(div: HTMLElement, ignoreRotate?: boolean): RectangleF;

Parameters

Type	Name	Description
HTMLElement	div
boolean	ignoreRotate

Returns

Type	Description
RectangleF

getData(forService, layerId)

Declaration

getData(forService?: boolean, layerId?: any): CanvasData;

Parameters

Type	Name	Description
boolean	forService
any	layerId

Returns

Type	Description
CanvasData

getItemHandler(item)

Declaration

getItemHandler<THandler extends ItemHandler>(item: Item): THandler;

Parameters

Type	Name	Description
Item	item

Returns

Type	Description
THandler

Type Parameters

Name	Description
THandler

getSelectedItemHandlers()

Declaration

getSelectedItemHandlers(): Collection<ItemHandler>;

Returns

Type	Description
Collection<ItemHandler>

hideDnd()

Declaration

hideDnd(): void;

Returns

Type	Description
void

hideHover()

Declaration

hideHover(): void;

Returns

Type	Description
void

hideSpotlight(items)

Declaration

hideSpotlight(items?: Item[]): void;

Parameters

Type	Name	Description
Item[]	items

Returns

Type	Description
void

initialize()

Declaration

initialize(): void;

Returns

Type	Description
void

initTextEditor(textEditor, fontService, useSimpleFontList, textInputIssueUserConfirmationDelegate)

Declaration

initTextEditor(textEditor: TextEditorMode, fontService: IFontService, useSimpleFontList: boolean, textInputIssueUserConfirmationDelegate: Func<Promise<boolean>, string>): void;

Parameters

Type	Name	Description
TextEditorMode	textEditor
IFontService	fontService
boolean	useSimpleFontList
Func<Promise<boolean>, string>	textInputIssueUserConfirmationDelegate

Returns

Type	Description
void

isDragSource(itemHandler)

Declaration

isDragSource(itemHandler: ItemHandler): boolean;

Parameters

Type	Name	Description
ItemHandler	itemHandler

Returns

Type	Description
boolean

isDragTarget(itemHandler)

Declaration

isDragTarget(itemHandler: ItemHandler): boolean;

Parameters

Type	Name	Description
ItemHandler	itemHandler

Returns

Type	Description
boolean

isItemHandlerSelected(itemHandler)

Declaration

isItemHandlerSelected(itemHandler: any): boolean;

Parameters

Type	Name	Description
any	itemHandler

Returns

Type	Description
boolean

isOnlyThisItemHandlerSelected(itemHandler)

Declaration

isOnlyThisItemHandlerSelected(itemHandler: any): boolean;

Parameters

Type	Name	Description
any	itemHandler

Returns

Type	Description
boolean

isSelectionByHitTest(pt)

Declaration

isSelectionByHitTest(pt: PointF): boolean;

Parameters

Type	Name	Description
PointF	pt

Returns

Type	Description
boolean

onDragNDropDone()

Declaration

onDragNDropDone(): void;

Returns

Type	Description
void

onDragNDropPerformed(data)

Declaration

onDragNDropPerformed(data: any): void;

Parameters

Type	Name	Description
any	data

Returns

Type	Description
void

onDragNDropStarting(data)

Declaration

onDragNDropStarting(data: any): void;

Parameters

Type	Name	Description
any	data

Returns

Type	Description
void

onLayerTextureLoaded()

Declaration

onLayerTextureLoaded(): void;

Returns

Type	Description
void

onScroll()

Declaration

onScroll(): void;

Returns

Type	Description
void

onSelectionLocked()

Declaration

onSelectionLocked(): void;

Returns

Type	Description
void

pauseRedraw()

Declaration

pauseRedraw(): void;

Returns

Type	Description
void

pauseUpdateTexts()

Declaration

pauseUpdateTexts(): void;

Returns

Type	Description
void

redraw()

Declaration

redraw(): void;

Returns

Type	Description
void

redrawActiveTexts()

Declaration

redrawActiveTexts(): void;

Returns

Type	Description
void

redrawSelection()

Declaration

redrawSelection(): void;

Returns

Type	Description
void

remove_afterReplaceItemHandler(handler)

Declaration

remove_afterReplaceItemHandler(handler: (eventArg?: ItemHandler) => any): void;

Parameters

Type	Name	Description
(eventArg?: ItemHandler) => any	handler

Returns

Type	Description
void

remove_beforeReplaceItemHandler(handler)

Declaration

remove_beforeReplaceItemHandler(handler: (eventArg?: ItemHandler) => any): void;

Parameters

Type	Name	Description
(eventArg?: ItemHandler) => any	handler

Returns

Type	Description
void

remove_currentItemHandlerChanged(handler)

Declaration

remove_currentItemHandlerChanged(handler: (itemHandler: ItemHandler) => void): void;

Parameters

Type	Name	Description
(itemHandler: ItemHandler) => void	handler

Returns

Type	Description
void

remove_dragNDropDone(handler)

Declaration

remove_dragNDropDone(handler: any): void;

Parameters

Type	Name	Description
any	handler

Returns

Type	Description
void

remove_dragNDropPerformed(handler)

Declaration

remove_dragNDropPerformed(handler: any): void;

Parameters

Type	Name	Description
any	handler

Returns

Type	Description
void

remove_dragNDropStarting(handler)

Declaration

remove_dragNDropStarting(handler: any): void;

Parameters

Type	Name	Description
any	handler

Returns

Type	Description
void

remove_initialized(h)

Declaration

remove_initialized(h: any): void;

Parameters

Type	Name	Description
any	h

Returns

Type	Description
void

remove_layersUpdated(handler)

Declaration

remove_layersUpdated(handler: any): void;

Parameters

Type	Name	Description
any	handler

Returns

Type	Description
void

remove_onScroll(h)

Declaration

remove_onScroll(h: any): void;

Parameters

Type	Name	Description
any	h

Returns

Type	Description
void

remove_onSelectionLocked(handler)

Declaration

remove_onSelectionLocked(handler: (eventArg?: Canvas) => any): void;

Parameters

Type	Name	Description
(eventArg?: Canvas) => any	handler

Returns

Type	Description
void

remove_ready(handler)

Declaration

remove_ready(handler: any): void;

Parameters

Type	Name	Description
any	handler

Returns

Type	Description
void

remove_selectedItemHandlerChanged(handler)

Declaration

remove_selectedItemHandlerChanged(handler: (canvas: Canvas, itemHandler: ItemHandler) => void): void;

Parameters

Type	Name	Description
(canvas: Canvas, itemHandler: ItemHandler) => void	handler

Returns

Type	Description
void

remove_workspaceSizeChanged(handler)

Declaration

remove_workspaceSizeChanged(handler: any): void;

Parameters

Type	Name	Description
any	handler

Returns

Type	Description
void

remove_zoomChanged(h)

Declaration

remove_zoomChanged(h: any): void;

Parameters

Type	Name	Description
any	h

Returns

Type	Description
void

removePlaceholderButtonGroup(placeholder)

Declaration

removePlaceholderButtonGroup(placeholder: PlaceholderItemHandler): void;

Parameters

Type	Name	Description
PlaceholderItemHandler	placeholder

Returns

Type	Description
void

removeSelectedItemHandler(itemHandler)

Declaration

removeSelectedItemHandler(itemHandler: any): void;

Parameters

Type	Name	Description
any	itemHandler

Returns

Type	Description
void

removeViolationContainer(handler)

Declaration

removeViolationContainer(handler: BaseRectangleItemHandler): void;

Parameters

Type	Name	Description
BaseRectangleItemHandler	handler

Returns

Type	Description
void

resumeUpdateTexts()

Declaration

resumeUpdateTexts(): void;

Returns

Type	Description
void

setCursor(value, onBody)

Declaration

setCursor(value: Cursor, onBody: boolean): void;

Parameters

Type	Name	Description
Cursor	value
boolean	onBody

Returns

Type	Description
void

setSelectedItemHandlers(itemHandlers)

Declaration

setSelectedItemHandlers(itemHandlers: BaseRectangleItemHandler[]): void;

Parameters

Type	Name	Description
BaseRectangleItemHandler[]	itemHandlers

Returns

Type	Description
void

setTextWhizzModule(textWhizz)

Declaration

setTextWhizzModule(textWhizz: typeof TextWhizz): void;

Parameters

Type	Name	Description
typeof TextWhizz	textWhizz

Returns

Type	Description
void

setWorkspaceSize(width, height, updateButtonGroup)

Declaration

setWorkspaceSize(width: number, height: number, updateButtonGroup?: boolean): void;

Parameters

Type	Name	Description
number	width
number	height
boolean	updateButtonGroup

Returns

Type	Description
void

setZoom(value, preventEvent, options)

Declaration

setZoom(value: number, preventEvent?: boolean, options?: {
        force?: boolean;
        updateButtonGroup?: boolean;
        fullUpdate?: boolean;
    }): void;

Parameters

Type	Name	Description
number	value
boolean	preventEvent
{ force?: boolean; updateButtonGroup?: boolean; fullUpdate?: boolean; }	options

Returns

Type	Description
void

showDnd(point, image)

Declaration

showDnd(point: PointF, image: HTMLImageElement): void;

Parameters

Type	Name	Description
PointF	point
HTMLImageElement	image

Returns

Type	Description
void

showHover(item)

Declaration

showHover(item: Item): void;

Parameters

Type	Name	Description
Item	item

Returns

Type	Description
void

showSpotlight(items, options)

Declaration

showSpotlight(items: Item[], options: ISpotlightOptions): void;

Parameters

Type	Name	Description
Item[]	items
ISpotlightOptions	options

Returns

Type	Description
void

subscribeLimitsMessage()

Declaration

subscribeLimitsMessage(): void;

Returns

Type	Description
void

unsubscribeLimitsMessage()

Declaration

unsubscribeLimitsMessage(): void;

Returns

Type	Description
void

updateButtonGroups(options)

Declaration

updateButtonGroups(options?: UpdateButtonGroupsOptions): void;

Parameters

Type	Name	Description
UpdateButtonGroupsOptions	options

Returns

Type	Description
void

updatePlaceholderButtonGroup(placeholder)

Declaration

updatePlaceholderButtonGroup(placeholder: PlaceholderItemHandler | GroupItemHandler): void;

Parameters

Type	Name	Description
PlaceholderItemHandler | GroupItemHandler	placeholder

Returns

Type	Description
void

updatePlaceholderButtonGroupPosition(placeholder)

Declaration

updatePlaceholderButtonGroupPosition(placeholder: PlaceholderItemHandler): void;

Parameters

Type	Name	Description
PlaceholderItemHandler	placeholder

Returns

Type	Description
void

updatePlaceholderButtonGroups(onlyVisible)

Declaration

updatePlaceholderButtonGroups(onlyVisible?: boolean): void;

Parameters

Type	Name	Description
boolean	onlyVisible

Returns

Type	Description
void

updateSelection(force)

Declaration

updateSelection(force?: boolean): void;

Parameters

Type	Name	Description
boolean	force

Returns

Type	Description
void

updateSpotlight(items, options)

Deprecation: use showSpotlight()

Declaration

updateSpotlight(items: Item[], options: ISpotlightOptions): void;

Parameters

Type	Name	Description
Item[]	items
ISpotlightOptions	options

Returns

Type	Description
void

updateTexts(textToSkip)

Declaration

updateTexts(textToSkip?: any): void;

Parameters

Type	Name	Description
any	textToSkip

Returns

Type	Description
void

updateViewport()

Declaration

updateViewport(): void;

Returns

Type	Description
void

updateViolationContainer(itemHandler, updatePosition)

Declaration

updateViolationContainer(itemHandler: BaseRectangleItemHandler, updatePosition?: boolean): void;

Parameters

Type	Name	Description
BaseRectangleItemHandler	itemHandler
boolean	updatePosition

Returns

Type	Description
void

updateViolationContainerPosition(itemHandler)

Declaration

updateViolationContainerPosition(itemHandler: BaseRectangleItemHandler): void;

Parameters

Type	Name	Description
BaseRectangleItemHandler	itemHandler

Returns

Type	Description
void

updateViolationContainers(updatePosition, onlyVisible)

Declaration

updateViolationContainers(updatePosition?: boolean, onlyVisible?: boolean): void;

Parameters

Type	Name	Description
boolean	updatePosition
boolean	onlyVisible

Returns

Type	Description
void

violationWarningButtonHitTestObject(pt)

Declaration

violationWarningButtonHitTestObject(pt: PointF): BaseRectangleItemHandler;

Parameters

Type	Name	Description
PointF	pt

Returns

Type	Description
BaseRectangleItemHandler

waitUpdate(itemHandlers)

Declaration

waitUpdate(itemHandlers?: ItemHandler[]): Promise<void[]>;

Parameters

Type	Name	Description
ItemHandler[]	itemHandlers

Returns

Type	Description
Promise<void[]>

workspaceToControl(pt)

Declaration

workspaceToControl(pt: PointF): PointF;

Parameters

Type	Name	Description
PointF	pt

Returns

Type	Description
PointF