Canvas

Classes

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.

Implements

• ICanvas
• ICanvasDataSource

Constructors

Constructor

new Canvas(viewer): Canvas;

Parameters

Parameter	Type
viewer	Viewer

Returns

Canvas

Properties

handlerFactory

readonly handlerFactory: HandlerFactoryByItem;

translations

translations: Translations;

Implementation of

ICanvasDataSource.translations

Accessors

activeTextCanvasHandler

Get Signature

get activeTextCanvasHandler(): IActiveTextCanvasHandler;

Returns

IActiveTextCanvasHandler

autoPlaceholderEditModeEnabled

Get Signature

get autoPlaceholderEditModeEnabled(): boolean;

Returns

boolean

Set Signature

set autoPlaceholderEditModeEnabled(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

background

Get Signature

get background(): string;

Returns

string

Set Signature

set background(value): void;

Parameters

Parameter	Type
value	string

Returns

void

backgroundImage

Set Signature

set backgroundImage(value): void;

Parameters

Parameter	Type
value	any

Returns

void

badViolationIconCssClass

Get Signature

get badViolationIconCssClass(): string;

Returns

string

Set Signature

set badViolationIconCssClass(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

ICanvasDataSource.badViolationIconCssClass

bigButtonGroupCssClass

Get Signature

get bigButtonGroupCssClass(): string;

Returns

string

Set Signature

set bigButtonGroupCssClass(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

ICanvasDataSource.bigButtonGroupCssClass

bottomMargin

Get Signature

get bottomMargin(): number;

Returns

number

Set Signature

set bottomMargin(v): void;

Parameters

Parameter	Type
v	number

Returns

void

canvasElementSize

Get Signature

get canvasElementSize(): object;

Returns

object

height?

optional height?: number;

width?

optional width?: number;

Implementation of

ICanvas.canvasElementSize

canvasItemHoverEnabled

Get Signature

get canvasItemHoverEnabled(): boolean;

Returns

boolean

Set Signature

set canvasItemHoverEnabled(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

constrainedMarginEnabled

Get Signature

get constrainedMarginEnabled(): boolean;

Returns

boolean

Set Signature

set constrainedMarginEnabled(v): void;

Parameters

Parameter	Type
v	boolean

Returns

void

contentAngle

Get Signature

get contentAngle(): number;

Returns

number

Implementation of

ICanvas.contentAngle

contentEditingPlaceholderItemHandler

Get Signature

get contentEditingPlaceholderItemHandler(): PlaceholderItemHandler;

Returns

PlaceholderItemHandler

contentUpdatingPlaceholderItemHandler

Get Signature

get contentUpdatingPlaceholderItemHandler(): PlaceholderItemHandler;

Returns

PlaceholderItemHandler

currentItemHandler

Get Signature

get currentItemHandler(): BaseRectangleItemHandler;

Returns

BaseRectangleItemHandler

Implementation of

ICanvas.currentItemHandler

designAtomsApiClient

Get Signature

get designAtomsApiClient(): IDesignAtomsApiClient;

Returns

IDesignAtomsApiClient

Implementation of

ICanvas.designAtomsApiClient

disableSmoothing

Get Signature

get disableSmoothing(): boolean;

Returns

boolean

Set Signature

set disableSmoothing(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Implementation of

ICanvasDataSource.disableSmoothing

dndHandler

Get Signature

get dndHandler(): DragNDropHandler;

Returns

DragNDropHandler

doneButtonCssClass

Get Signature

get doneButtonCssClass(): string;

Returns

string

Set Signature

set doneButtonCssClass(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

ICanvasDataSource.doneButtonCssClass

errorInput

Get Signature

get errorInput(): boolean;

Returns

boolean

floatingToolbarManager

Get Signature

get floatingToolbarManager(): FloatingToolbarManager;

Returns

FloatingToolbarManager

fontRegistry

Get Signature

get fontRegistry(): FontRegistry;

Returns

FontRegistry

Implementation of

ICanvas.fontRegistry

frontEndTextRenderingEnabled

Get Signature

get frontEndTextRenderingEnabled(): boolean;

Returns

boolean

Implementation of

ICanvas.frontEndTextRenderingEnabled

goodViolationIconCssClass

Get Signature

get goodViolationIconCssClass(): string;

Returns

string

Set Signature

set goodViolationIconCssClass(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

ICanvasDataSource.goodViolationIconCssClass

handleButtonCssClass

Get Signature

get handleButtonCssClass(): string;

Returns

string

Set Signature

set handleButtonCssClass(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

ICanvasDataSource.handleButtonCssClass

height

Get Signature

get height(): number;

Returns

number

Implementation of

ICanvas.height

hiddenFieldID

Get Signature

get hiddenFieldID(): string;

Returns

string

Set Signature

set hiddenFieldID(value): void;

Parameters

Parameter	Type
value	string

Returns

void

history

Get Signature

get history(): History;

Returns

History

Set Signature

set history(value): void;

Parameters

Parameter	Type
value	History

Returns

void

Implementation of

ICanvas.history

hitTestManager

Get Signature

get hitTestManager(): HitTestManager;

Returns

HitTestManager

Implementation of

ICanvas.hitTestManager

hoverColor

Get Signature

get hoverColor(): string;

Returns

string

Set Signature

set hoverColor(value): void;

Parameters

Parameter	Type
value	string

Returns

void

hoverHandler

Get Signature

get hoverHandler(): HoverHandler;

Returns

HoverHandler

Implementation of

ICanvas.hoverHandler

ignorePermissionsMode

Get Signature

get ignorePermissionsMode(): boolean;

Returns

boolean

Set Signature

set ignorePermissionsMode(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Implementation of

ICanvas.ignorePermissionsMode

initialization

Get Signature

get initialization(): boolean;

Returns

boolean

Implementation of

ICanvas.initialization

inPlaceEditingHandler

Get Signature

get inPlaceEditingHandler(): NewBaseTextItemHandler;

Returns

NewBaseTextItemHandler

isInitialized

Get Signature

get isInitialized(): boolean;

Returns

boolean

Implementation of

ICanvas.isInitialized

isSelectionDragging

Get Signature

get isSelectionDragging(): boolean;

Returns

boolean

Implementation of

ICanvas.isSelectionDragging

isSelectionIdle

Get Signature

get isSelectionIdle(): boolean;

Returns

boolean

Implementation of

ICanvas.isSelectionIdle

isSelectionLocked

Get Signature

get isSelectionLocked(): boolean;

Returns

boolean

Implementation of

ICanvas.isSelectionLocked

isSelectionResizing

Get Signature

get isSelectionResizing(): boolean;

Returns

boolean

Implementation of

ICanvas.isSelectionResizing

isSelectionRotating

Get Signature

get isSelectionRotating(): boolean;

Returns

boolean

Implementation of

ICanvas.isSelectionRotating

isUpdating

Get Signature

get isUpdating(): boolean;

Returns

boolean

keyEventEnabled

Get Signature

get keyEventEnabled(): boolean;

Returns

boolean

Set Signature

set keyEventEnabled(v): void;

Parameters

Parameter	Type
v	boolean

Returns

void

lastLimitsEvent

Get Signature

get lastLimitsEvent(): ILimitsViolationEventData;

Returns

ILimitsViolationEventData

layers

Get Signature

get layers(): LayerCollection;

Returns

LayerCollection

Set Signature

set layers(v): void;

Parameters

Parameter	Type
v	LayerCollection

Returns

void

Implementation of

ICanvasDataSource.layers

leftMargin

Get Signature

get leftMargin(): number;

Returns

number

Set Signature

set leftMargin(v): void;

Parameters

Parameter	Type
v	number

Returns

void

margin

Get Signature

get margin(): number;

Returns

number

Set Signature

set margin(v): void;

Parameters

Parameter	Type
v	number

Returns

void

marginColor

Get Signature

get marginColor(): string;

Returns

string

Set Signature

set marginColor(v): void;

Parameters

Parameter	Type
v	string

Returns

void

marginWidth

Get Signature

get marginWidth(): number;

Returns

number

Set Signature

set marginWidth(v): void;

Parameters

Parameter	Type
v	number

Returns

void

maxFontSize

Get Signature

get maxFontSize(): number;

Returns

number

Set Signature

set maxFontSize(v): void;

Parameters

Parameter	Type
v	number

Returns

void

Implementation of

ICanvasDataSource.maxFontSize

maxLeading

Get Signature

get maxLeading(): number;

Returns

number

Set Signature

set maxLeading(v): void;

Parameters

Parameter	Type
v	number

Returns

void

Implementation of

ICanvasDataSource.maxLeading

minFontSize

Get Signature

get minFontSize(): number;

Returns

number

Set Signature

set minFontSize(v): void;

Parameters

Parameter	Type
v	number

Returns

void

Implementation of

ICanvasDataSource.minFontSize

minLeading

Get Signature

get minLeading(): number;

Returns

number

Set Signature

set minLeading(v): void;

Parameters

Parameter	Type
v	number

Returns

void

Implementation of

ICanvasDataSource.minLeading

mouseMoveTimeout

Get Signature

get mouseMoveTimeout(): number;

Returns

number

Set Signature

set mouseMoveTimeout(value): void;

Parameters

Parameter	Type
value	number

Returns

void

Implementation of

ICanvasDataSource.mouseMoveTimeout

mul

Get Signature

get mul(): number;

Returns

number

Implementation of

ICanvas.mul

multipleSelectionEnabled

Get Signature

get multipleSelectionEnabled(): boolean;

Returns

boolean

Set Signature

set multipleSelectionEnabled(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Implementation of

ICanvasDataSource.multipleSelectionEnabled

offset

Get Signature

get offset(): PointF;

Returns

PointF

Set Signature

set offset(value): void;

Parameters

Parameter	Type
value	PointF

Returns

void

Implementation of

ICanvas.offset

parentElement

Get Signature

get parentElement(): HTMLElement;

Returns

HTMLElement

placeholderButtonGroupCssClass

Get Signature

get placeholderButtonGroupCssClass(): string;

Returns

string

Set Signature

set placeholderButtonGroupCssClass(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

ICanvasDataSource.placeholderButtonGroupCssClass

previewMode

Get Signature

get previewMode(): boolean;

Returns

boolean

Set Signature

set previewMode(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

Implementation of

ICanvas.previewMode

productHandler

Get Signature

get productHandler(): ProductHandler;

Returns

ProductHandler

qualityBadToGoodChangeScaleBarCssClass

Get Signature

get qualityBadToGoodChangeScaleBarCssClass(): string;

Returns

string

Set Signature

set qualityBadToGoodChangeScaleBarCssClass(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

ICanvasDataSource.qualityBadToGoodChangeScaleBarCssClass

qualityBadToWarningChangeScaleBarCssClass

Get Signature

get qualityBadToWarningChangeScaleBarCssClass(): string;

Returns

string

Set Signature

set qualityBadToWarningChangeScaleBarCssClass(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

ICanvasDataSource.qualityBadToWarningChangeScaleBarCssClass

qualityChangeContainerCssClass

Get Signature

get qualityChangeContainerCssClass(): string;

Returns

string

Set Signature

set qualityChangeContainerCssClass(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

ICanvasDataSource.qualityChangeContainerCssClass

qualityChangeContainersEnabled

Get Signature

get qualityChangeContainersEnabled(): boolean;

Returns

boolean

Set Signature

set qualityChangeContainersEnabled(v): void;

Parameters

Parameter	Type
v	boolean

Returns

void

qualityChangeInfoBarCssClass

Get Signature

get qualityChangeInfoBarCssClass(): string;

Returns

string

Set Signature

set qualityChangeInfoBarCssClass(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

ICanvasDataSource.qualityChangeInfoBarCssClass

qualityChangeScaleBarCssClass

Get Signature

get qualityChangeScaleBarCssClass(): string;

Returns

string

Set Signature

set qualityChangeScaleBarCssClass(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

ICanvasDataSource.qualityChangeScaleBarCssClass

qualityNoAnimationChangeScaleBarCssClass

Get Signature

get qualityNoAnimationChangeScaleBarCssClass(): string;

Returns

string

Set Signature

set qualityNoAnimationChangeScaleBarCssClass(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

ICanvasDataSource.qualityNoAnimationChangeScaleBarCssClass

qualityWarningToGoodChangeScaleBarCssClass

Get Signature

get qualityWarningToGoodChangeScaleBarCssClass(): string;

Returns

string

Set Signature

set qualityWarningToGoodChangeScaleBarCssClass(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

ICanvasDataSource.qualityWarningToGoodChangeScaleBarCssClass

readonlyCanvasMode

Get Signature

get readonlyCanvasMode(): boolean;

Returns

boolean

Set Signature

set readonlyCanvasMode(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

ready

Get Signature

get ready(): boolean;

Returns

boolean

renderingConfigProvider

Get Signature

get renderingConfigProvider(): IRenderingConfigProvider;

Returns

IRenderingConfigProvider

Implementation of

ICanvas.renderingConfigProvider

resizeGripColor

Get Signature

get resizeGripColor(): string;

Returns

string

Set Signature

set resizeGripColor(v): void;

Parameters

Parameter	Type
v	string

Returns

void

Implementation of

ICanvasDataSource.resizeGripColor

resizeGripLineColor

Get Signature

get resizeGripLineColor(): string;

Returns

string

Set Signature

set resizeGripLineColor(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

ICanvasDataSource.resizeGripLineColor

resizeGripSize

Get Signature

get resizeGripSize(): number;

Returns

number

Set Signature

set resizeGripSize(v): void;

Parameters

Parameter	Type
v	number

Returns

void

Implementation of

ICanvasDataSource.resizeGripSize

rightMargin

Get Signature

get rightMargin(): number;

Returns

number

Set Signature

set rightMargin(v): void;

Parameters

Parameter	Type
v	number

Returns

void

rotateHandler

Get Signature

get rotateHandler(): RotateHandler;

Returns

RotateHandler

rotationGripColor

Get Signature

get rotationGripColor(): string;

Returns

string

Set Signature

set rotationGripColor(v): void;

Parameters

Parameter	Type
v	string

Returns

void

Implementation of

ICanvasDataSource.rotationGripColor

rotationGripLineColor

Get Signature

get rotationGripLineColor(): string;

Returns

string

Set Signature

set rotationGripLineColor(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

ICanvasDataSource.rotationGripLineColor

rotationGripLineLength

Get Signature

get rotationGripLineLength(): number;

Returns

number

Set Signature

set rotationGripLineLength(value): void;

Parameters

Parameter	Type
value	number

Returns

void

Implementation of

ICanvasDataSource.rotationGripLineLength

rotationGripSize

Get Signature

get rotationGripSize(): number;

Returns

number

Set Signature

set rotationGripSize(v): void;

Parameters

Parameter	Type
v	number

Returns

void

Implementation of

ICanvasDataSource.rotationGripSize

rubberbandHandler

Get Signature

get rubberbandHandler(): RubberbandHandler;

Returns

RubberbandHandler

selectBarcodeButtonCssClass

Get Signature

get selectBarcodeButtonCssClass(): string;

Returns

string

Set Signature

set selectBarcodeButtonCssClass(value): void;

Parameters

Parameter	Type
value	string

Returns

void

selectedHandler

Get Signature

get selectedHandler(): any;

Returns

any

selectedPlaceholderItemHandler

Get Signature

get selectedPlaceholderItemHandler(): PlaceholderItemHandler;

Returns

PlaceholderItemHandler

selectImageButtonCssClass

Get Signature

get selectImageButtonCssClass(): string;

Returns

string

Set Signature

set selectImageButtonCssClass(value): void;

Parameters

Parameter	Type
value	string

Returns

void

selection

Get Signature

get selection(): SelectionHandler;

Returns

SelectionHandler

selectionColor

Get Signature

get selectionColor(): string;

Returns

string

Set Signature

set selectionColor(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

ICanvasDataSource.selectionColor

selectionVisibleRectangle

Get Signature

get selectionVisibleRectangle(): any;

Returns

any

selectionWidth

Get Signature

get selectionWidth(): number;

Returns

number

Set Signature

set selectionWidth(value): void;

Parameters

Parameter	Type
value	number

Returns

void

Implementation of

ICanvasDataSource.selectionWidth

service

Get Signature

get service(): Service;

Returns

Service

Set Signature

set service(value): void;

Parameters

Parameter	Type
value	Service

Returns

void

Implementation of

ICanvas.service

simpleMode

Get Signature

get simpleMode(): boolean;

Returns

boolean

Set Signature

set simpleMode(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

snapLinesHandler

Get Signature

get snapLinesHandler(): SnapLinesHandler;

Returns

SnapLinesHandler

status

Get Signature

get status(): UpdateStatus;

Returns

UpdateStatus

style

Get Signature

get style(): CanvasRendererStyle;

Returns

CanvasRendererStyle

Set Signature

set style(value): void;

Parameters

Parameter	Type
value	CanvasRendererStyle

Returns

void

Implementation of

ICanvas.style

suppressFocusManagement

Get Signature

get suppressFocusManagement(): boolean;

Returns

boolean

Set Signature

set suppressFocusManagement(value): void;

Parameters

Parameter	Type
value	boolean

Returns

void

suppressOutOfRegionManipulation

Get Signature

get suppressOutOfRegionManipulation(): boolean;

Returns

boolean

Set Signature

set suppressOutOfRegionManipulation(v): void;

Parameters

Parameter	Type
v	boolean

Returns

void

surfaceCanvas

Get Signature

get surfaceCanvas(): HTMLCanvasElement;

Returns

HTMLCanvasElement

tags

Get Signature

get tags(): any;

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

Returns

any

Set Signature

set tags(tags): void;

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

Parameters

Parameter	Type
tags	any

Returns

void

Implementation of

ICanvasDataSource.tags

targetDpi

Get Signature

get targetDpi(): number;

Returns

number

Set Signature

set targetDpi(v): void;

Parameters

Parameter	Type
v	number

Returns

void

Implementation of

ICanvasDataSource.targetDpi

textEditor

Get Signature

get textEditor(): ITextEditor;

Returns

ITextEditor

Set Signature

set textEditor(value): void;

Parameters

Parameter	Type
value	ITextEditor

Returns

void

Implementation of

ICanvas.textEditor

textInputIssueUserConfirmationDelegate

Get Signature

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

Returns

Func<Promise<boolean>, string>

textRenderer

Get Signature

get textRenderer(): TextRenderer;

Returns

TextRenderer

textWhizz

Get Signature

get textWhizz(): any;

Returns

any

Implementation of

ICanvas.textWhizz

topMargin

Get Signature

get topMargin(): number;

Returns

number

Set Signature

set topMargin(v): void;

Parameters

Parameter	Type
v	number

Returns

void

viewer

Get Signature

get viewer(): Viewer;

Returns

Viewer

viewerConfiguration

Get Signature

get viewerConfiguration(): IViewerConfiguration;

Returns

IViewerConfiguration

Set Signature

set viewerConfiguration(config): void;

Parameters

Parameter	Type
config	IViewerConfiguration

Returns

void

Implementation of

ICanvas.viewerConfiguration

violationContainerCssClass

Get Signature

get violationContainerCssClass(): string;

Returns

string

Set Signature

set violationContainerCssClass(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

ICanvasDataSource.violationContainerCssClass

violationService

Set Signature

set violationService(service): void;

Parameters

Parameter	Type
service	ViolationService

Returns

void

violationWarningButtonCssClass

Get Signature

get violationWarningButtonCssClass(): string;

Returns

string

Set Signature

set violationWarningButtonCssClass(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

ICanvasDataSource.violationWarningButtonCssClass

violationWarningButtonsEnabled

Get Signature

get violationWarningButtonsEnabled(): boolean;

Returns

boolean

Set Signature

set violationWarningButtonsEnabled(v): void;

Parameters

Parameter	Type
v	boolean

Returns

void

warningViolationIconCssClass

Get Signature

get warningViolationIconCssClass(): string;

Returns

string

Set Signature

set warningViolationIconCssClass(value): void;

Parameters

Parameter	Type
value	string

Returns

void

Implementation of

ICanvasDataSource.warningViolationIconCssClass

width

Get Signature

get width(): number;

Returns

number

Implementation of

ICanvas.width

workspace

Get Signature

get workspace(): IWorkspace;

Returns

IWorkspace

Implementation of

ICanvas.workspace

workspaceHeight

Get Signature

get workspaceHeight(): number;

Returns

number

Implementation of

ICanvasDataSource.workspaceHeight

workspaceWidth

Get Signature

get workspaceWidth(): number;

Returns

number

Implementation of

ICanvasDataSource.workspaceWidth

zoom

Get Signature

get zoom(): number;

Returns

number

Implementation of

ICanvasDataSource.zoom

Methods

addElement()

addElement(parentElement): void;

Parameters

Parameter	Type
parentElement	HTMLElement | ChildNode

Returns

void

addPlaceholderButtonGroup()

addPlaceholderButtonGroup(placeholder): void;

Parameters

Parameter	Type
placeholder	PlaceholderItemHandler

Returns

void

Implementation of

ICanvas.addPlaceholderButtonGroup

addSelectedItemHandler()

addSelectedItemHandler(itemHandler): void;

Parameters

Parameter	Type
itemHandler	any

Returns

void

Implementation of

ICanvas.addSelectedItemHandler

addStyles()

addStyles(): void;

Returns

void

addViewport()

addViewport(viewportElement): void;

Parameters

Parameter	Type
viewportElement	HTMLDivElement

Returns

void

addViolationContainer()

addViolationContainer(itemHandler): void;

Parameters

Parameter	Type
itemHandler	BaseRectangleItemHandler

Returns

void

Implementation of

ICanvas.addViolationContainer

afterReplaceItemHandler()

afterReplaceItemHandler(handler): void;

Parameters

Parameter	Type
handler	(eventArg?) => any

Returns

void

afterReplaceItemHandler()

afterReplaceItemHandler(handler): void;

Parameters

Parameter	Type
handler	(eventArg?) => any

Returns

void

beforeReplaceItemHandler()

beforeReplaceItemHandler(handler): void;

Parameters

Parameter	Type
handler	(eventArg?) => any

Returns

void

beforeReplaceItemHandler()

beforeReplaceItemHandler(handler): void;

Parameters

Parameter	Type
handler	(eventArg?) => any

Returns

void

calcPlatformLimitZoom()

calcPlatformLimitZoom(): number;

Returns

number

changeTextEditorDivOutlineColor()

changeTextEditorDivOutlineColor(toRed): void;

Parameters

Parameter	Type
toRed	boolean

Returns

void

checkReady()

checkReady(): void;

Returns

void

clearSelectedItemHandlers()

clearSelectedItemHandlers(): void;

Returns

void

Implementation of

ICanvas.clearSelectedItemHandlers

clearTextCursor()

clearTextCursor(): void;

Returns

void

continueRedraw()

continueRedraw(): void;

Returns

void

Implementation of

ICanvas.continueRedraw

controlToWorkspace()

controlToWorkspace(pt): any;

Parameters

Parameter	Type
pt	PointF

Returns

any

currentItemHandlerChanged()

currentItemHandlerChanged(handler): void;

Parameters

Parameter	Type
handler	(itemHandler) => void

Returns

void

currentItemHandlerChanged()

currentItemHandlerChanged(handler): void;

Parameters

Parameter	Type
handler	(itemHandler) => void

Returns

void

deleteItemHandler()

deleteItemHandler(itemHandler): void;

Parameters

Parameter	Type
itemHandler	ItemHandler

Returns

void

Implementation of

ICanvas.deleteItemHandler

deleteSelectedItemHandlers()

deleteSelectedItemHandlers(force?): void;

Parameters

Parameter	Type	Default value
force	boolean	false

Returns

void

disableSelection()

disableSelection(): void;

Returns

void

Implementation of

ICanvas.disableSelection

dispose()

dispose(): void;

Returns

void

doesContainItem()

doesContainItem(item): boolean;

Parameters

Parameter	Type
item	Item

Returns

boolean

Implementation of

ICanvas.doesContainItem

dragNDropDone()

dragNDropDone(handler): void;

Parameters

Parameter	Type
handler	(canvas, itemHandler) => void

Returns

void

dragNDropDone()

dragNDropDone(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

dragNDropPerformed()

dragNDropPerformed(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

dragNDropPerformed()

dragNDropPerformed(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

dragNDropStarting()

dragNDropStarting(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

dragNDropStarting()

dragNDropStarting(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

drawTextCursor()

drawTextCursor(callback): void;

Parameters

Parameter	Type
callback	(context) => void

Returns

void

drawWaitClock()

drawWaitClock(context, center): void;

Parameters

Parameter	Type
context	CanvasRenderingContext2D
center	PointF

Returns

void

Implementation of

ICanvas.drawWaitClock

enableSelection()

enableSelection(): void;

Returns

void

Implementation of

ICanvas.enableSelection

ensureFocus()

ensureFocus(): void;

Returns

void

Implementation of

ICanvas.ensureFocus

getAllItemHandlers()

getAllItemHandlers(options?): ItemHandler[];

Parameters

Parameter	Type
options?	GetItemHandlersOptions

Returns

ItemHandler[]

Implementation of

ICanvas.getAllItemHandlers

getButtonGroupRectInGripsDiv()

getButtonGroupRectInGripsDiv(div, ignoreRotate?): any;

Parameters

Parameter	Type	Default value
div	HTMLElement	undefined
ignoreRotate	boolean	false

Returns

any

Implementation of

ICanvas.getButtonGroupRectInGripsDiv

getData()

getData(forService?, layerId?): CanvasData;

Parameters

Parameter	Type	Default value
forService	boolean	false
layerId	any	null

Returns

CanvasData

Implementation of

ICanvas.getData

getItemHandler()

getItemHandler<THandler>(item): THandler;

Type Parameters

Type Parameter
THandler extends ItemHandler

Parameters

Parameter	Type
item	Item

Returns

THandler

Implementation of

ICanvas.getItemHandler

getSelectedItemHandlers()

getSelectedItemHandlers(): Collection<ItemHandler>;

Returns

Collection<ItemHandler>

hideDnd()

hideDnd(): void;

Returns

void

hideHover()

hideHover(): void;

Returns

void

hideSpotlight()

hideSpotlight(items?): void;

Parameters

Parameter	Type
items?	Item[]

Returns

void

initialize()

initialize(): void;

Returns

void

initialized()

initialized(h): void;

Parameters

Parameter	Type
h	any

Returns

void

initialized()

initialized(h): void;

Parameters

Parameter	Type
h	any

Returns

void

initTextEditor()

initTextEditor(
   textEditor, 
   fontService, 
   useSimpleFontList, 
   textInputIssueUserConfirmationDelegate): void;

Parameters

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

Returns

void

isDragSource()

isDragSource(itemHandler): boolean;

Parameters

Parameter	Type
itemHandler	ItemHandler

Returns

boolean

Implementation of

ICanvas.isDragSource

isDragTarget()

isDragTarget(itemHandler): boolean;

Parameters

Parameter	Type
itemHandler	ItemHandler

Returns

boolean

Implementation of

ICanvas.isDragTarget

isItemHandlerSelected()

isItemHandlerSelected(itemHandler): any;

Parameters

Parameter	Type
itemHandler	any

Returns

any

Implementation of

ICanvas.isItemHandlerSelected

isOnlyThisItemHandlerSelected()

isOnlyThisItemHandlerSelected(itemHandler): boolean;

Parameters

Parameter	Type
itemHandler	any

Returns

boolean

Implementation of

ICanvas.isOnlyThisItemHandlerSelected

isSelectionByHitTest()

isSelectionByHitTest(pt): boolean;

Parameters

Parameter	Type
pt	PointF

Returns

boolean

layersUpdated()

layersUpdated(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

layersUpdated()

layersUpdated(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

onDragNDropDone()

onDragNDropDone(): void;

Returns

void

onDragNDropPerformed()

onDragNDropPerformed(data): void;

Parameters

Parameter	Type
data	any

Returns

void

onDragNDropStarting()

onDragNDropStarting(data): void;

Parameters

Parameter	Type
data	any

Returns

void

onLayerTextureLoaded()

onLayerTextureLoaded(): void;

Returns

void

Implementation of

ICanvas.onLayerTextureLoaded

onScroll()

onScroll(): void;

Returns

void

onScroll()

onScroll(h): void;

Parameters

Parameter	Type
h	any

Returns

void

Implementation of

ICanvas.onScroll

onScroll()

onScroll(h): void;

Parameters

Parameter	Type
h	any

Returns

void

Implementation of

ICanvas.onScroll

onSelectionLocked()

onSelectionLocked(): void;

Returns

void

onSelectionLocked()

onSelectionLocked(handler): void;

Parameters

Parameter	Type
handler	(eventArg?) => any

Returns

void

Implementation of

ICanvas.onSelectionLocked

onSelectionLocked()

onSelectionLocked(handler): void;

Parameters

Parameter	Type
handler	(eventArg?) => any

Returns

void

Implementation of

ICanvas.onSelectionLocked

pauseRedraw()

pauseRedraw(): void;

Returns

void

Implementation of

ICanvas.pauseRedraw

pauseUpdateTexts()

pauseUpdateTexts(): void;

Returns

void

Implementation of

ICanvas.pauseUpdateTexts

ready()

ready(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

ready()

ready(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

redraw()

redraw(): void;

Returns

void

Implementation of

ICanvas.redraw

redrawActiveTexts()

redrawActiveTexts(): void;

Returns

void

Implementation of

ICanvas.redrawActiveTexts

redrawDesign()

redrawDesign(): void;

Returns

void

Implementation of

ICanvas.redrawDesign

redrawSelection()

redrawSelection(): void;

Returns

void

removePlaceholderButtonGroup()

removePlaceholderButtonGroup(placeholder): void;

Parameters

Parameter	Type
placeholder	PlaceholderItemHandler

Returns

void

Implementation of

ICanvas.removePlaceholderButtonGroup

removeSelectedItemHandler()

removeSelectedItemHandler(itemHandler): void;

Parameters

Parameter	Type
itemHandler	any

Returns

void

Implementation of

ICanvas.removeSelectedItemHandler

removeViolationContainer()

removeViolationContainer(handler): void;

Parameters

Parameter	Type
handler	BaseRectangleItemHandler

Returns

void

Implementation of

ICanvas.removeViolationContainer

resumeUpdateTexts()

resumeUpdateTexts(): void;

Returns

void

Implementation of

ICanvas.resumeUpdateTexts

selectedItemHandlerChanged()

selectedItemHandlerChanged(handler): void;

Parameters

Parameter	Type
handler	(canvas, itemHandler) => void

Returns

void

Implementation of

ICanvas.selectedItemHandlerChanged

selectedItemHandlerChanged()

selectedItemHandlerChanged(handler): void;

Parameters

Parameter	Type
handler	(canvas, itemHandler) => void

Returns

void

Implementation of

ICanvas.selectedItemHandlerChanged

setCursor()

setCursor(value, onBody): void;

Parameters

Parameter	Type
value	Cursor
onBody	boolean

Returns

void

Implementation of

ICanvas.setCursor

setSelectedItemHandlers()

setSelectedItemHandlers(itemHandlers): void;

Parameters

Parameter	Type
itemHandlers	BaseRectangleItemHandler[]

Returns

void

Implementation of

ICanvas.setSelectedItemHandlers

setTextWhizzModule()

setTextWhizzModule(textWhizz): void;

Parameters

Parameter	Type
textWhizz	any

Returns

void

setWorkspaceSize()

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

Parameters

Parameter	Type
width	number
height	number
updateButtonGroup?	boolean

Returns

void

setZoom()

setZoom(
   value, 
   preventEvent?, 
   options?): void;

Parameters

Parameter	Type
value	number
preventEvent?	boolean
options?	{ force?: boolean; fullUpdate?: boolean; updateButtonGroup?: boolean; }
options.force?	boolean
options.fullUpdate?	boolean
options.updateButtonGroup?	boolean

Returns

void

showDnd()

showDnd(point, image): void;

Parameters

Parameter	Type
point	PointF
image	HTMLImageElement

Returns

void

showHover()

showHover(item): void;

Parameters

Parameter	Type
item	Item

Returns

void

showSpotlight()

showSpotlight(items, options): void;

Parameters

Parameter	Type
items	Item[]
options	ISpotlightOptions

Returns

void

subscribeLimitsMessage()

subscribeLimitsMessage(): void;

Returns

void

Implementation of

ICanvas.subscribeLimitsMessage

unsubscribeLimitsMessage()

unsubscribeLimitsMessage(): void;

Returns

void

Implementation of

ICanvas.unsubscribeLimitsMessage

updateButtonGroups()

updateButtonGroups(options?): void;

Parameters

Parameter	Type
options	UpdateButtonGroupsOptions

Returns

void

Implementation of

ICanvas.updateButtonGroups

updatePlaceholderButtonGroup()

updatePlaceholderButtonGroup(placeholder): void;

Parameters

Parameter	Type
placeholder	| PlaceholderItemHandler | GroupItemHandler

Returns

void

Implementation of

ICanvas.updatePlaceholderButtonGroup

updatePlaceholderButtonGroupPosition()

updatePlaceholderButtonGroupPosition(placeholder): void;

Parameters

Parameter	Type
placeholder	PlaceholderItemHandler

Returns

void

Implementation of

ICanvas.updatePlaceholderButtonGroupPosition

updatePlaceholderButtonGroups()

updatePlaceholderButtonGroups(onlyVisible?): void;

Parameters

Parameter	Type	Default value
onlyVisible	boolean	false

Returns

void

Implementation of

ICanvas.updatePlaceholderButtonGroups

updateSelection()

updateSelection(force?): void;

Parameters

Parameter	Type	Default value
force	boolean	false

Returns

void

Implementation of

ICanvas.updateSelection

updateSpotlight()

updateSpotlight(items, options): void;

Parameters

Parameter	Type
items	Item[]
options	ISpotlightOptions

Returns

void

Deprecated

use showSpotlight()

updateTexts()

updateTexts(textToSkip?): void;

Parameters

Parameter	Type	Default value
textToSkip	any	null

Returns

void

Implementation of

ICanvas.updateTexts

updateViewport()

updateViewport(): void;

Returns

void

updateViolationContainer()

updateViolationContainer(itemHandler, updatePosition?): void;

Parameters

Parameter	Type	Default value
itemHandler	BaseRectangleItemHandler	undefined
updatePosition	boolean	false

Returns

void

Implementation of

ICanvas.updateViolationContainer

updateViolationContainerPosition()

updateViolationContainerPosition(itemHandler): void;

Parameters

Parameter	Type
itemHandler	BaseRectangleItemHandler

Returns

void

Implementation of

ICanvas.updateViolationContainerPosition

updateViolationContainers()

updateViolationContainers(updatePosition?, onlyVisible?): void;

Parameters

Parameter	Type	Default value
updatePosition	boolean	false
onlyVisible	boolean	false

Returns

void

Implementation of

ICanvas.updateViolationContainers

violationWarningButtonHitTestObject()

violationWarningButtonHitTestObject(pt): BaseRectangleItemHandler;

Parameters

Parameter	Type
pt	PointF

Returns

BaseRectangleItemHandler

Implementation of

ICanvas.violationWarningButtonHitTestObject

waitUpdate()

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

Parameters

Parameter	Type	Default value
itemHandlers	ItemHandler[]	null

Returns

Promise<void[]>

Implementation of

ICanvas.waitUpdate

workspaceSizeChanged()

workspaceSizeChanged(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

workspaceSizeChanged()

workspaceSizeChanged(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

workspaceToControl()

workspaceToControl(pt): any;

Parameters

Parameter	Type
pt	PointF

Returns

any

zoomChanged()

zoomChanged(h): void;

Parameters

Parameter	Type
h	any

Returns

void

Implementation of

ICanvas.zoomChanged

zoomChanged()

zoomChanged(h): void;

Parameters

Parameter	Type
h	any

Returns

void

Implementation of

ICanvas.zoomChanged