ICanvas

Interfaces

ICanvas

Properties

badViolationIconCssClass

badViolationIconCssClass: string;

canvasElementSize

canvasElementSize: object;

height?

optional height?: number;

width?

optional width?: number;

contentAngle

contentAngle: number;

currentItemHandler

currentItemHandler: ItemHandler;

designAtomsApiClient

designAtomsApiClient: IDesignAtomsApiClient;

disableSmoothing

disableSmoothing: boolean;

fontRegistry

fontRegistry: FontRegistry;

frontEndTextRenderingEnabled

frontEndTextRenderingEnabled: boolean;

goodViolationIconCssClass

goodViolationIconCssClass: string;

height

height: number;

history

history: History;

hitTestManager

hitTestManager: IHitTestManager;

hoverHandler

hoverHandler: IHoverHandler;

ignorePermissionsMode

ignorePermissionsMode: boolean;

initialization

initialization: boolean;

isInitialized

isInitialized: boolean;

isSelectionDragging

isSelectionDragging: boolean;

isSelectionIdle

isSelectionIdle: boolean;

isSelectionLocked

isSelectionLocked: boolean;

isSelectionResizing

isSelectionResizing: boolean;

isSelectionRotating

isSelectionRotating: boolean;

layers

layers: LayerCollection;

maxFontSize

maxFontSize: number;

maxLeading

maxLeading: number;

minFontSize

minFontSize: number;

minLeading

minLeading: number;

mul

mul: number;

offset

offset: PointF;

previewMode

previewMode: boolean;

qualityBadToGoodChangeScaleBarCssClass

qualityBadToGoodChangeScaleBarCssClass: string;

qualityBadToWarningChangeScaleBarCssClass

qualityBadToWarningChangeScaleBarCssClass: string;

qualityChangeScaleBarCssClass

qualityChangeScaleBarCssClass: string;

qualityNoAnimationChangeScaleBarCssClass

qualityNoAnimationChangeScaleBarCssClass: string;

qualityWarningToGoodChangeScaleBarCssClass

qualityWarningToGoodChangeScaleBarCssClass: string;

renderingConfigProvider

renderingConfigProvider: IRenderingConfigProvider;

service

service: Service;

style

style: CanvasRendererStyle;

textEditor

textEditor: ITextEditor;

textWhizz

textWhizz: any;

viewerConfiguration

viewerConfiguration: IViewerConfiguration;

warningViolationIconCssClass

warningViolationIconCssClass: string;

width

width: number;

workspace

workspace: IWorkspace;

workspaceHeight

workspaceHeight: number;

workspaceWidth

workspaceWidth: number;

zoom

zoom: number;

Methods

addPlaceholderButtonGroup()

addPlaceholderButtonGroup(placeholder): void;

Parameters

Parameter	Type
placeholder	PlaceholderItemHandler

Returns

void

addSelectedItemHandler()

addSelectedItemHandler(itemHandler): void;

Parameters

Parameter	Type
itemHandler	ItemHandler

Returns

void

addViolationContainer()

addViolationContainer(itemHandler): void;

Parameters

Parameter	Type
itemHandler	BaseRectangleItemHandler

Returns

void

clearSelectedItemHandlers()

clearSelectedItemHandlers(): void;

Returns

void

continueRedraw()

continueRedraw(): void;

Returns

void

deleteItemHandler()

deleteItemHandler(itemHandler): void;

Parameters

Parameter	Type
itemHandler	ItemHandler

Returns

void

disableSelection()

disableSelection(): void;

Returns

void

doesContainItem()

doesContainItem(item): boolean;

Parameters

Parameter	Type
item	Item

Returns

boolean

drawWaitClock()

drawWaitClock(context, center): void;

Parameters

Parameter	Type
context	CanvasRenderingContext2D
center	PointF

Returns

void

enableSelection()

enableSelection(): void;

Returns

void

ensureFocus()

ensureFocus(): void;

Returns

void

getAllItemHandlers()

getAllItemHandlers(options?): ItemHandler[];

Parameters

Parameter	Type
options?	GetItemHandlersOptions

Returns

ItemHandler[]

getButtonGroupRectInGripsDiv()

getButtonGroupRectInGripsDiv(div, ignoreRotate?): RectangleF;

Parameters

Parameter	Type
div	HTMLElement
ignoreRotate?	boolean

Returns

RectangleF

getData()

getData(forService?, layerId?): CanvasData;

Parameters

Parameter	Type
forService?	boolean
layerId?	string

Returns

CanvasData

getItemHandler()

getItemHandler<THandler>(item): THandler;

Type Parameters

Type Parameter
THandler extends ItemHandler

Parameters

Parameter	Type
item	Item

Returns

THandler

isDragSource()

isDragSource(itemHandler): boolean;

Parameters

Parameter	Type
itemHandler	ItemHandler

Returns

boolean

isDragTarget()

isDragTarget(itemHandler): boolean;

Parameters

Parameter	Type
itemHandler	ItemHandler

Returns

boolean

isItemHandlerSelected()

isItemHandlerSelected(itemHandler): boolean;

Parameters

Parameter	Type
itemHandler	ItemHandler

Returns

