--- title: "Canvas | Customer's Canvas On-Premises" canonical: "https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/Canvas-1/" --- # Canvas > Represents the main host object containing a stack of layers. ## Classes ### Canvas This client-side class corresponds to the server-side class `Canvas` and provides access to its primary members in TypeScript. #### Implements - [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas) - [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource) #### Constructors ##### Constructor ```ts new Canvas(viewer): Canvas; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `viewer` | [`Viewer`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/Viewer-1.md#viewer) | ###### Returns [`Canvas`](#canvas) #### Properties ##### handlerFactory ```ts readonly handlerFactory: HandlerFactoryByItem; ``` ##### translations ```ts translations: Translations; ``` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`translations`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#translations) #### Accessors ##### activeTextCanvasHandler ###### Get Signature ```ts get activeTextCanvasHandler(): IActiveTextCanvasHandler; ``` ###### Returns [`IActiveTextCanvasHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/CanvasElementHandler.md#iactivetextcanvashandler) ##### autoPlaceholderEditModeEnabled ###### Get Signature ```ts get autoPlaceholderEditModeEnabled(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set autoPlaceholderEditModeEnabled(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ##### background ###### Get Signature ```ts get background(): string; ``` ###### Returns `string` ###### Set Signature ```ts set background(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ##### backgroundImage ###### Set Signature ```ts set backgroundImage(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `any` | ###### Returns `void` ##### badViolationIconCssClass ###### Get Signature ```ts get badViolationIconCssClass(): string; ``` ###### Returns `string` ###### Set Signature ```ts set badViolationIconCssClass(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`badViolationIconCssClass`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#badviolationiconcssclass) ##### bigButtonGroupCssClass ###### Get Signature ```ts get bigButtonGroupCssClass(): string; ``` ###### Returns `string` ###### Set Signature ```ts set bigButtonGroupCssClass(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`bigButtonGroupCssClass`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#bigbuttongroupcssclass) ##### bottomMargin ###### Get Signature ```ts get bottomMargin(): number; ``` ###### Returns `number` ###### Set Signature ```ts set bottomMargin(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `number` | ###### Returns `void` ##### canvasElementSize ###### Get Signature ```ts get canvasElementSize(): object; ``` ###### Returns `object` ###### height? ```ts optional height?: number; ``` ###### width? ```ts optional width?: number; ``` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`canvasElementSize`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#canvaselementsize) ##### canvasItemHoverEnabled ###### Get Signature ```ts get canvasItemHoverEnabled(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set canvasItemHoverEnabled(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ##### constrainedMarginEnabled ###### Get Signature ```ts get constrainedMarginEnabled(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set constrainedMarginEnabled(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `boolean` | ###### Returns `void` ##### contentAngle ###### Get Signature ```ts get contentAngle(): number; ``` ###### Returns `number` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`contentAngle`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#contentangle) ##### contentEditingPlaceholderItemHandler ###### Get Signature ```ts get contentEditingPlaceholderItemHandler(): PlaceholderItemHandler; ``` ###### Returns [`PlaceholderItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/PlaceholderItemHandler.md#placeholderitemhandler) ##### contentUpdatingPlaceholderItemHandler ###### Get Signature ```ts get contentUpdatingPlaceholderItemHandler(): PlaceholderItemHandler; ``` ###### Returns [`PlaceholderItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/PlaceholderItemHandler.md#placeholderitemhandler) ##### currentItemHandler ###### Get Signature ```ts get currentItemHandler(): BaseRectangleItemHandler; ``` ###### Returns [`BaseRectangleItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/BaseRectangleItemHandler.md#baserectangleitemhandler) ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`currentItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#currentitemhandler) ##### designAtomsApiClient ###### Get Signature ```ts get designAtomsApiClient(): IDesignAtomsApiClient; ``` ###### Returns [`IDesignAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IDesignAtomsApiClient.md#idesignatomsapiclient) ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`designAtomsApiClient`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#designatomsapiclient) ##### disableSmoothing ###### Get Signature ```ts get disableSmoothing(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set disableSmoothing(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`disableSmoothing`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#disablesmoothing) ##### dndHandler ###### Get Signature ```ts get dndHandler(): DragNDropHandler; ``` ###### Returns [`DragNDropHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/DragNDropHandler.md#dragndrophandler) ##### doneButtonCssClass ###### Get Signature ```ts get doneButtonCssClass(): string; ``` ###### Returns `string` ###### Set Signature ```ts set doneButtonCssClass(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`doneButtonCssClass`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#donebuttoncssclass) ##### errorInput ###### Get Signature ```ts get errorInput(): boolean; ``` ###### Returns `boolean` ##### floatingToolbarManager ###### Get Signature ```ts get floatingToolbarManager(): FloatingToolbarManager; ``` ###### Returns [`FloatingToolbarManager`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/FloatingToolbarManager.md#floatingtoolbarmanager) ##### fontRegistry ###### Get Signature ```ts get fontRegistry(): FontRegistry; ``` ###### Returns [`FontRegistry`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/FontRegistry.md#fontregistry) ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`fontRegistry`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#fontregistry) ##### frontEndTextRenderingEnabled ###### Get Signature ```ts get frontEndTextRenderingEnabled(): boolean; ``` ###### Returns `boolean` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`frontEndTextRenderingEnabled`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#frontendtextrenderingenabled) ##### goodViolationIconCssClass ###### Get Signature ```ts get goodViolationIconCssClass(): string; ``` ###### Returns `string` ###### Set Signature ```ts set goodViolationIconCssClass(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`goodViolationIconCssClass`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#goodviolationiconcssclass) ##### handleButtonCssClass ###### Get Signature ```ts get handleButtonCssClass(): string; ``` ###### Returns `string` ###### Set Signature ```ts set handleButtonCssClass(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`handleButtonCssClass`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#handlebuttoncssclass) ##### height ###### Get Signature ```ts get height(): number; ``` ###### Returns `number` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`height`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#height) ##### hiddenFieldID ###### Get Signature ```ts get hiddenFieldID(): string; ``` ###### Returns `string` ###### Set Signature ```ts set hiddenFieldID(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ##### history ###### Get Signature ```ts get history(): History; ``` ###### Returns [`History`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/History.md#history) ###### Set Signature ```ts set history(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | [`History`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/History.md#history) | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`history`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#history) ##### hitTestManager ###### Get Signature ```ts get hitTestManager(): HitTestManager; ``` ###### Returns [`HitTestManager`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/HitTestManager.md#hittestmanager) ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`hitTestManager`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#hittestmanager) ##### hoverColor ###### Get Signature ```ts get hoverColor(): string; ``` ###### Returns `string` ###### Set Signature ```ts set hoverColor(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ##### hoverHandler ###### Get Signature ```ts get hoverHandler(): HoverHandler; ``` ###### Returns [`HoverHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/HoverHandler.md#hoverhandler) ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`hoverHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#hoverhandler) ##### ignorePermissionsMode ###### Get Signature ```ts get ignorePermissionsMode(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set ignorePermissionsMode(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`ignorePermissionsMode`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#ignorepermissionsmode) ##### initialization ###### Get Signature ```ts get initialization(): boolean; ``` ###### Returns `boolean` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`initialization`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#initialization) ##### inPlaceEditingHandler ###### Get Signature ```ts get inPlaceEditingHandler(): NewBaseTextItemHandler; ``` ###### Returns [`NewBaseTextItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/NewBaseTextItemHandler.md#abstract-newbasetextitemhandler) ##### isInitialized ###### Get Signature ```ts get isInitialized(): boolean; ``` ###### Returns `boolean` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`isInitialized`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#isinitialized) ##### isSelectionDragging ###### Get Signature ```ts get isSelectionDragging(): boolean; ``` ###### Returns `boolean` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`isSelectionDragging`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#isselectiondragging) ##### isSelectionIdle ###### Get Signature ```ts get isSelectionIdle(): boolean; ``` ###### Returns `boolean` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`isSelectionIdle`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#isselectionidle) ##### isSelectionLocked ###### Get Signature ```ts get isSelectionLocked(): boolean; ``` ###### Returns `boolean` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`isSelectionLocked`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#isselectionlocked) ##### isSelectionResizing ###### Get Signature ```ts get isSelectionResizing(): boolean; ``` ###### Returns `boolean` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`isSelectionResizing`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#isselectionresizing) ##### isSelectionRotating ###### Get Signature ```ts get isSelectionRotating(): boolean; ``` ###### Returns `boolean` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`isSelectionRotating`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#isselectionrotating) ##### isUpdating ###### Get Signature ```ts get isUpdating(): boolean; ``` ###### Returns `boolean` ##### keyEventEnabled ###### Get Signature ```ts get keyEventEnabled(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set keyEventEnabled(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `boolean` | ###### Returns `void` ##### lastLimitsEvent ###### Get Signature ```ts get lastLimitsEvent(): ILimitsViolationEventData; ``` ###### Returns [ILimitsViolationEventData](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms-text/ILimitsViolationEventData.md) ##### layers ###### Get Signature ```ts get layers(): LayerCollection; ``` ###### Returns [`LayerCollection`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/LayerCollection.md#layercollection) ###### Set Signature ```ts set layers(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | [`LayerCollection`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/LayerCollection.md#layercollection) | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`layers`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#layers) ##### leftMargin ###### Get Signature ```ts get leftMargin(): number; ``` ###### Returns `number` ###### Set Signature ```ts set leftMargin(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `number` | ###### Returns `void` ##### margin ###### Get Signature ```ts get margin(): number; ``` ###### Returns `number` ###### Set Signature ```ts set margin(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `number` | ###### Returns `void` ##### marginColor ###### Get Signature ```ts get marginColor(): string; ``` ###### Returns `string` ###### Set Signature ```ts set marginColor(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `string` | ###### Returns `void` ##### marginWidth ###### Get Signature ```ts get marginWidth(): number; ``` ###### Returns `number` ###### Set Signature ```ts set marginWidth(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `number` | ###### Returns `void` ##### maxFontSize ###### Get Signature ```ts get maxFontSize(): number; ``` ###### Returns `number` ###### Set Signature ```ts set maxFontSize(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `number` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`maxFontSize`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#maxfontsize) ##### maxLeading ###### Get Signature ```ts get maxLeading(): number; ``` ###### Returns `number` ###### Set Signature ```ts set maxLeading(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `number` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`maxLeading`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#maxleading) ##### minFontSize ###### Get Signature ```ts get minFontSize(): number; ``` ###### Returns `number` ###### Set Signature ```ts set minFontSize(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `number` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`minFontSize`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#minfontsize) ##### minLeading ###### Get Signature ```ts get minLeading(): number; ``` ###### Returns `number` ###### Set Signature ```ts set minLeading(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `number` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`minLeading`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#minleading) ##### mouseMoveTimeout ###### Get Signature ```ts get mouseMoveTimeout(): number; ``` ###### Returns `number` ###### Set Signature ```ts set mouseMoveTimeout(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `number` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`mouseMoveTimeout`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#mousemovetimeout) ##### mul ###### Get Signature ```ts get mul(): number; ``` ###### Returns `number` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`mul`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#mul) ##### multipleSelectionEnabled ###### Get Signature ```ts get multipleSelectionEnabled(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set multipleSelectionEnabled(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`multipleSelectionEnabled`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#multipleselectionenabled) ##### offset ###### Get Signature ```ts get offset(): PointF; ``` ###### Returns `PointF` ###### Set Signature ```ts set offset(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `PointF` | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`offset`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#offset) ##### parentElement ###### Get Signature ```ts get parentElement(): HTMLElement; ``` ###### Returns `HTMLElement` ##### placeholderButtonGroupCssClass ###### Get Signature ```ts get placeholderButtonGroupCssClass(): string; ``` ###### Returns `string` ###### Set Signature ```ts set placeholderButtonGroupCssClass(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`placeholderButtonGroupCssClass`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#placeholderbuttongroupcssclass) ##### previewMode ###### Get Signature ```ts get previewMode(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set previewMode(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`previewMode`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#previewmode) ##### productHandler ###### Get Signature ```ts get productHandler(): ProductHandler; ``` ###### Returns [`ProductHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ProductHandler.md#producthandler) ##### qualityBadToGoodChangeScaleBarCssClass ###### Get Signature ```ts get qualityBadToGoodChangeScaleBarCssClass(): string; ``` ###### Returns `string` ###### Set Signature ```ts set qualityBadToGoodChangeScaleBarCssClass(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`qualityBadToGoodChangeScaleBarCssClass`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#qualitybadtogoodchangescalebarcssclass) ##### qualityBadToWarningChangeScaleBarCssClass ###### Get Signature ```ts get qualityBadToWarningChangeScaleBarCssClass(): string; ``` ###### Returns `string` ###### Set Signature ```ts set qualityBadToWarningChangeScaleBarCssClass(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`qualityBadToWarningChangeScaleBarCssClass`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#qualitybadtowarningchangescalebarcssclass) ##### qualityChangeContainerCssClass ###### Get Signature ```ts get qualityChangeContainerCssClass(): string; ``` ###### Returns `string` ###### Set Signature ```ts set qualityChangeContainerCssClass(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`qualityChangeContainerCssClass`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#qualitychangecontainercssclass) ##### qualityChangeContainersEnabled ###### Get Signature ```ts get qualityChangeContainersEnabled(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set qualityChangeContainersEnabled(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `boolean` | ###### Returns `void` ##### qualityChangeInfoBarCssClass ###### Get Signature ```ts get qualityChangeInfoBarCssClass(): string; ``` ###### Returns `string` ###### Set Signature ```ts set qualityChangeInfoBarCssClass(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`qualityChangeInfoBarCssClass`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#qualitychangeinfobarcssclass) ##### qualityChangeScaleBarCssClass ###### Get Signature ```ts get qualityChangeScaleBarCssClass(): string; ``` ###### Returns `string` ###### Set Signature ```ts set qualityChangeScaleBarCssClass(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`qualityChangeScaleBarCssClass`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#qualitychangescalebarcssclass) ##### qualityNoAnimationChangeScaleBarCssClass ###### Get Signature ```ts get qualityNoAnimationChangeScaleBarCssClass(): string; ``` ###### Returns `string` ###### Set Signature ```ts set qualityNoAnimationChangeScaleBarCssClass(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`qualityNoAnimationChangeScaleBarCssClass`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#qualitynoanimationchangescalebarcssclass) ##### qualityWarningToGoodChangeScaleBarCssClass ###### Get Signature ```ts get qualityWarningToGoodChangeScaleBarCssClass(): string; ``` ###### Returns `string` ###### Set Signature ```ts set qualityWarningToGoodChangeScaleBarCssClass(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`qualityWarningToGoodChangeScaleBarCssClass`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#qualitywarningtogoodchangescalebarcssclass) ##### readonlyCanvasMode ###### Get Signature ```ts get readonlyCanvasMode(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set readonlyCanvasMode(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ##### ready ###### Get Signature ```ts get ready(): boolean; ``` ###### Returns `boolean` ##### renderingConfigProvider ###### Get Signature ```ts get renderingConfigProvider(): IRenderingConfigProvider; ``` ###### Returns [`IRenderingConfigProvider`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IRenderingConfigProvider.md#irenderingconfigprovider) ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`renderingConfigProvider`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#renderingconfigprovider) ##### resizeGripColor ###### Get Signature ```ts get resizeGripColor(): string; ``` ###### Returns `string` ###### Set Signature ```ts set resizeGripColor(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`resizeGripColor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#resizegripcolor) ##### resizeGripLineColor ###### Get Signature ```ts get resizeGripLineColor(): string; ``` ###### Returns `string` ###### Set Signature ```ts set resizeGripLineColor(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`resizeGripLineColor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#resizegriplinecolor) ##### resizeGripSize ###### Get Signature ```ts get resizeGripSize(): number; ``` ###### Returns `number` ###### Set Signature ```ts set resizeGripSize(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `number` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`resizeGripSize`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#resizegripsize) ##### rightMargin ###### Get Signature ```ts get rightMargin(): number; ``` ###### Returns `number` ###### Set Signature ```ts set rightMargin(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `number` | ###### Returns `void` ##### rotateHandler ###### Get Signature ```ts get rotateHandler(): RotateHandler; ``` ###### Returns [`RotateHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/RotateHandler.md#rotatehandler) ##### rotationGripColor ###### Get Signature ```ts get rotationGripColor(): string; ``` ###### Returns `string` ###### Set Signature ```ts set rotationGripColor(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`rotationGripColor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#rotationgripcolor) ##### rotationGripLineColor ###### Get Signature ```ts get rotationGripLineColor(): string; ``` ###### Returns `string` ###### Set Signature ```ts set rotationGripLineColor(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`rotationGripLineColor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#rotationgriplinecolor) ##### rotationGripLineLength ###### Get Signature ```ts get rotationGripLineLength(): number; ``` ###### Returns `number` ###### Set Signature ```ts set rotationGripLineLength(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `number` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`rotationGripLineLength`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#rotationgriplinelength) ##### rotationGripSize ###### Get Signature ```ts get rotationGripSize(): number; ``` ###### Returns `number` ###### Set Signature ```ts set rotationGripSize(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `number` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`rotationGripSize`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#rotationgripsize) ##### rubberbandHandler ###### Get Signature ```ts get rubberbandHandler(): RubberbandHandler; ``` ###### Returns [`RubberbandHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/RubberbandHandler.md#rubberbandhandler) ##### selectBarcodeButtonCssClass ###### Get Signature ```ts get selectBarcodeButtonCssClass(): string; ``` ###### Returns `string` ###### Set Signature ```ts set selectBarcodeButtonCssClass(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ##### selectedHandler ###### Get Signature ```ts get selectedHandler(): any; ``` ###### Returns `any` ##### selectedPlaceholderItemHandler ###### Get Signature ```ts get selectedPlaceholderItemHandler(): PlaceholderItemHandler; ``` ###### Returns [`PlaceholderItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/PlaceholderItemHandler.md#placeholderitemhandler) ##### selectImageButtonCssClass ###### Get Signature ```ts get selectImageButtonCssClass(): string; ``` ###### Returns `string` ###### Set Signature ```ts set selectImageButtonCssClass(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ##### selection ###### Get Signature ```ts get selection(): SelectionHandler; ``` ###### Returns [`SelectionHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/SelectionHandler.md#selectionhandler) ##### selectionColor ###### Get Signature ```ts get selectionColor(): string; ``` ###### Returns `string` ###### Set Signature ```ts set selectionColor(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`selectionColor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#selectioncolor) ##### selectionVisibleRectangle ###### Get Signature ```ts get selectionVisibleRectangle(): any; ``` ###### Returns `any` ##### selectionWidth ###### Get Signature ```ts get selectionWidth(): number; ``` ###### Returns `number` ###### Set Signature ```ts set selectionWidth(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `number` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`selectionWidth`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#selectionwidth) ##### service ###### Get Signature ```ts get service(): Service; ``` ###### Returns [`Service`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/Service.md#service) ###### Set Signature ```ts set service(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | [`Service`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/Service.md#service) | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`service`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#service) ##### simpleMode ###### Get Signature ```ts get simpleMode(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set simpleMode(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ##### snapLinesHandler ###### Get Signature ```ts get snapLinesHandler(): SnapLinesHandler; ``` ###### Returns [`SnapLinesHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/SnapLinesHandler.md#snaplineshandler) ##### status ###### Get Signature ```ts get status(): UpdateStatus; ``` ###### Returns [`UpdateStatus`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/UpdateStatus.md#updatestatus) ##### style ###### Get Signature ```ts get style(): CanvasRendererStyle; ``` ###### Returns [`CanvasRendererStyle`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/CanvasRendererStyle.md#canvasrendererstyle) ###### Set Signature ```ts set style(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | [`CanvasRendererStyle`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/CanvasRendererStyle.md#canvasrendererstyle) | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`style`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#style) ##### suppressFocusManagement ###### Get Signature ```ts get suppressFocusManagement(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set suppressFocusManagement(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `boolean` | ###### Returns `void` ##### suppressOutOfRegionManipulation ###### Get Signature ```ts get suppressOutOfRegionManipulation(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set suppressOutOfRegionManipulation(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `boolean` | ###### Returns `void` ##### surfaceCanvas ###### Get Signature ```ts get surfaceCanvas(): HTMLCanvasElement; ``` ###### Returns `HTMLCanvasElement` ##### tags ###### Get Signature ```ts get tags(): any; ``` Gets an object containing numbers of lines, rectangles, ellipses, texts, images. ###### Returns `any` ###### Set Signature ```ts 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`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`tags`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#tags) ##### targetDpi ###### Get Signature ```ts get targetDpi(): number; ``` ###### Returns `number` ###### Set Signature ```ts set targetDpi(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `number` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`targetDpi`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#targetdpi) ##### textEditor ###### Get Signature ```ts get textEditor(): ITextEditor; ``` ###### Returns [ITextEditor](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ITextEditor.md) ###### Set Signature ```ts set textEditor(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | [ITextEditor](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ITextEditor.md) | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`textEditor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#texteditor) ##### textInputIssueUserConfirmationDelegate ###### Get Signature ```ts get textInputIssueUserConfirmationDelegate(): Func, string>; ``` ###### Returns `Func`\<[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`boolean`\>, `string`\> ##### textRenderer ###### Get Signature ```ts get textRenderer(): TextRenderer; ``` ###### Returns [`TextRenderer`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/TextRenderer.md#abstract-textrenderer) ##### textWhizz ###### Get Signature ```ts get textWhizz(): any; ``` ###### Returns `any` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`textWhizz`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#textwhizz) ##### topMargin ###### Get Signature ```ts get topMargin(): number; ``` ###### Returns `number` ###### Set Signature ```ts set topMargin(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `number` | ###### Returns `void` ##### viewer ###### Get Signature ```ts get viewer(): Viewer; ``` ###### Returns [`Viewer`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/Viewer-1.md#viewer) ##### viewerConfiguration ###### Get Signature ```ts get viewerConfiguration(): IViewerConfiguration; ``` ###### Returns [`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration) ###### Set Signature ```ts set viewerConfiguration(config): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `config` | [`IViewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IViewerConfiguration.md#iviewerconfiguration) | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`viewerConfiguration`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#viewerconfiguration) ##### violationContainerCssClass ###### Get Signature ```ts get violationContainerCssClass(): string; ``` ###### Returns `string` ###### Set Signature ```ts set violationContainerCssClass(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`violationContainerCssClass`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#violationcontainercssclass) ##### violationService ###### Set Signature ```ts set violationService(service): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `service` | [`ViolationService`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ViolationService-1.md#violationservice) | ###### Returns `void` ##### violationWarningButtonCssClass ###### Get Signature ```ts get violationWarningButtonCssClass(): string; ``` ###### Returns `string` ###### Set Signature ```ts set violationWarningButtonCssClass(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`violationWarningButtonCssClass`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#violationwarningbuttoncssclass) ##### violationWarningButtonsEnabled ###### Get Signature ```ts get violationWarningButtonsEnabled(): boolean; ``` ###### Returns `boolean` ###### Set Signature ```ts set violationWarningButtonsEnabled(v): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `v` | `boolean` | ###### Returns `void` ##### warningViolationIconCssClass ###### Get Signature ```ts get warningViolationIconCssClass(): string; ``` ###### Returns `string` ###### Set Signature ```ts set warningViolationIconCssClass(value): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | `string` | ###### Returns `void` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`warningViolationIconCssClass`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#warningviolationiconcssclass) ##### width ###### Get Signature ```ts get width(): number; ``` ###### Returns `number` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`width`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#width) ##### workspace ###### Get Signature ```ts get workspace(): IWorkspace; ``` ###### Returns [`IWorkspace`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IWorkspace.md#iworkspace) ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`workspace`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#workspace) ##### workspaceHeight ###### Get Signature ```ts get workspaceHeight(): number; ``` ###### Returns `number` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`workspaceHeight`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#workspaceheight) ##### workspaceWidth ###### Get Signature ```ts get workspaceWidth(): number; ``` ###### Returns `number` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`workspaceWidth`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#workspacewidth) ##### zoom ###### Get Signature ```ts get zoom(): number; ``` ###### Returns `number` ###### Implementation of [`ICanvasDataSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#icanvasdatasource).[`zoom`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvasDataSource.md#zoom) #### Methods ##### addElement() ```ts addElement(parentElement): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `parentElement` | `HTMLElement` \| `ChildNode` | ###### Returns `void` ##### addPlaceholderButtonGroup() ```ts addPlaceholderButtonGroup(placeholder): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `placeholder` | [`PlaceholderItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/PlaceholderItemHandler.md#placeholderitemhandler) | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`addPlaceholderButtonGroup`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#addplaceholderbuttongroup) ##### addSelectedItemHandler() ```ts addSelectedItemHandler(itemHandler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `itemHandler` | `any` | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`addSelectedItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#addselecteditemhandler) ##### addStyles() ```ts addStyles(): void; ``` ###### Returns `void` ##### addViewport() ```ts addViewport(viewportElement): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `viewportElement` | `HTMLDivElement` | ###### Returns `void` ##### addViolationContainer() ```ts addViolationContainer(itemHandler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `itemHandler` | [`BaseRectangleItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/BaseRectangleItemHandler.md#baserectangleitemhandler) | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`addViolationContainer`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#addviolationcontainer) ##### afterReplaceItemHandler() ```ts afterReplaceItemHandler(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | (`eventArg?`) => `any` | ###### Returns `void` ##### afterReplaceItemHandler() ```ts afterReplaceItemHandler(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | (`eventArg?`) => `any` | ###### Returns `void` ##### beforeReplaceItemHandler() ```ts beforeReplaceItemHandler(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | (`eventArg?`) => `any` | ###### Returns `void` ##### beforeReplaceItemHandler() ```ts beforeReplaceItemHandler(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | (`eventArg?`) => `any` | ###### Returns `void` ##### calcPlatformLimitZoom() ```ts calcPlatformLimitZoom(): number; ``` ###### Returns `number` ##### changeTextEditorDivOutlineColor() ```ts changeTextEditorDivOutlineColor(toRed): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `toRed` | `boolean` | ###### Returns `void` ##### checkReady() ```ts checkReady(): void; ``` ###### Returns `void` ##### clearSelectedItemHandlers() ```ts clearSelectedItemHandlers(): void; ``` ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`clearSelectedItemHandlers`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#clearselecteditemhandlers) ##### clearTextCursor() ```ts clearTextCursor(): void; ``` ###### Returns `void` ##### continueRedraw() ```ts continueRedraw(): void; ``` ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`continueRedraw`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#continueredraw) ##### controlToWorkspace() ```ts controlToWorkspace(pt): any; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `pt` | `PointF` | ###### Returns `any` ##### currentItemHandlerChanged() ```ts currentItemHandlerChanged(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | (`itemHandler`) => `void` | ###### Returns `void` ##### currentItemHandlerChanged() ```ts currentItemHandlerChanged(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | (`itemHandler`) => `void` | ###### Returns `void` ##### deleteItemHandler() ```ts deleteItemHandler(itemHandler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `itemHandler` | [`ItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ItemHandler.md#itemhandler) | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`deleteItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#deleteitemhandler) ##### deleteSelectedItemHandlers() ```ts deleteSelectedItemHandlers(force?): void; ``` ###### Parameters | Parameter | Type | Default value | | ------ | ------ | ------ | | `force` | `boolean` | `false` | ###### Returns `void` ##### disableSelection() ```ts disableSelection(): void; ``` ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`disableSelection`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#disableselection) ##### dispose() ```ts dispose(): void; ``` ###### Returns `void` ##### doesContainItem() ```ts doesContainItem(item): boolean; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `item` | `Item` | ###### Returns `boolean` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`doesContainItem`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#doescontainitem) ##### dragNDropDone() ```ts dragNDropDone(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | (`canvas`, `itemHandler`) => `void` | ###### Returns `void` ##### dragNDropDone() ```ts dragNDropDone(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | `any` | ###### Returns `void` ##### dragNDropPerformed() ```ts dragNDropPerformed(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | `any` | ###### Returns `void` ##### dragNDropPerformed() ```ts dragNDropPerformed(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | `any` | ###### Returns `void` ##### dragNDropStarting() ```ts dragNDropStarting(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | `any` | ###### Returns `void` ##### dragNDropStarting() ```ts dragNDropStarting(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | `any` | ###### Returns `void` ##### drawTextCursor() ```ts drawTextCursor(callback): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `callback` | (`context`) => `void` | ###### Returns `void` ##### drawWaitClock() ```ts drawWaitClock(context, center): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `context` | `CanvasRenderingContext2D` | | `center` | `PointF` | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`drawWaitClock`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#drawwaitclock) ##### enableSelection() ```ts enableSelection(): void; ``` ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`enableSelection`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#enableselection) ##### ensureFocus() ```ts ensureFocus(): void; ``` ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`ensureFocus`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#ensurefocus) ##### getAllItemHandlers() ```ts getAllItemHandlers(options?): ItemHandler[]; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `options?` | [`GetItemHandlersOptions`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#getitemhandlersoptions) | ###### Returns [`ItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ItemHandler.md#itemhandler)[] ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`getAllItemHandlers`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#getallitemhandlers) ##### getButtonGroupRectInGripsDiv() ```ts getButtonGroupRectInGripsDiv(div, ignoreRotate?): any; ``` ###### Parameters | Parameter | Type | Default value | | ------ | ------ | ------ | | `div` | `HTMLElement` | `undefined` | | `ignoreRotate` | `boolean` | `false` | ###### Returns `any` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`getButtonGroupRectInGripsDiv`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#getbuttongrouprectingripsdiv) ##### getData() ```ts getData(forService?, layerId?): CanvasData; ``` ###### Parameters | Parameter | Type | Default value | | ------ | ------ | ------ | | `forService` | `boolean` | `false` | | `layerId` | `any` | `null` | ###### Returns [`CanvasData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/CanvasData.md#canvasdata) ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`getData`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#getdata) ##### getItemHandler() ```ts getItemHandler(item): THandler; ``` ###### Type Parameters | Type Parameter | | ------ | | `THandler` *extends* [`ItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ItemHandler.md#itemhandler) | ###### Parameters | Parameter | Type | | ------ | ------ | | `item` | `Item` | ###### Returns `THandler` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`getItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#getitemhandler) ##### getSelectedItemHandlers() ```ts getSelectedItemHandlers(): Collection; ``` ###### Returns `Collection`\<[`ItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ItemHandler.md#itemhandler)\> ##### hideDnd() ```ts hideDnd(): void; ``` ###### Returns `void` ##### hideHover() ```ts hideHover(): void; ``` ###### Returns `void` ##### hideSpotlight() ```ts hideSpotlight(items?): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `items?` | `Item`[] | ###### Returns `void` ##### initialize() ```ts initialize(): void; ``` ###### Returns `void` ##### initialized() ```ts initialized(h): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `h` | `any` | ###### Returns `void` ##### initialized() ```ts initialized(h): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `h` | `any` | ###### Returns `void` ##### initTextEditor() ```ts initTextEditor( textEditor, fontService, useSimpleFontList, textInputIssueUserConfirmationDelegate): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `textEditor` | [`TextEditorMode`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ITextParams.md#texteditormode) | | `fontService` | [`IFontService`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/IFontService.md#ifontservice) | | `useSimpleFontList` | `boolean` | | `textInputIssueUserConfirmationDelegate` | `Func`\<[`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`boolean`\>, `string`\> | ###### Returns `void` ##### isDragSource() ```ts isDragSource(itemHandler): boolean; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `itemHandler` | [`ItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ItemHandler.md#itemhandler) | ###### Returns `boolean` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`isDragSource`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#isdragsource) ##### isDragTarget() ```ts isDragTarget(itemHandler): boolean; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `itemHandler` | [`ItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ItemHandler.md#itemhandler) | ###### Returns `boolean` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`isDragTarget`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#isdragtarget) ##### isItemHandlerSelected() ```ts isItemHandlerSelected(itemHandler): any; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `itemHandler` | `any` | ###### Returns `any` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`isItemHandlerSelected`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#isitemhandlerselected) ##### isOnlyThisItemHandlerSelected() ```ts isOnlyThisItemHandlerSelected(itemHandler): boolean; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `itemHandler` | `any` | ###### Returns `boolean` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`isOnlyThisItemHandlerSelected`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#isonlythisitemhandlerselected) ##### isSelectionByHitTest() ```ts isSelectionByHitTest(pt): boolean; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `pt` | `PointF` | ###### Returns `boolean` ##### layersUpdated() ```ts layersUpdated(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | `any` | ###### Returns `void` ##### layersUpdated() ```ts layersUpdated(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | `any` | ###### Returns `void` ##### onDragNDropDone() ```ts onDragNDropDone(): void; ``` ###### Returns `void` ##### onDragNDropPerformed() ```ts onDragNDropPerformed(data): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `data` | `any` | ###### Returns `void` ##### onDragNDropStarting() ```ts onDragNDropStarting(data): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `data` | `any` | ###### Returns `void` ##### onLayerTextureLoaded() ```ts onLayerTextureLoaded(): void; ``` ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`onLayerTextureLoaded`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#onlayertextureloaded) ##### onScroll() ```ts onScroll(): void; ``` ###### Returns `void` ##### onScroll() ```ts onScroll(h): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `h` | `any` | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`onScroll`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#onscroll) ##### onScroll() ```ts onScroll(h): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `h` | `any` | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`onScroll`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#onscroll-1) ##### onSelectionLocked() ```ts onSelectionLocked(): void; ``` ###### Returns `void` ##### onSelectionLocked() ```ts onSelectionLocked(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | (`eventArg?`) => `any` | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`onSelectionLocked`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#onselectionlocked) ##### onSelectionLocked() ```ts onSelectionLocked(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | (`eventArg?`) => `any` | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`onSelectionLocked`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#onselectionlocked-1) ##### pauseRedraw() ```ts pauseRedraw(): void; ``` ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`pauseRedraw`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#pauseredraw) ##### pauseUpdateTexts() ```ts pauseUpdateTexts(): void; ``` ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`pauseUpdateTexts`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#pauseupdatetexts) ##### ready() ```ts ready(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | `any` | ###### Returns `void` ##### ready() ```ts ready(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | `any` | ###### Returns `void` ##### redraw() ```ts redraw(): void; ``` ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`redraw`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#redraw) ##### redrawActiveTexts() ```ts redrawActiveTexts(): void; ``` ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`redrawActiveTexts`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#redrawactivetexts) ##### redrawDesign() ```ts redrawDesign(): void; ``` ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`redrawDesign`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#redrawdesign) ##### redrawSelection() ```ts redrawSelection(): void; ``` ###### Returns `void` ##### removePlaceholderButtonGroup() ```ts removePlaceholderButtonGroup(placeholder): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `placeholder` | [`PlaceholderItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/PlaceholderItemHandler.md#placeholderitemhandler) | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`removePlaceholderButtonGroup`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#removeplaceholderbuttongroup) ##### removeSelectedItemHandler() ```ts removeSelectedItemHandler(itemHandler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `itemHandler` | `any` | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`removeSelectedItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#removeselecteditemhandler) ##### removeViolationContainer() ```ts removeViolationContainer(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | [`BaseRectangleItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/BaseRectangleItemHandler.md#baserectangleitemhandler) | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`removeViolationContainer`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#removeviolationcontainer) ##### resumeUpdateTexts() ```ts resumeUpdateTexts(): void; ``` ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`resumeUpdateTexts`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#resumeupdatetexts) ##### selectedItemHandlerChanged() ```ts selectedItemHandlerChanged(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | (`canvas`, `itemHandler`) => `void` | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`selectedItemHandlerChanged`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#selecteditemhandlerchanged) ##### selectedItemHandlerChanged() ```ts selectedItemHandlerChanged(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | (`canvas`, `itemHandler`) => `void` | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`selectedItemHandlerChanged`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#selecteditemhandlerchanged-1) ##### setCursor() ```ts setCursor(value, onBody): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `value` | [`Cursor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/Common.md#cursor) | | `onBody` | `boolean` | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`setCursor`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#setcursor) ##### setSelectedItemHandlers() ```ts setSelectedItemHandlers(itemHandlers): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `itemHandlers` | [`BaseRectangleItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/BaseRectangleItemHandler.md#baserectangleitemhandler)[] | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`setSelectedItemHandlers`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#setselecteditemhandlers) ##### setTextWhizzModule() ```ts setTextWhizzModule(textWhizz): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `textWhizz` | `any` | ###### Returns `void` ##### setWorkspaceSize() ```ts setWorkspaceSize( width, height, updateButtonGroup?): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `width` | `number` | | `height` | `number` | | `updateButtonGroup?` | `boolean` | ###### Returns `void` ##### setZoom() ```ts 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() ```ts showDnd(point, image): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `point` | `PointF` | | `image` | `HTMLImageElement` | ###### Returns `void` ##### showHover() ```ts showHover(item): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `item` | `Item` | ###### Returns `void` ##### showSpotlight() ```ts showSpotlight(items, options): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `items` | `Item`[] | | `options` | [`ISpotlightOptions`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ISpotlightOptions.md#ispotlightoptions) | ###### Returns `void` ##### subscribeLimitsMessage() ```ts subscribeLimitsMessage(): void; ``` ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`subscribeLimitsMessage`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#subscribelimitsmessage) ##### unsubscribeLimitsMessage() ```ts unsubscribeLimitsMessage(): void; ``` ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`unsubscribeLimitsMessage`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#unsubscribelimitsmessage) ##### updateButtonGroups() ```ts updateButtonGroups(options?): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `options` | [`UpdateButtonGroupsOptions`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/UpdateButtonGroupsOptions.md#updatebuttongroupsoptions) | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`updateButtonGroups`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#updatebuttongroups) ##### updatePlaceholderButtonGroup() ```ts updatePlaceholderButtonGroup(placeholder): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `placeholder` | \| [`PlaceholderItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/PlaceholderItemHandler.md#placeholderitemhandler) \| [`GroupItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/GroupItemHandler.md#groupitemhandler) | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`updatePlaceholderButtonGroup`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#updateplaceholderbuttongroup) ##### updatePlaceholderButtonGroupPosition() ```ts updatePlaceholderButtonGroupPosition(placeholder): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `placeholder` | [`PlaceholderItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/PlaceholderItemHandler.md#placeholderitemhandler) | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`updatePlaceholderButtonGroupPosition`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#updateplaceholderbuttongroupposition) ##### updatePlaceholderButtonGroups() ```ts updatePlaceholderButtonGroups(onlyVisible?): void; ``` ###### Parameters | Parameter | Type | Default value | | ------ | ------ | ------ | | `onlyVisible` | `boolean` | `false` | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`updatePlaceholderButtonGroups`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#updateplaceholderbuttongroups) ##### updateSelection() ```ts updateSelection(force?): void; ``` ###### Parameters | Parameter | Type | Default value | | ------ | ------ | ------ | | `force` | `boolean` | `false` | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`updateSelection`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#updateselection) ##### ~~updateSpotlight()~~ ```ts updateSpotlight(items, options): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `items` | `Item`[] | | `options` | [`ISpotlightOptions`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ISpotlightOptions.md#ispotlightoptions) | ###### Returns `void` ###### Deprecated use showSpotlight() ##### updateTexts() ```ts updateTexts(textToSkip?): void; ``` ###### Parameters | Parameter | Type | Default value | | ------ | ------ | ------ | | `textToSkip` | `any` | `null` | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`updateTexts`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#updatetexts) ##### updateViewport() ```ts updateViewport(): void; ``` ###### Returns `void` ##### updateViolationContainer() ```ts updateViolationContainer(itemHandler, updatePosition?): void; ``` ###### Parameters | Parameter | Type | Default value | | ------ | ------ | ------ | | `itemHandler` | [`BaseRectangleItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/BaseRectangleItemHandler.md#baserectangleitemhandler) | `undefined` | | `updatePosition` | `boolean` | `false` | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`updateViolationContainer`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#updateviolationcontainer) ##### updateViolationContainerPosition() ```ts updateViolationContainerPosition(itemHandler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `itemHandler` | [`BaseRectangleItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/BaseRectangleItemHandler.md#baserectangleitemhandler) | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`updateViolationContainerPosition`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#updateviolationcontainerposition) ##### updateViolationContainers() ```ts updateViolationContainers(updatePosition?, onlyVisible?): void; ``` ###### Parameters | Parameter | Type | Default value | | ------ | ------ | ------ | | `updatePosition` | `boolean` | `false` | | `onlyVisible` | `boolean` | `false` | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`updateViolationContainers`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#updateviolationcontainers) ##### violationWarningButtonHitTestObject() ```ts violationWarningButtonHitTestObject(pt): BaseRectangleItemHandler; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `pt` | `PointF` | ###### Returns [`BaseRectangleItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/BaseRectangleItemHandler.md#baserectangleitemhandler) ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`violationWarningButtonHitTestObject`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#violationwarningbuttonhittestobject) ##### waitUpdate() ```ts waitUpdate(itemHandlers?): Promise; ``` ###### Parameters | Parameter | Type | Default value | | ------ | ------ | ------ | | `itemHandlers` | [`ItemHandler`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ItemHandler.md#itemhandler)[] | `null` | ###### Returns [`Promise`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/finally.md#promise)\<`void`[]\> ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`waitUpdate`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#waitupdate) ##### workspaceSizeChanged() ```ts workspaceSizeChanged(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | `any` | ###### Returns `void` ##### workspaceSizeChanged() ```ts workspaceSizeChanged(handler): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `handler` | `any` | ###### Returns `void` ##### workspaceToControl() ```ts workspaceToControl(pt): any; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `pt` | `PointF` | ###### Returns `any` ##### zoomChanged() ```ts zoomChanged(h): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `h` | `any` | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`zoomChanged`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#zoomchanged) ##### zoomChanged() ```ts zoomChanged(h): void; ``` ###### Parameters | Parameter | Type | | ------ | ------ | | `h` | `any` | ###### Returns `void` ###### Implementation of [`ICanvas`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#icanvas).[`zoomChanged`](https://customerscanvas.com/docs/on-premises/design-atoms-js/reference/design-atoms/ICanvas.md#zoomchanged-1)