PreviewCanvas

Classes

PreviewCanvas

Implements

• ICanvas
• ICanvasDataSource

Constructors

Constructor

new PreviewCanvas(
   sourceSurface,
   previewContainersSourceFactory,
   zoom,
   mul,
   renderer,
   designAtomsApiClient,
   colorPreviewService,
   service,
   viewerConfigurationContext,
   colorParser): PreviewCanvas;

Parameters

Parameter	Type
sourceSurface	Surface
previewContainersSourceFactory	IPreviewContainersSourceFactory
zoom	number
mul	number
renderer	IWaitClockRenderer
designAtomsApiClient	IDesignAtomsApiClient
colorPreviewService	IListenableColorPreviewService
service	Service
viewerConfigurationContext	IViewerConfigurationContext
colorParser	IColorParser

Returns

PreviewCanvas

Accessors

badViolationIconCssClass

Get Signature

get badViolationIconCssClass(): string;

Returns

string

Implementation of

ICanvasDataSource.badViolationIconCssClass

bigButtonGroupCssClass

Get Signature

get bigButtonGroupCssClass(): string;

Returns

string

Implementation of

ICanvasDataSource.bigButtonGroupCssClass

canvasElementSize

Get Signature

get canvasElementSize(): object;

Returns

object

height?

optional height?: number;

width?

optional width?: number;

Implementation of

ICanvas.canvasElementSize

cmykColorProfileFileId

Get Signature

get cmykColorProfileFileId(): string;

Returns

string

contentAngle

Get Signature

get contentAngle(): number;

Returns

number

Implementation of

ICanvas.contentAngle

currentItemHandler

Get Signature

get currentItemHandler(): ItemHandler;

Returns

ItemHandler

Implementation of

ICanvas.currentItemHandler

designAtomsApiClient

Get Signature

get designAtomsApiClient(): IDesignAtomsApiClient;

Returns

IDesignAtomsApiClient

Implementation of

ICanvas.designAtomsApiClient

disableSmoothing

Get Signature

get disableSmoothing(): boolean;

Returns

boolean

Implementation of

ICanvasDataSource.disableSmoothing

doneButtonCssClass

Get Signature

get doneButtonCssClass(): string;

Returns

string

Implementation of

ICanvasDataSource.doneButtonCssClass

fontRegistry

Get Signature

get fontRegistry(): FontRegistry;

Returns

FontRegistry

Implementation of

ICanvas.fontRegistry

frontEndTextRenderingEnabled

Get Signature

get frontEndTextRenderingEnabled(): boolean;

Returns

boolean

Implementation of

ICanvas.frontEndTextRenderingEnabled

goodViolationIconCssClass

Get Signature

get goodViolationIconCssClass(): string;

Returns

string

Implementation of

ICanvasDataSource.goodViolationIconCssClass

grayscaleColorProfileFileId

Get Signature

get grayscaleColorProfileFileId(): string;

Returns

string

handleButtonCssClass

Get Signature

get handleButtonCssClass(): string;

Returns

string

Implementation of

ICanvasDataSource.handleButtonCssClass

height

Get Signature

get height(): number;

Returns

number

Implementation of

ICanvas.height

history

Get Signature

get history(): History;

Returns

History

Implementation of

ICanvas.history

hitTestManager

Get Signature

get hitTestManager(): IHitTestManager;

Returns

IHitTestManager

Implementation of

ICanvas.hitTestManager

hoverHandler

Get Signature

get hoverHandler(): IHoverHandler;

Returns

IHoverHandler

Implementation of

ICanvas.hoverHandler

ignorePermissionsMode

Get Signature

get ignorePermissionsMode(): boolean;

Returns

boolean

Implementation of

ICanvas.ignorePermissionsMode

initialization

Get Signature

get initialization(): boolean;

Returns

boolean

Implementation of

ICanvas.initialization

isInitialized

Get Signature

get isInitialized(): boolean;

Returns

boolean

Implementation of

ICanvas.isInitialized

isSelectionDragging

Get Signature

get isSelectionDragging(): boolean;

Returns

boolean

Implementation of

ICanvas.isSelectionDragging

isSelectionIdle

Get Signature

get isSelectionIdle(): boolean;

Returns

boolean

Implementation of

ICanvas.isSelectionIdle

isSelectionLocked

Get Signature

get isSelectionLocked(): boolean;

Returns

boolean

Implementation of