boolean

isOnlyThisItemHandlerSelected()

isOnlyThisItemHandlerSelected(itemHandler): boolean;

Parameters

Parameter	Type
itemHandler	BaseRectangleItemHandler

Returns

boolean

onLayerTextureLoaded()

onLayerTextureLoaded(): void;

Returns

void

onScroll()

onScroll(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

onScroll()

onScroll(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

onSelectionLocked()

onSelectionLocked(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

onSelectionLocked()

onSelectionLocked(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

pauseRedraw()

pauseRedraw(): void;

Returns

void

pauseUpdateTexts()

pauseUpdateTexts(): void;

Returns

void

redraw()

redraw(): void;

Returns

void

redrawActiveTexts()

redrawActiveTexts(): void;

Returns

void

redrawDesign()

redrawDesign(): void;

Returns

void

removePlaceholderButtonGroup()

removePlaceholderButtonGroup(placeholder): void;

Parameters

Parameter	Type
placeholder	PlaceholderItemHandler

Returns

void

removeSelectedItemHandler()

removeSelectedItemHandler(itemHandler): void;

Parameters

Parameter	Type
itemHandler	ItemHandler

Returns

void

removeViolationContainer()

removeViolationContainer(itemHandler): void;

Parameters

Parameter	Type
itemHandler	BaseRectangleItemHandler

Returns

void

resumeUpdateTexts()

resumeUpdateTexts(): void;

Returns

void

selectedItemHandlerChanged()

selectedItemHandlerChanged(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

selectedItemHandlerChanged()

selectedItemHandlerChanged(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

setCursor()

setCursor(value, onBody): void;

Parameters

Parameter	Type
value	any
onBody	boolean

Returns

void

setSelectedItemHandlers()

setSelectedItemHandlers(itemHandlers): void;

Parameters

Parameter	Type
itemHandlers	ItemHandler[]

Returns

void

subscribeLimitsMessage()

subscribeLimitsMessage(): void;

Returns

void

unsubscribeLimitsMessage()

unsubscribeLimitsMessage(): void;

Returns

void

updateButtonGroups()

updateButtonGroups(options): void;

Parameters

Parameter	Type
options	UpdateButtonGroupsOptions

Returns

void

updatePlaceholderButtonGroup()

updatePlaceholderButtonGroup(placeholder): void;

Parameters

Parameter	Type
placeholder	| PlaceholderItemHandler | GroupItemHandler

Returns

void

updatePlaceholderButtonGroupPosition()

updatePlaceholderButtonGroupPosition(placeholder): void;

Parameters

Parameter	Type
placeholder	PlaceholderItemHandler

Returns

void

updatePlaceholderButtonGroups()

updatePlaceholderButtonGroups(): void;

Returns

void

updateSelection()

updateSelection(force?): void;

Parameters

Parameter	Type
force?	boolean

Returns

void

updateTexts()

updateTexts(): void;

Returns

void

updateViolationContainer()

updateViolationContainer(itemHandler, updatePosition?): void;

Parameters

Parameter	Type
itemHandler	BaseRectangleItemHandler
updatePosition?	boolean

Returns

void

updateViolationContainerPosition()

updateViolationContainerPosition(itemHandler): void;

Parameters

Parameter	Type
itemHandler	BaseRectangleItemHandler

Returns

void

updateViolationContainers()

updateViolationContainers(updatePosition?, onlyVisible?): void;

Parameters

Parameter	Type
updatePosition?	boolean
onlyVisible?	boolean

Returns

void

violationWarningButtonHitTestObject()

violationWarningButtonHitTestObject(pt): BaseRectangleItemHandler;

Parameters

Parameter	Type
pt	PointF

Returns

BaseRectangleItemHandler

waitUpdate()

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

Parameters

Parameter	Type
itemHandlers?	ItemHandler[]

Returns

Promise<void[]>

zoomChanged()

zoomChanged(listener): void;

Parameters

Parameter	Type
listener	any

Returns

void

zoomChanged()

zoomChanged(listener): void;

Parameters

Parameter	Type
listener	any

Returns

void

Type Aliases

GetItemHandlersOptions

type GetItemHandlersOptions = object;

Properties

blackListFilter?

optional blackListFilter?: (handler) => boolean;

Parameters

Parameter	Type
handler	any

Returns

boolean

excludeGroupItems?

optional excludeGroupItems?: boolean;

flatGroupItems?

optional flatGroupItems?: boolean;

onlyType?

optional onlyType?: 
  | ItemHandlerType
  | ItemHandlerType[];

onlyUnlocked?

optional onlyUnlocked?: boolean;

onlyVisible?

optional onlyVisible?: boolean;

whiteListFilter?

optional whiteListFilter?: (handler) => boolean;

Parameters

Parameter	Type
handler	any

Returns

boolean

---

ItemHandlerType

type ItemHandlerType = 
  | typeof PlaceholderItemHandler
  | typeof ImageItemHandler
  | typeof ItemHandler
  | typeof PlainTextItemHandler
  | typeof RectangleItemHandler
  | typeof ShapeItemHandler
  | typeof BaseTextItemHandler
  | typeof NewBaseTextItemHandler;