Interface ICanvas

Package: @aurigma/design-atoms

Properties

badViolationIconCssClass

Declaration

badViolationIconCssClass: string;

Property Value

Type	Description
string

canvasElementSize

Declaration

canvasElementSize: {
        width?: number;
        height?: number;
    };

Property Value

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

contentAngle

Declaration

contentAngle: number;

Property Value

Type	Description
number

currentItemHandler

Declaration

currentItemHandler: ItemHandler;

Property Value

Type	Description
ItemHandler

designAtomsApiClient

Declaration

designAtomsApiClient: IDesignAtomsApiClient;

Property Value

Type	Description
IDesignAtomsApiClient

disableSmoothing

Declaration

disableSmoothing: boolean;

Property Value

Type	Description
boolean

fontRegistry

Declaration

fontRegistry: FontRegistry;

Property Value

Type	Description
FontRegistry

frontEndTextRenderingEnabled

Declaration

frontEndTextRenderingEnabled: boolean;

Property Value

Type	Description
boolean

goodViolationIconCssClass

Declaration

goodViolationIconCssClass: string;

Property Value

Type	Description
string

height

Declaration

height: number;

Property Value

Type	Description
number

history

Declaration

history: History;

Property Value

Type	Description
History_2

hitTestManager

Declaration

hitTestManager: IHitTestManager;

Property Value

Type	Description
IHitTestManager

hoverHandler

Declaration

hoverHandler: IHoverHandler;

Property Value

Type	Description
IHoverHandler

ignorePermissionsMode

Declaration

ignorePermissionsMode: boolean;

Property Value

Type	Description
boolean

initialization

Declaration

initialization: boolean;

Property Value

Type	Description
boolean

isInitialized

Declaration

isInitialized: boolean;

Property Value

Type	Description
boolean

isSelectionDragging

Declaration

isSelectionDragging: boolean;

Property Value

Type	Description
boolean

isSelectionIdle

Declaration

isSelectionIdle: boolean;

Property Value

Type	Description
boolean

isSelectionLocked

Declaration

isSelectionLocked: boolean;

Property Value

Type	Description
boolean

isSelectionResizing

Declaration

isSelectionResizing: boolean;

Property Value

Type	Description
boolean

isSelectionRotating

Declaration

isSelectionRotating: boolean;

Property Value

Type	Description
boolean

layers

Declaration

layers: LayerCollection;

Property Value

Type	Description
LayerCollection

maxFontSize

Declaration

maxFontSize: number;

Property Value

Type	Description
number

maxLeading

Declaration

maxLeading: number;

Property Value

Type	Description
number

minFontSize

Declaration

minFontSize: number;

Property Value

Type	Description
number

minLeading

Declaration

minLeading: number;

Property Value

Type	Description
number

mul

Declaration

mul: number;

Property Value

Type	Description
number

offset

Declaration

offset: PointF;

Property Value

Type	Description
PointF

previewMode

Declaration

previewMode: boolean;

Property Value

Type	Description
boolean

qualityBadToGoodChangeScaleBarCssClass

Declaration

qualityBadToGoodChangeScaleBarCssClass: string;

Property Value

Type	Description
string

qualityBadToWarningChangeScaleBarCssClass

Declaration

qualityBadToWarningChangeScaleBarCssClass: string;

Property Value

Type	Description
string

qualityChangeScaleBarCssClass

Declaration

qualityChangeScaleBarCssClass: string;

Property Value

Type	Description
string

qualityNoAnimationChangeScaleBarCssClass

Declaration

qualityNoAnimationChangeScaleBarCssClass: string;

Property Value

Type	Description
string

qualityWarningToGoodChangeScaleBarCssClass

Declaration

qualityWarningToGoodChangeScaleBarCssClass: string;

Property Value

Type	Description
string

renderingConfigProvider

Declaration

renderingConfigProvider: IRenderingConfigProvider;

Property Value

Type	Description
IRenderingConfigProvider

service

Declaration

service: Service;

Property Value

Type	Description
Service

style

Declaration

style: CanvasRendererStyle;

Property Value

Type	Description
CanvasRendererStyle

textEditor

Declaration

textEditor: ITextEditor;

Property Value

Type	Description
IFontRegistry

textWhizz

Declaration

textWhizz: typeof TextWhizz;

Property Value

Type	Description
typeof TextWhizz

viewerConfiguration

Declaration

viewerConfiguration: IViewerConfiguration | null;

Property Value

Type	Description
IViewerConfiguration | null

warningViolationIconCssClass

Declaration

warningViolationIconCssClass: string;

Property Value

Type	Description
string

width

Declaration

width: number;

Property Value

Type	Description
number

workspace

Declaration

workspace: IWorkspace;

Property Value

