Class PreviewCanvas

Package: @aurigma/design-atoms

Constructors

(constructor)(sourceSurface, previewContainersSourceFactory, zoom, mul, renderer, designAtomsApiClient, colorPreviewService, service, viewerConfigurationContext, colorParser)

Constructs a new instance of the PreviewCanvas class

Declaration

constructor(sourceSurface: Surface, previewContainersSourceFactory: IPreviewContainersSourceFactory, zoom: number, mul: number, renderer: IWaitClockRenderer, designAtomsApiClient: IDesignAtomsApiClient, colorPreviewService: IListenableColorPreviewService, service: Service, viewerConfigurationContext: IViewerConfigurationContext, colorParser: IColorParser);

Parameters

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

Properties

badViolationIconCssClass

Declaration

get badViolationIconCssClass(): string;

Property Value

Type	Description
string

bigButtonGroupCssClass

Declaration

get bigButtonGroupCssClass(): string;

Property Value

Type	Description
string

canvasElementSize

Declaration

get canvasElementSize(): {
        width?: number;
        height?: number;
    };

Property Value

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

cmykColorProfileFileId

Declaration

get cmykColorProfileFileId(): string;

Property Value

Type	Description
string

contentAngle

Declaration

get contentAngle(): number;

Property Value

Type	Description
number

currentItemHandler

Declaration

get currentItemHandler(): ItemHandler;

Property Value

Type	Description
ItemHandler

designAtomsApiClient

Declaration

get designAtomsApiClient(): IDesignAtomsApiClient;

Property Value

Type	Description
IDesignAtomsApiClient

disableSmoothing

Declaration

get disableSmoothing(): boolean;

Property Value

Type	Description
boolean

doneButtonCssClass

Declaration

get doneButtonCssClass(): string;

Property Value

Type	Description
string

fontRegistry

Declaration

get fontRegistry(): FontRegistry;

Property Value

Type	Description
FontRegistry

frontEndTextRenderingEnabled

Declaration

get frontEndTextRenderingEnabled(): boolean;

Property Value

Type	Description
boolean

goodViolationIconCssClass

Declaration

get goodViolationIconCssClass(): string;

Property Value

Type	Description
string

grayscaleColorProfileFileId

Declaration

get grayscaleColorProfileFileId(): string;

Property Value

Type	Description
string

handleButtonCssClass

Declaration

get handleButtonCssClass(): string;

Property Value

Type	Description
string

height

Declaration

get height(): number;

Property Value

Type	Description
number

history

Declaration

get history(): History;

Property Value

Type	Description
History_2

hitTestManager

Declaration

get hitTestManager(): IHitTestManager;

Property Value

Type	Description
IHitTestManager

hoverHandler

Declaration

get hoverHandler(): IHoverHandler;

Property Value

Type	Description
IHoverHandler

ignorePermissionsMode

Declaration

get ignorePermissionsMode(): boolean;

Property Value

Type	Description
boolean

initialization

Declaration

get initialization(): boolean;

Property Value

Type	Description
boolean

isInitialized

Declaration

get isInitialized(): boolean;

Property Value

Type	Description
boolean

isSelectionDragging

Declaration

get isSelectionDragging(): boolean;

Property Value

Type	Description
boolean

isSelectionIdle

Declaration

get isSelectionIdle(): boolean;

Property Value

Type	Description
boolean

isSelectionLocked

Declaration

get isSelectionLocked(): boolean;

Property Value

Type	Description
boolean

isSelectionResizing

Declaration

get isSelectionResizing(): boolean;

Property Value

Type	Description
boolean

isSelectionRotating

Declaration

get isSelectionRotating(): boolean;

Property Value

Type	Description
boolean

layers

Declaration

get layers(): LayerCollection;

Property Value

Type	Description
LayerCollection

maxFontSize

Declaration

get maxFontSize(): number;

Property Value

Type	Description
number

maxLeading

Declaration

get maxLeading(): number;

Property Value

Type	Description
number

minFontSize

Declaration

get minFontSize(): number;

Property Value

Type	Description
number

minLeading

Declaration

get minLeading(): number;

Property Value

Type	Description
number

mouseMoveTimeout

Declaration

get mouseMoveTimeout(): number;

Property Value

Type	Description
number

mul

Declaration

get mul(): number;

Property Value

Type	Description
number

multipleSelectionEnabled

Declaration

get multipleSelectionEnabled(): boolean;

Property Value

Type	Description
boolean

offset

Declaration

get offset(): PointF;

Property Value

Type	Description
PointF

placeholderButtonGroupCssClass

Declaration

get placeholderButtonGroupCssClass(): string;

Property Value

Type	Description
string

previewMode

Declaration

get previewMode(): boolean;

Property Value