ICanvas.isSelectionLocked

isSelectionResizing

Get Signature

get isSelectionResizing(): boolean;

Returns

boolean

Implementation of

ICanvas.isSelectionResizing

isSelectionRotating

Get Signature

get isSelectionRotating(): boolean;

Returns

boolean

Implementation of

ICanvas.isSelectionRotating

layers

Get Signature

get layers(): LayerCollection;

Returns

LayerCollection

Implementation of

ICanvasDataSource.layers

maxFontSize

Get Signature

get maxFontSize(): number;

Returns

number

Implementation of

ICanvasDataSource.maxFontSize

maxLeading

Get Signature

get maxLeading(): number;

Returns

number

Implementation of

ICanvasDataSource.maxLeading

minFontSize

Get Signature

get minFontSize(): number;

Returns

number

Implementation of

ICanvasDataSource.minFontSize

minLeading

Get Signature

get minLeading(): number;

Returns

number

Implementation of

ICanvasDataSource.minLeading

mouseMoveTimeout

Get Signature

get mouseMoveTimeout(): number;

Returns

number

Implementation of

ICanvasDataSource.mouseMoveTimeout

mul

Get Signature

get mul(): number;

Returns

number

Implementation of

ICanvas.mul

multipleSelectionEnabled

Get Signature

get multipleSelectionEnabled(): boolean;

Returns

boolean

Implementation of

ICanvasDataSource.multipleSelectionEnabled

offset

Get Signature

get offset(): PointF;

Returns

PointF

Implementation of

ICanvas.offset

placeholderButtonGroupCssClass

Get Signature

get placeholderButtonGroupCssClass(): string;

Returns

string

Implementation of

ICanvasDataSource.placeholderButtonGroupCssClass

previewMode

Get Signature

get previewMode(): boolean;

Returns

boolean

Implementation of

ICanvas.previewMode

qualityBadToGoodChangeScaleBarCssClass

Get Signature

get qualityBadToGoodChangeScaleBarCssClass(): string;

Returns

string

Implementation of

ICanvasDataSource.qualityBadToGoodChangeScaleBarCssClass

qualityBadToWarningChangeScaleBarCssClass

Get Signature

get qualityBadToWarningChangeScaleBarCssClass(): string;

Returns

string

Implementation of

ICanvasDataSource.qualityBadToWarningChangeScaleBarCssClass

qualityChangeContainerCssClass

Get Signature

get qualityChangeContainerCssClass(): string;

Returns

string

Implementation of

ICanvasDataSource.qualityChangeContainerCssClass

qualityChangeInfoBarCssClass

Get Signature

get qualityChangeInfoBarCssClass(): string;

Returns

string

Implementation of

ICanvasDataSource.qualityChangeInfoBarCssClass

qualityChangeScaleBarCssClass

Get Signature

get qualityChangeScaleBarCssClass(): string;

Returns

string

Implementation of

ICanvasDataSource.qualityChangeScaleBarCssClass

qualityNoAnimationChangeScaleBarCssClass

Get Signature

get qualityNoAnimationChangeScaleBarCssClass(): string;

Returns

string

Implementation of

ICanvasDataSource.qualityNoAnimationChangeScaleBarCssClass

qualityWarningToGoodChangeScaleBarCssClass

Get Signature

get qualityWarningToGoodChangeScaleBarCssClass(): string;

Returns

string

Implementation of

ICanvasDataSource.qualityWarningToGoodChangeScaleBarCssClass

renderingConfig

Get Signature

get renderingConfig(): IRenderingConfig;

Returns

IRenderingConfig

renderingConfigProvider

Get Signature

get renderingConfigProvider(): IRenderingConfigProvider;

Returns

IRenderingConfigProvider

Implementation of

ICanvas.renderingConfigProvider

resizeGripColor

Get Signature

get resizeGripColor(): string;

Returns

string

Implementation of

ICanvasDataSource.resizeGripColor

resizeGripLineColor

Get Signature

get resizeGripLineColor(): string;

Returns

string

Implementation of

ICanvasDataSource.resizeGripLineColor

resizeGripSize

Get Signature

get resizeGripSize(): number;

Returns

number

Implementation of

ICanvasDataSource.resizeGripSize

rgbColorProfileFileId

Get Signature

get rgbColorProfileFileId(): string;

Returns

string

rotationGripColor

Get Signature

get rotationGripColor(): string;

Returns

string

Implementation of