Type	Description
IWorkspace

workspaceHeight

Declaration

workspaceHeight: number;

Property Value

Type	Description
number

workspaceWidth

Declaration

workspaceWidth: number;

Property Value

Type	Description
number

zoom

Declaration

zoom: number;

Property Value

Type	Description
number

Methods

add_onScroll(handler)

Declaration

add_onScroll(handler: any): void;

Parameters

Type	Name	Description
any	handler

Returns

Type	Description
void

add_onSelectionLocked(handler)

Declaration

add_onSelectionLocked(handler: any): void;

Parameters

Type	Name	Description
any	handler

Returns

Type	Description
void

add_selectedItemHandlerChanged(handler)

Declaration

add_selectedItemHandlerChanged(handler: any): void;

Parameters

Type	Name	Description
any	handler

Returns

Type	Description
void

add_zoomChanged(listener)

Declaration

add_zoomChanged(listener: any): void;

Parameters

Type	Name	Description
any	listener

Returns

Type	Description
void

addPlaceholderButtonGroup(placeholder)

Declaration

addPlaceholderButtonGroup(placeholder: PlaceholderItemHandler): void;

Parameters

Type	Name	Description
PlaceholderItemHandler	placeholder

Returns

Type	Description
void

addSelectedItemHandler(itemHandler)

Declaration

addSelectedItemHandler(itemHandler: ItemHandler): void;

Parameters

Type	Name	Description
ItemHandler	itemHandler

Returns

Type	Description
void

addViolationContainer(itemHandler)

Declaration

addViolationContainer(itemHandler: BaseRectangleItemHandler): void;

Parameters

Type	Name	Description
BaseRectangleItemHandler	itemHandler

Returns

Type	Description
void

clearSelectedItemHandlers()

Declaration

clearSelectedItemHandlers(): void;

Returns

Type	Description
void

continueRedraw()

Declaration

continueRedraw(): void;

Returns

Type	Description
void

deleteItemHandler(itemHandler)

Declaration

deleteItemHandler(itemHandler: ItemHandler): void;

Parameters

Type	Name	Description
ItemHandler	itemHandler

Returns

Type	Description
void

disableSelection()

Declaration

disableSelection(): void;

Returns

Type	Description
void

doesContainItem(item)

Declaration

doesContainItem(item: Item): boolean;

Parameters

Type	Name	Description
Item	item

Returns

Type	Description
boolean

drawWaitClock(context, center)

Declaration

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

Parameters

Type	Name	Description
CanvasRenderingContext2D	context
PointF	center

Returns

Type	Description
void

enableSelection()

Declaration

enableSelection(): void;

Returns

Type	Description
void

ensureFocus()

Declaration

ensureFocus(): void;

Returns

Type	Description
void

getAllItemHandlers(options)

Declaration

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

Parameters

Type	Name	Description
GetItemHandlersOptions	options

Returns

Type	Description
ItemHandler[]

getButtonGroupRectInGripsDiv(div, ignoreRotate)

Declaration

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

Parameters

Type	Name	Description
HTMLElement	div
boolean	ignoreRotate

Returns

Type	Description
RectangleF

getData(forService, layerId)

Declaration

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

Parameters

Type	Name	Description
boolean	forService
string	layerId

Returns

Type	Description
CanvasData

getItemHandler(item)

Declaration

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

Parameters

Type	Name	Description
Item	item

Returns

Type	Description
THandler

Type Parameters

Name	Description
THandler

isDragSource(itemHandler)

Declaration

isDragSource(itemHandler: ItemHandler): boolean;

Parameters

Type	Name	Description
ItemHandler	itemHandler

Returns

Type	Description
boolean

isDragTarget(itemHandler)

Declaration

isDragTarget(itemHandler: ItemHandler): boolean;

Parameters

Type	Name	Description
ItemHandler	itemHandler

Returns

Type	Description
boolean

isItemHandlerSelected(itemHandler)

Declaration

isItemHandlerSelected(itemHandler: ItemHandler): boolean;

Parameters

Type	Name	Description
ItemHandler	itemHandler

Returns

Type	Description
boolean

isOnlyThisItemHandlerSelected(itemHandler)

Declaration

isOnlyThisItemHandlerSelected(itemHandler: BaseRectangleItemHandler): boolean;

Parameters

Type	Name	Description
BaseRectangleItemHandler	itemHandler

Returns

Type	Description
boolean

onLayerTextureLoaded()

Declaration

onLayerTextureLoaded(): void;

Returns

Type	Description
void

pauseRedraw()

Declaration

pauseRedraw(): void;

Returns

Type	Description
void

pauseUpdateTexts()

Declaration

pauseUpdateTexts(): void;

Returns

Type	Description
void

redraw()