Type	Description
boolean

qualityBadToGoodChangeScaleBarCssClass

Declaration

get qualityBadToGoodChangeScaleBarCssClass(): string;

Property Value

Type	Description
string

qualityBadToWarningChangeScaleBarCssClass

Declaration

get qualityBadToWarningChangeScaleBarCssClass(): string;

Property Value

Type	Description
string

qualityChangeContainerCssClass

Declaration

get qualityChangeContainerCssClass(): string;

Property Value

Type	Description
string

qualityChangeInfoBarCssClass

Declaration

get qualityChangeInfoBarCssClass(): string;

Property Value

Type	Description
string

qualityChangeScaleBarCssClass

Declaration

get qualityChangeScaleBarCssClass(): string;

Property Value

Type	Description
string

qualityNoAnimationChangeScaleBarCssClass

Declaration

get qualityNoAnimationChangeScaleBarCssClass(): string;

Property Value

Type	Description
string

qualityWarningToGoodChangeScaleBarCssClass

Declaration

get qualityWarningToGoodChangeScaleBarCssClass(): string;

Property Value

Type	Description
string

renderingConfig

Declaration

get renderingConfig(): IRenderingConfig;

Property Value

Type	Description
IRenderingConfig

renderingConfigProvider

Declaration

get renderingConfigProvider(): IRenderingConfigProvider;

Property Value

Type	Description
IRenderingConfigProvider

resizeGripColor

Declaration

get resizeGripColor(): string;

Property Value

Type	Description
string

resizeGripLineColor

Declaration

get resizeGripLineColor(): string;

Property Value

Type	Description
string

resizeGripSize

Declaration

get resizeGripSize(): number;

Property Value

Type	Description
number

rgbColorProfileFileId

Declaration

get rgbColorProfileFileId(): string;

Property Value

Type	Description
string

rotationGripColor

Declaration

get rotationGripColor(): string;

Property Value

Type	Description
string

rotationGripLineColor

Declaration

get rotationGripLineColor(): string;

Property Value

Type	Description
string

rotationGripLineLength

Declaration

get rotationGripLineLength(): number;

Property Value

Type	Description
number

rotationGripSize

Declaration

get rotationGripSize(): number;

Property Value

Type	Description
number

selectionColor

Declaration

get selectionColor(): string;

Property Value

Type	Description
string

selectionWidth

Declaration

get selectionWidth(): number;

Property Value

Type	Description
number

service

Declaration

get service(): Service;

Property Value

Type	Description
Service

sourceSurface

Declaration

get sourceSurface(): Surface;

Property Value

Type	Description
Surface

style

Declaration

get style(): CanvasRendererStyle;

Property Value

Type	Description
CanvasRendererStyle

tags

Declaration

get tags(): Object;

Property Value

Type	Description
Object

targetDpi

Declaration

get targetDpi(): number;

Property Value

Type	Description
number

textEditor

Declaration

get textEditor(): ITextEditor;

Property Value

Type	Description
ITextEditor

textWhizz

Declaration

get textWhizz(): typeof import("@aurigma/text-whizz/TextWhizzJS");

Property Value

Type	Description
typeof import("@aurigma/text-whizz/TextWhizzJS")

translations

Declaration

get translations(): Translations;

Property Value

Type	Description
Translations

viewerConfiguration

Declaration

get viewerConfiguration(): IViewerConfiguration;

Property Value

Type	Description
IViewerConfiguration

violationContainerCssClass

Declaration

get violationContainerCssClass(): string;

Property Value

Type	Description
string

violationWarningButtonCssClass

Declaration

get violationWarningButtonCssClass(): string;

Property Value

Type	Description
string

warningViolationIconCssClass

Declaration

get warningViolationIconCssClass(): string;

Property Value

Type	Description
string

width

Declaration

get width(): number;

Property Value

Type	Description
number

workspace

Declaration

get workspace(): IWorkspace;

Property Value

Type	Description
IWorkspace

workspaceHeight

Declaration

get workspaceHeight(): number;

Property Value

Type	Description
number

workspaceWidth

Declaration

get workspaceWidth(): number;

Property Value

Type	Description
number

zoom

Declaration

get 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

dispose()

Declaration

dispose(): 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

waitFontRegistryInitialized()

Declaration

waitFontRegistryInitialized(): Promise<void>;

Returns

Type	Description
Promise<void>

waitUpdate(itemHandlers)

Declaration

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

Parameters

Type	Name	Description
ItemHandler[]	itemHandlers

Returns

Type	Description
Promise<void[]>

waitUpdateAndExecute(callback)

Declaration

waitUpdateAndExecute(callback: () => void): Promise<void>;

Parameters

Type	Name	Description
() => void	callback

Returns

Type	Description
Promise<void>