ICanvasDataSource.rotationGripColor

rotationGripLineColor

Get Signature

get rotationGripLineColor(): string;

Returns

string

Implementation of

ICanvasDataSource.rotationGripLineColor

rotationGripLineLength

Get Signature

get rotationGripLineLength(): number;

Returns

number

Implementation of

ICanvasDataSource.rotationGripLineLength

rotationGripSize

Get Signature

get rotationGripSize(): number;

Returns

number

Implementation of

ICanvasDataSource.rotationGripSize

selectionColor

Get Signature

get selectionColor(): string;

Returns

string

Implementation of

ICanvasDataSource.selectionColor

selectionWidth

Get Signature

get selectionWidth(): number;

Returns

number

Implementation of

ICanvasDataSource.selectionWidth

service

Get Signature

get service(): Service;

Returns

Service

Implementation of

ICanvas.service

sourceSurface

Get Signature

get sourceSurface(): Surface;

Returns

Surface

style

Get Signature

get style(): CanvasRendererStyle;

Returns

CanvasRendererStyle

Implementation of

ICanvas.style

tags

Get Signature

get tags(): Object;

Returns

Object

Implementation of

ICanvasDataSource.tags

targetDpi

Get Signature

get targetDpi(): number;

Returns

number

Implementation of

ICanvasDataSource.targetDpi

textEditor

Get Signature

get textEditor(): ITextEditor;

Returns

ITextEditor

Implementation of

ICanvas.textEditor

textWhizz

Get Signature

get textWhizz(): any;

Returns

any

Implementation of

ICanvas.textWhizz

translations

Get Signature

get translations(): Translations;

Returns

Translations

Implementation of

ICanvasDataSource.translations

viewerConfiguration

Get Signature

get viewerConfiguration(): IViewerConfiguration;

Returns

IViewerConfiguration

Implementation of

ICanvas.viewerConfiguration

violationContainerCssClass

Get Signature

get violationContainerCssClass(): string;

Returns

string

Implementation of

ICanvasDataSource.violationContainerCssClass

violationWarningButtonCssClass

Get Signature

get violationWarningButtonCssClass(): string;

Returns

string

Implementation of

ICanvasDataSource.violationWarningButtonCssClass

warningViolationIconCssClass

Get Signature

get warningViolationIconCssClass(): string;

Returns

string

Implementation of

ICanvasDataSource.warningViolationIconCssClass

width

Get Signature

get width(): number;

Returns

number

Implementation of

ICanvas.width

workspace

Get Signature

get workspace(): IWorkspace;

Returns

IWorkspace

Implementation of

ICanvas.workspace

workspaceHeight

Get Signature

get workspaceHeight(): number;

Returns

number

Implementation of

ICanvasDataSource.workspaceHeight

workspaceWidth

Get Signature

get workspaceWidth(): number;

Returns

number

Implementation of

ICanvasDataSource.workspaceWidth

zoom

Get Signature

get zoom(): number;

Returns

number

Implementation of

ICanvasDataSource.zoom

Methods

addPlaceholderButtonGroup()

addPlaceholderButtonGroup(placeholder): void;

Parameters

Parameter	Type
placeholder	PlaceholderItemHandler

Returns

void

Implementation of

ICanvas.addPlaceholderButtonGroup

addSelectedItemHandler()

addSelectedItemHandler(itemHandler): void;

Parameters

Parameter	Type
itemHandler	ItemHandler

Returns

void

Implementation of

ICanvas.addSelectedItemHandler

addViolationContainer()

addViolationContainer(itemHandler): void;

Parameters

Parameter	Type
itemHandler	BaseRectangleItemHandler

Returns

void

Implementation of

ICanvas.addViolationContainer

clearSelectedItemHandlers()

clearSelectedItemHandlers(): void;

Returns

void

Implementation of

ICanvas.clearSelectedItemHandlers

continueRedraw()

continueRedraw(): void;

Returns

void

Implementation of

ICanvas.continueRedraw

deleteItemHandler()

deleteItemHandler(itemHandler): void;

Parameters

Parameter	Type
itemHandler	ItemHandler

Returns

void

Implementation of

ICanvas.deleteItemHandler

disableSelection()

disableSelection(): void;

Returns

void

Implementation of

ICanvas.disableSelection

dispose()

dispose(): void;

Returns

void

doesContainItem()

doesContainItem(item): boolean;

Parameters