Declaration

redraw(): void;

Returns

Type	Description
void

redrawActiveTexts()

Declaration

redrawActiveTexts(): void;

Returns

Type	Description
void

redrawDesign()

Declaration

redrawDesign(): void;

Returns

Type	Description
void

remove_onScroll(handler)

Declaration

remove_onScroll(handler: any): void;

Parameters

Type	Name	Description
any	handler

Returns

Type	Description
void

remove_onSelectionLocked(handler)

Declaration

remove_onSelectionLocked(handler: any): void;

Parameters

Type	Name	Description
any	handler

Returns

Type	Description
void

remove_selectedItemHandlerChanged(handler)

Declaration

remove_selectedItemHandlerChanged(handler: any): void;

Parameters

Type	Name	Description
any	handler

Returns

Type	Description
void

remove_zoomChanged(listener)

Declaration

remove_zoomChanged(listener: any): void;

Parameters

Type	Name	Description
any	listener

Returns

Type	Description
void

removePlaceholderButtonGroup(placeholder)

Declaration

removePlaceholderButtonGroup(placeholder: PlaceholderItemHandler): void;

Parameters

Type	Name	Description
PlaceholderItemHandler	placeholder

Returns

Type	Description
void

removeSelectedItemHandler(itemHandler)

Declaration

removeSelectedItemHandler(itemHandler: ItemHandler): void;

Parameters

Type	Name	Description
ItemHandler	itemHandler

Returns

Type	Description
void

removeViolationContainer(itemHandler)

Declaration

removeViolationContainer(itemHandler: BaseRectangleItemHandler): void;

Parameters

Type	Name	Description
BaseRectangleItemHandler	itemHandler

Returns

Type	Description
void

resumeUpdateTexts()

Declaration

resumeUpdateTexts(): void;

Returns

Type	Description
void

setCursor(value, onBody)

Declaration

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

Parameters

Type	Name	Description
any	value
boolean	onBody

Returns

Type	Description
void

setSelectedItemHandlers(itemHandlers)

Declaration

setSelectedItemHandlers(itemHandlers: ItemHandler[]): void;

Parameters

Type	Name	Description
ItemHandler[]	itemHandlers

Returns

Type	Description
void

subscribeLimitsMessage()

Declaration

subscribeLimitsMessage(): void;

Returns

Type	Description
void

unsubscribeLimitsMessage()

Declaration

unsubscribeLimitsMessage(): void;

Returns

Type	Description
void

updateButtonGroups(options)

Declaration

updateButtonGroups(options: UpdateButtonGroupsOptions): void;

Parameters

Type	Name	Description
UpdateButtonGroupsOptions	options

Returns

Type	Description
void

updatePlaceholderButtonGroup(placeholder)

Declaration

updatePlaceholderButtonGroup(placeholder: PlaceholderItemHandler | GroupItemHandler): void;

Parameters

Type	Name	Description
PlaceholderItemHandler | GroupItemHandler	placeholder

Returns

Type	Description
void

updatePlaceholderButtonGroupPosition(placeholder)

Declaration

updatePlaceholderButtonGroupPosition(placeholder: PlaceholderItemHandler): void;

Parameters

Type	Name	Description
PlaceholderItemHandler	placeholder

Returns

Type	Description
void

updatePlaceholderButtonGroups()

Declaration

updatePlaceholderButtonGroups(): void;

Returns

Type	Description
void

updateSelection(force)

Declaration

updateSelection(force?: boolean): void;

Parameters

Type	Name	Description
boolean	force

Returns

Type	Description
void

updateTexts()

Declaration

updateTexts(): void;

Returns

Type	Description
void

updateViolationContainer(itemHandler, updatePosition)

Declaration

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

Parameters

Type	Name	Description
BaseRectangleItemHandler	itemHandler
boolean	updatePosition

Returns

Type	Description
void

updateViolationContainerPosition(itemHandler)

Declaration

updateViolationContainerPosition(itemHandler: BaseRectangleItemHandler): void;

Parameters

Type	Name	Description
BaseRectangleItemHandler	itemHandler

Returns

Type	Description
void

updateViolationContainers(updatePosition, onlyVisible)

Declaration

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

Parameters

Type	Name	Description
boolean	updatePosition
boolean	onlyVisible

Returns

Type	Description
void

violationWarningButtonHitTestObject(pt)

Declaration

violationWarningButtonHitTestObject(pt: PointF): BaseRectangleItemHandler;

Parameters

Type	Name	Description
PointF	pt

Returns

Type	Description
BaseRectangleItemHandler

waitUpdate(itemHandlers)

Declaration

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

Parameters

Type	Name	Description
ItemHandler[]	itemHandlers

Returns

Type	Description
Promise<void[]>