Parameter	Type
item	Item

Returns

boolean

Implementation of

ICanvas.doesContainItem

drawWaitClock()

drawWaitClock(context, center): void;

Parameters

Parameter	Type
context	CanvasRenderingContext2D
center	PointF

Returns

void

Implementation of

ICanvas.drawWaitClock

enableSelection()

enableSelection(): void;

Returns

void

Implementation of

ICanvas.enableSelection

ensureFocus()

ensureFocus(): void;

Returns

void

Implementation of

ICanvas.ensureFocus

getAllItemHandlers()

getAllItemHandlers(options?): ItemHandler[];

Parameters

Parameter	Type
options?	GetItemHandlersOptions

Returns

ItemHandler[]

Implementation of

ICanvas.getAllItemHandlers

getButtonGroupRectInGripsDiv()

getButtonGroupRectInGripsDiv(div, ignoreRotate?): RectangleF;

Parameters

Parameter	Type
div	HTMLElement
ignoreRotate?	boolean

Returns

RectangleF

Implementation of

ICanvas.getButtonGroupRectInGripsDiv

getData()

getData(forService?, layerId?): CanvasData;

Parameters

Parameter	Type
forService?	boolean
layerId?	string

Returns

CanvasData

Implementation of

ICanvas.getData

getItemHandler()

getItemHandler<THandler>(item): THandler;

Type Parameters

Type Parameter
THandler extends ItemHandler

Parameters

Parameter	Type
item	Item

Returns

THandler

Implementation of

ICanvas.getItemHandler

isDragSource()

isDragSource(itemHandler): boolean;

Parameters

Parameter	Type
itemHandler	ItemHandler

Returns

boolean

Implementation of

ICanvas.isDragSource

isDragTarget()

isDragTarget(itemHandler): boolean;

Parameters

Parameter	Type
itemHandler	ItemHandler

Returns

boolean

Implementation of

ICanvas.isDragTarget

isItemHandlerSelected()

isItemHandlerSelected(itemHandler): boolean;

Parameters

Parameter	Type
itemHandler	ItemHandler

Returns

boolean

Implementation of

ICanvas.isItemHandlerSelected

isOnlyThisItemHandlerSelected()

isOnlyThisItemHandlerSelected(itemHandler): boolean;

Parameters

Parameter	Type
itemHandler	BaseRectangleItemHandler

Returns

boolean

Implementation of

ICanvas.isOnlyThisItemHandlerSelected

onLayerTextureLoaded()

onLayerTextureLoaded(): void;

Returns

void

Implementation of

ICanvas.onLayerTextureLoaded

onScroll()

onScroll(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

Implementation of

ICanvas.onScroll

onScroll()

onScroll(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

Implementation of

ICanvas.onScroll

onSelectionLocked()

onSelectionLocked(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

Implementation of

ICanvas.onSelectionLocked

onSelectionLocked()

onSelectionLocked(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

Implementation of

ICanvas.onSelectionLocked

pauseRedraw()

pauseRedraw(): void;

Returns

void

Implementation of

ICanvas.pauseRedraw

pauseUpdateTexts()

pauseUpdateTexts(): void;

Returns

void

Implementation of

ICanvas.pauseUpdateTexts

redraw()

redraw(): void;

Returns

void

Implementation of

ICanvas.redraw

redrawActiveTexts()

redrawActiveTexts(): void;

Returns

void

Implementation of

ICanvas.redrawActiveTexts

redrawDesign()

redrawDesign(): void;

Returns

void

Implementation of

ICanvas.redrawDesign

removePlaceholderButtonGroup()

removePlaceholderButtonGroup(placeholder): void;

Parameters

Parameter	Type
placeholder	PlaceholderItemHandler

Returns

void

Implementation of

ICanvas.removePlaceholderButtonGroup

removeSelectedItemHandler()

removeSelectedItemHandler(itemHandler): void;

Parameters

Parameter	Type
itemHandler	ItemHandler

Returns

void

Implementation of

ICanvas.removeSelectedItemHandler

removeViolationContainer()

removeViolationContainer(itemHandler): void;

Parameters

Parameter	Type
itemHandler	BaseRectangleItemHandler

Returns

void

Implementation of

ICanvas.removeViolationContainer

resumeUpdateTexts()

resumeUpdateTexts(): void;

Returns

void

Implementation of

ICanvas.resumeUpdateTexts

selectedItemHandlerChanged()

selectedItemHandlerChanged(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

Implementation of

ICanvas.selectedItemHandlerChanged

selectedItemHandlerChanged()

selectedItemHandlerChanged(handler): void;

Parameters

Parameter	Type
handler	any

Returns

void

Implementation of

ICanvas.selectedItemHandlerChanged

setCursor()

setCursor(value, onBody): void;

Parameters

Parameter	Type
value	any
onBody	boolean

Returns

void

Implementation of

ICanvas.setCursor

setSelectedItemHandlers()

setSelectedItemHandlers(itemHandlers): void;

Parameters

Parameter	Type
itemHandlers	ItemHandler[]

Returns

void

Implementation of

ICanvas.setSelectedItemHandlers

subscribeLimitsMessage()

subscribeLimitsMessage(): void;

Returns

void

Implementation of

ICanvas.subscribeLimitsMessage

unsubscribeLimitsMessage()

unsubscribeLimitsMessage(): void;

Returns

void

Implementation of

ICanvas.unsubscribeLimitsMessage

updateButtonGroups()

updateButtonGroups(options): void;

Parameters

Parameter	Type
options	UpdateButtonGroupsOptions

Returns

void

Implementation of

ICanvas.updateButtonGroups

updatePlaceholderButtonGroup()

updatePlaceholderButtonGroup(placeholder): void;

Parameters

Parameter	Type
placeholder	| PlaceholderItemHandler | GroupItemHandler

Returns

void

Implementation of

ICanvas.updatePlaceholderButtonGroup

updatePlaceholderButtonGroupPosition()

updatePlaceholderButtonGroupPosition(placeholder): void;

Parameters

Parameter	Type
placeholder	PlaceholderItemHandler

Returns

void

Implementation of

ICanvas.updatePlaceholderButtonGroupPosition

updatePlaceholderButtonGroups()

updatePlaceholderButtonGroups(): void;

Returns

void

Implementation of

ICanvas.updatePlaceholderButtonGroups

updateSelection()

updateSelection(force?): void;

Parameters

Parameter	Type
force?	boolean

Returns

void

Implementation of

ICanvas.updateSelection

updateTexts()

updateTexts(): void;

Returns

void

Implementation of

ICanvas.updateTexts

updateViolationContainer()

updateViolationContainer(itemHandler, updatePosition?): void;

Parameters

Parameter	Type
itemHandler	BaseRectangleItemHandler
updatePosition?	boolean

Returns

void

Implementation of

ICanvas.updateViolationContainer

updateViolationContainerPosition()

updateViolationContainerPosition(itemHandler): void;

Parameters

Parameter	Type
itemHandler	BaseRectangleItemHandler

Returns

void

Implementation of

ICanvas.updateViolationContainerPosition

updateViolationContainers()

updateViolationContainers(updatePosition?, onlyVisible?): void;

Parameters

Parameter	Type
updatePosition?	boolean
onlyVisible?	boolean

Returns

void

Implementation of

ICanvas.updateViolationContainers

violationWarningButtonHitTestObject()

violationWarningButtonHitTestObject(pt): BaseRectangleItemHandler;

Parameters

Parameter	Type
pt	PointF

Returns

BaseRectangleItemHandler

Implementation of

ICanvas.violationWarningButtonHitTestObject

waitFontRegistryInitialized()

waitFontRegistryInitialized(): Promise<void>;

Returns

Promise<void>

waitUpdate()

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

Parameters

Parameter	Type
itemHandlers?	ItemHandler[]

Returns

Promise<void[]>

Implementation of

ICanvas.waitUpdate

waitUpdateAndExecute()

waitUpdateAndExecute(callback): Promise<void>;

Parameters

Parameter	Type
callback	() => void

Returns

Promise<void>

zoomChanged()

zoomChanged(listener): void;

Parameters

Parameter	Type
listener	any

Returns

void

Implementation of

ICanvas.zoomChanged

zoomChanged()

zoomChanged(listener): void;

Parameters

Parameter	Type
listener	any

Returns

void

Implementation of

ICanvas.zoomChanged

Interfaces

IViewerConfigurationContext

Properties

configuration

configuration: IViewerConfiguration;

---

IWaitClockRenderer

Methods

drawWaitClock()

drawWaitClock(
   context,
   center,
   mul): void;

Parameters

Parameter	Type
context	CanvasRenderingContext2D
center	PointF
mul	number

Returns

void