Skip to main content

Viewer

Classes​

Viewer​

Extends​

Implements​

Constructors​

Constructor​
new Viewer(namedParameters): Viewer;
Parameters​
ParameterType
namedParametersIOptions
Returns​

Viewer

Overrides​

BaseViewer.constructor

Properties​

containersFlatListChangedEvent​
readonly containersFlatListChangedEvent: any;
frontEndTextRenderingEnabled​
readonly frontEndTextRenderingEnabled: boolean;
preventClickHandleClass​
static preventClickHandleClass: string = "preventCanvasClickHandle";
preventKeyHandleClass​
static preventKeyHandleClass: string = "preventCanvasKeyHandle";

Accessors​

actualRulerWidth​
Get Signature​
get actualRulerWidth(): number;
Returns​

number

Inherited from​

BaseViewer.actualRulerWidth

actualSizeHorizontalScale​
Get Signature​
get actualSizeHorizontalScale(): number;

Gets value which represents the ratio of screen horizontal resolution to the canvas resolution.

Returns​

number

Inherited from​

BaseViewer.actualSizeHorizontalScale

actualSizeVerticalScale​
Get Signature​
get actualSizeVerticalScale(): number;
Returns​

number

backendUrl​
Get Signature​
get backendUrl(): string;
Returns​

string

Set Signature​
set backendUrl(value): void;
Parameters​
ParameterType
valuestring
Returns​

void

bestFitWhiteSpacePc​
Get Signature​
get bestFitWhiteSpacePc(): number;

Gets or sets white space (in percent from 1 to 99) between content maximal demention and canvas

Returns​

number

Set Signature​
set bestFitWhiteSpacePc(v): void;
Parameters​
ParameterType
vnumber
Returns​

void

Inherited from​

BaseViewer.bestFitWhiteSpacePc

canvas​
Get Signature​
get canvas(): Canvas;
Returns​

Canvas

clearSelectionOnDocumentClick​
Get Signature​
get clearSelectionOnDocumentClick(): boolean;
Returns​

boolean

Set Signature​
set clearSelectionOnDocumentClick(value): void;
Parameters​
ParameterType
valueboolean
Returns​

void

clearSelectionOnViewerClick​
Get Signature​
get clearSelectionOnViewerClick(): boolean;
Returns​

boolean

Set Signature​
set clearSelectionOnViewerClick(value): void;
Parameters​
ParameterType
valueboolean
Returns​

void

clientSideOptions​
Get Signature​
get clientSideOptions(): object;
Deprecated​
Returns​

object

Inherited from​

BaseViewer.clientSideOptions

colorParser​
Get Signature​
get colorParser(): IColorParser;
Returns​

IColorParser

colorPreviewService​
Get Signature​
get colorPreviewService(): IListenableColorPreviewService;
Returns​

IListenableColorPreviewService

commandManager​
Get Signature​
get commandManager(): CommandManager;
Returns​

CommandManager

configuration​
Get Signature​
get configuration(): IViewerConfiguration;
Returns​

IViewerConfiguration

Set Signature​
set configuration(conf): void;
Parameters​
ParameterType
confIViewerConfiguration
Returns​

void

containersFlatList​
Get Signature​
get containersFlatList(): Container[];
Returns​

Container[]

contentAngle​
Get Signature​
get contentAngle(): number;
Returns​

number

Set Signature​
set contentAngle(value): void;
Parameters​
ParameterType
valuenumber
Returns​

void

Implementation of​

IViewer.contentAngle

Inherited from​

BaseViewer.contentAngle

contentCtx​
Get Signature​
get contentCtx(): HTMLElement;
Returns​

HTMLElement

Inherited from​

BaseViewer.contentCtx

contentHeight​
Get Signature​
get contentHeight(): number;

Content height in css pixels

Returns​

number

Overrides​

BaseViewer.contentHeight

contentWidth​
Get Signature​
get contentWidth(): number;

Content width in css pixels

Returns​

number

Overrides​

BaseViewer.contentWidth

currentItem​
Get Signature​
get currentItem(): any;
Returns​

any

delayedRefreshTimeout​
Get Signature​
get delayedRefreshTimeout(): number;

Amount of milliseconds to wait before delayed refresh will be invoked

Returns​

number

Set Signature​
set delayedRefreshTimeout(v): void;
Parameters​
ParameterType
vnumber
Returns​

void

Inherited from​

BaseViewer.delayedRefreshTimeout

designAtomsApiClient​
Get Signature​
get designAtomsApiClient(): IDesignAtomsApiClient;
Returns​

IDesignAtomsApiClient

element​
Get Signature​
get element(): HTMLDivElement;
Returns​

HTMLDivElement

Inherited from​

BaseViewer.element

eventManager​
Get Signature​
get eventManager(): IEventManager;
Returns​

IEventManager

exceptionDescription​
Get Signature​
get exceptionDescription(): string;

The value which represents description of exception which was thrown during calling remote scripting method

Deprecated​
Returns​

string

Inherited from​

BaseViewer.exceptionDescription

gridHandler​
Get Signature​
get gridHandler(): GridHandler;
Returns​

GridHandler

height​
Get Signature​
get height(): any;

Gets the height (in pixels) of the control area.

Returns​

any

Inherited from​

BaseViewer.height

history​
Get Signature​
get history(): History;
Returns​

History

hitTestManager​
Get Signature​
get hitTestManager(): IHitTestManager;
Returns​

IHitTestManager

holderBounds​
Get Signature​
get holderBounds(): object;
Returns​

object

height​
height: any;
offsetHeight​
offsetHeight: any;
offsetLeft​
offsetLeft: any;
offsetTop​
offsetTop: any;
offsetWidth​
offsetWidth: any;
width​
width: any;
Inherited from​

BaseViewer.holderBounds

id​
Get Signature​
get id(): string;
Returns​

string

Inherited from​

BaseViewer.id

inputHandlerManager​
Get Signature​
get inputHandlerManager(): InputHandlerManager;
Returns​

InputHandlerManager

interactiveContainers​
Get Signature​
get interactiveContainers(): Container[];

ProductHandler.interactiveContainers

Returns​

Container[]

Set Signature​
set interactiveContainers(value): void;
Parameters​
ParameterType
valueContainer[]
Returns​

void

interactiveZonesHandler​
Get Signature​
get interactiveZonesHandler(): IInteractiveZonesHandler;
Returns​

IInteractiveZonesHandler

itemsDataApplier​
Get Signature​
get itemsDataApplier(): ItemsDataApplier;
Returns​

ItemsDataApplier

licenseHandler​
Get Signature​
get licenseHandler(): LicenseHandler;
Returns​

LicenseHandler

minZoom​
Get Signature​
get minZoom(): number;

Gets the minimum allowed zoom value

Remarks​

Zoom values are measured in percents/100. It means that value = 1 specify 100% zoom (i.e. actual size), value = 10 means 1000% zoom (10x), value = 0,5 means 50% zoom (half), etc.

Returns​

number

Set Signature​
set minZoom(value): void;
Parameters​
ParameterType
valuenumber
Returns​

void

Inherited from​

BaseViewer.minZoom

modalBgClass​
Get Signature​
get modalBgClass(): string;

Gets modal background class name.

Returns​

string

Set Signature​
set modalBgClass(value): void;
Parameters​
ParameterType
valuestring
Returns​

void

pinchZoomEnabled​
Get Signature​
get pinchZoomEnabled(): boolean;
Returns​

boolean

Set Signature​
set pinchZoomEnabled(v): void;
Parameters​
ParameterType
vboolean
Returns​

void

Inherited from​

BaseViewer.pinchZoomEnabled

previewMode​
Get Signature​
get previewMode(): boolean;
Returns​

boolean

Set Signature​
set previewMode(value): void;
Parameters​
ParameterType
valueboolean
Returns​

void

productHandler​
Get Signature​
get productHandler(): ProductHandler;
Returns​

ProductHandler

productThemeManager​
Get Signature​
get productThemeManager(): ProductThemeManager;
Returns​

ProductThemeManager

renderingConfig​
Get Signature​
get renderingConfig(): any;
Returns​

any

renderingConfigProvider​
Get Signature​
get renderingConfigProvider(): IRenderingConfigProvider;
Returns​

IRenderingConfigProvider

returnValue​
Get Signature​
get returnValue(): string;
Returns​

string

Inherited from​

BaseViewer.returnValue

rgbColorParser​
Get Signature​
get rgbColorParser(): IRgbColorParser;
Returns​

IRgbColorParser

rulerDivision​
Get Signature​
get rulerDivision(): number;
Returns​

number

Set Signature​
set rulerDivision(v): void;
Parameters​
ParameterType
vnumber
Returns​

void

Inherited from​

BaseViewer.rulerDivision

rulerEnabled​
Get Signature​
get rulerEnabled(): boolean;
Returns​

boolean

Set Signature​
set rulerEnabled(v): void;
Parameters​
ParameterType
vboolean
Returns​

void

Inherited from​

BaseViewer.rulerEnabled

rulerOffsetX​
Get Signature​
get rulerOffsetX(): number;
Returns​

number

Set Signature​
set rulerOffsetX(v): void;
Parameters​
ParameterType
vnumber
Returns​

void

Inherited from​

BaseViewer.rulerOffsetX

rulerOffsetY​
Get Signature​
get rulerOffsetY(): number;
Returns​

number

Set Signature​
set rulerOffsetY(v): void;
Parameters​
ParameterType
vnumber
Returns​

void

Inherited from​

BaseViewer.rulerOffsetY

rulerScale​
Get Signature​
get rulerScale(): number;
Returns​

number

Set Signature​
set rulerScale(v): void;
Parameters​
ParameterType
vnumber
Returns​

void

Inherited from​

BaseViewer.rulerScale

rulerWidth​
Get Signature​
get rulerWidth(): number;
Returns​

number

Set Signature​
set rulerWidth(v): void;
Parameters​
ParameterType
vnumber
Returns​

void

Inherited from​

BaseViewer.rulerWidth

safetyLinesHandler​
Get Signature​
get safetyLinesHandler(): SafetyLinesHandler;
Returns​

SafetyLinesHandler

screenXDpi​
Get Signature​
get screenXDpi(): number;
Returns​

number

Set Signature​
set screenXDpi(v): void;
Parameters​
ParameterType
vnumber
Returns​

void

Inherited from​

BaseViewer.screenXDpi

screenYDpi​
Get Signature​
get screenYDpi(): number;
Returns​

number

Set Signature​
set screenYDpi(v): void;
Parameters​
ParameterType
vnumber
Returns​

void

Inherited from​

BaseViewer.screenYDpi

scrollBarsStyle​
Get Signature​
get scrollBarsStyle(): ScrollBarsStyle;
Returns​

ScrollBarsStyle

Set Signature​
set scrollBarsStyle(value): void;
Parameters​
ParameterType
valueScrollBarsStyle
Returns​

void

Inherited from​

BaseViewer.scrollBarsStyle

scrollBarWidth​
Get Signature​
get scrollBarWidth(): number;
Returns​

number

Inherited from​

BaseViewer.scrollBarWidth

scrollingPosition​
Get Signature​
get scrollingPosition(): PointF;

Gets/sets the position of the scroll bars

Returns​

PointF

Set Signature​
set scrollingPosition(value): void;
Parameters​
ParameterType
valuePointF
Returns​

void

Implementation of​

IViewer.scrollingPosition

Inherited from​

BaseViewer.scrollingPosition

scrollingSize​
Get Signature​
get scrollingSize(): any;

Gets a scroll bar length (in other words, the right-bottom point of the image fragment which is out of the visible area).

Returns​

any

Implementation of​

IViewer.scrollingSize

Inherited from​

BaseViewer.scrollingSize

selectedItems​
Get Signature​
get selectedItems(): Item[];
Returns​

Item[]

Set Signature​
set selectedItems(value): void;
Parameters​
ParameterType
valueItem[]
Returns​

void

status​
Get Signature​
get status(): UpdateStatus;

The value which represents current status of Viewer control

Returns​

UpdateStatus

Inherited from​

BaseViewer.status

surface​
Get Signature​
get surface(): Surface;
Returns​

Surface

Set Signature​
set surface(value): void;
Parameters​
ParameterType
valueSurface
Returns​

void

surfaceHandler​
Get Signature​
get surfaceHandler(): SurfaceHandler;
Returns​

SurfaceHandler

textEditorMode​
Get Signature​
get textEditorMode(): TextEditorMode;
Returns​

TextEditorMode

Set Signature​
set textEditorMode(value): void;
Parameters​
ParameterType
valueTextEditorMode
Returns​

void

textFormattingEnabled​
Get Signature​
get textFormattingEnabled(): boolean;
Returns​

boolean

Set Signature​
set textFormattingEnabled(v): void;
Parameters​
ParameterType
vboolean
Returns​

void

userChanges​
Get Signature​
get userChanges(): UserChangesService;
Returns​

UserChangesService

userEditContainer​
Get Signature​
get userEditContainer(): Container;
Returns​

Container

Set Signature​
set userEditContainer(value): void;
Parameters​
ParameterType
valueContainer
Returns​

void

variableItemHelper​
Get Signature​
get variableItemHelper(): VariableItemHelper;
Returns​

VariableItemHelper

viewportAlignment​
Get Signature​
get viewportAlignment(): ViewportAlignment;

Gets/sets a value that specifies content alignment in the control.

Returns​

ViewportAlignment

Set Signature​
set viewportAlignment(v): void;
Parameters​
ParameterType
vViewportAlignment
Returns​

void

Inherited from​

BaseViewer.viewportAlignment

viewportDiv​
Get Signature​
get viewportDiv(): HTMLDivElement;
Returns​

HTMLDivElement

violationService​
Get Signature​
get violationService(): ViolationService;
Returns​

ViolationService

violationServiceFactory​
Get Signature​
get violationServiceFactory(): ViolationServiceFactory;
Returns​

ViolationServiceFactory

watermarkConfig​
Get Signature​
get watermarkConfig(): WatermarkConfig;
Returns​

WatermarkConfig

Set Signature​
set watermarkConfig(value): void;
Parameters​
ParameterType
valueWatermarkConfig
Returns​

void

whitespaceDiv​
Get Signature​
get whitespaceDiv(): HTMLDivElement;
Returns​

HTMLDivElement

width​
Get Signature​
get width(): any;

Gets the width (in pixels) of the control area.

Returns​

any

Inherited from​

BaseViewer.width

workspaceHeight​
Get Signature​
get workspaceHeight(): number;

Gets a value that represents the height (in points) of the associated with this

Returns​

number

Inherited from​

BaseViewer.workspaceHeight

workspaceWidth​
Get Signature​
get workspaceWidth(): number;

Gets a value that represents the width (in points) of the associated with this

Returns​

number

Inherited from​

BaseViewer.workspaceWidth

zoom​
Get Signature​
get zoom(): number;
Returns​

number

Inherited from​

BaseViewer.zoom

zoomConfig​
Get Signature​
get zoomConfig(): IRangeParams;
Returns​

IRangeParams

Overrides​

BaseViewer.zoomConfig

zoomMode​
Get Signature​
get zoomMode(): ZoomMode;
Returns​

ZoomMode

Set Signature​
set zoomMode(v): void;
Parameters​
ParameterType
vZoomMode
Returns​

void

Inherited from​

BaseViewer.zoomMode

zoomQuality​
Get Signature​
get zoomQuality(): ZoomQuality;

Gets a value that specifies a zoom quality.

Returns​

ZoomQuality

Inherited from​

BaseViewer.zoomQuality

Methods​

abort()​
abort(): void;
Returns​

void

Inherited from​

BaseViewer.abort

calculateZoomByZoomMode()​
calculateZoomByZoomMode(
zoomMode,
size?,
bestFitWhiteSpacePcArg?): number;
Parameters​
ParameterTypeDefault value
zoomModeZoomModeundefined
sizeSizeFnull
bestFitWhiteSpacePcArgnumbernull
Returns​

number

Inherited from​

BaseViewer.calculateZoomByZoomMode

clearRenderCtx()​
clearRenderCtx(ctx): void;
Parameters​
ParameterType
ctxHTMLElement
Returns​

void

Inherited from​

BaseViewer.clearRenderCtx

delayedRefresh()​
delayedRefresh(): void;

Indicates that the control needs to be refreshed. The actual refreshing is applied when the user does not update the control state (such as scroll position, zoom value) in one second.

Returns​

void

Inherited from​

BaseViewer.delayedRefresh

dispose()​
dispose(): void;

Removes the current Viewer from the application.

Returns​

void

Overrides​

BaseViewer.dispose

ensureFocus()​
ensureFocus(): void;
Returns​

void

exitEditMode()​
exitEditMode(): Promise<void>;
Returns​

Promise<void>

getActualScrollPosition()​
getActualScrollPosition(): any;
Returns​

any

Inherited from​

BaseViewer.getActualScrollPosition

getCurrentSurfacePreview()​
getCurrentSurfacePreview(options?): Promise<Blob>;
Parameters​
ParameterTypeDescription
options?IPreviewOptionsPreview rendering options
Returns​

Promise<Blob>

Blob containing the preview image of the current surface

getHandler()​
Call Signature​
getHandler(item): ItemHandler;
Parameters​
ParameterType
itemBaseItem
Returns​

ItemHandler

Call Signature​
getHandler(item): PlainTextItemHandler;
Parameters​
ParameterType
itemPlainTextItem
Returns​

PlainTextItemHandler

Call Signature​
getHandler(item): ShapeItemHandler;
Parameters​
ParameterType
itemShapeItem
Returns​

ShapeItemHandler

Call Signature​
getHandler(item): RectangleItemHandler;
Parameters​
ParameterType
itemRectangleItem
Returns​

RectangleItemHandler

Call Signature​
getHandler(item): PlaceholderItemHandler;
Parameters​
ParameterType
itemPlaceholderItem
Returns​

PlaceholderItemHandler

Call Signature​
getHandler(item): BoundedTextItemHandler;
Parameters​
ParameterType
itemBoundedTextItem
Returns​

BoundedTextItemHandler

Call Signature​
getHandler(item): ImageItemHandler;
Parameters​
ParameterType
itemImageItem
Returns​

ImageItemHandler

Call Signature​
getHandler(item): PlaceholderItemHandler;
Parameters​
ParameterType
itemPlaceholderItem
Returns​

PlaceholderItemHandler

Call Signature​
getHandler(item): AutoScaledTextItemHandler;
Parameters​
ParameterType
itemAutoScaledTextItem
Returns​

AutoScaledTextItemHandler

Call Signature​
getHandler(item): ArchedTextItemHandler;
Parameters​
ParameterType
itemArchedTextItem
Returns​

ArchedTextItemHandler

Call Signature​
getHandler<THandler>(item): THandler;
Type Parameters​
Type Parameter
THandler extends ItemHandler
Parameters​
ParameterType
itemItem
Returns​

THandler

getMaxZoom()​
getMaxZoom(): number;

Gets the maximum allowed zoom value.

Returns​

number

Remarks​

Zoom values are measured in percents/100. It means that value = 1 specify 100% zoom (i.e. actual size), value = 10 means 1000% zoom (10x), value = 0,5 means 50% zoom (half), etc.

Overrides​

BaseViewer.getMaxZoom

getScrollBars()​
getScrollBars(): object;
Returns​

object

horizontal​
horizontal: number;
vertical​
vertical: number;
Inherited from​

BaseViewer.getScrollBars

getSurfacePreview()​
getSurfacePreview(surfaceIndex, options?): Promise<Blob>;
Parameters​
ParameterTypeDescription
surfaceIndexnumberIndex of the surface to preview
options?IPreviewOptionsPreview rendering options
Returns​

Promise<Blob>

Blob containing the preview image of given surface

getUserEditPrintArea()​
getUserEditPrintArea(): any;
Returns​

any

getUserEditSurface()​
getUserEditSurface(): Surface;
Returns​

Surface

getViewportLocation()​
getViewportLocation(): any;
Returns​

any

Inherited from​

BaseViewer.getViewportLocation

ignoreDocumentClickOnce()​
ignoreDocumentClickOnce(): void;
Returns​

void

Inherited from​

BaseViewer.ignoreDocumentClickOnce

ignoreSelectionClick()​
ignoreSelectionClick(e): boolean;
Parameters​
ParameterType
eMouseEvent
Returns​

boolean

initialize()​
initialize(namedParameters?): void;
Parameters​
ParameterType
namedParameters{ ignore?: boolean; intervalCheckLoop?: any; readonlyCanvasMode?: boolean; }
namedParameters.ignore?boolean
namedParameters.intervalCheckLoop?any
namedParameters.readonlyCanvasMode?boolean
Returns​

void

Overrides​

BaseViewer.initialize

initTextEditor()​
initTextEditor(
fontService,
useSimpleFontList,
textEditor?,
textInputIssueUserConfirmationDelegate?): void;
Parameters​
ParameterTypeDefault value
fontServiceIFontServiceundefined
useSimpleFontListbooleanundefined
textEditorTextEditorModeTextEditorMode.Default
textInputIssueUserConfirmationDelegateFunc<Promise<boolean>, string>null
Returns​

void

lockViewer()​
lockViewer(): void;
Returns​

void

onDocumentClick()​
onDocumentClick(e): void;
Parameters​
ParameterType
eMouseEvent
Returns​

void

Overrides​
BaseViewer._onDocumentClick
onResize()​
onResize(sender, updateButtonGroup): void;
Parameters​
ParameterType
senderany
updateButtonGroupany
Returns​

void

Overrides​
BaseViewer._onResize
onResize()​
onResize(h): void;
Parameters​
ParameterType
hany
Returns​

void

Inherited from​

BaseViewer.onResize

onResize()​
onResize(h): void;
Parameters​
ParameterType
hany
Returns​

void

Inherited from​

BaseViewer.onResize

queryItems()​
queryItems(selectors, queryOptions?): Item[];
Parameters​
ParameterType
selectorsstring
queryOptions?IQueryOptions
Returns​

Item[]

refresh()​
refresh(): void;

Refresh the control immediately

Returns​

void

Overrides​
BaseViewer._refresh
refresh()​
refresh(): void;

Refreshes the control immediately.

Returns​

void

Inherited from​

BaseViewer.refresh

releaseHandler()​
releaseHandler(itemHandler): void;
Parameters​
ParameterType
itemHandlerItemHandler
Returns​

void

scrolled()​
scrolled(h): void;

Fires when scroll position of the control is changed

Parameters​
ParameterType
hany
Returns​

void

Inherited from​

BaseViewer.scrolled

scrolled()​
scrolled(h): void;
Parameters​
ParameterType
hany
Returns​

void

Inherited from​

BaseViewer.scrolled

setCursor()​
setCursor(cursor, onBody?): void;
Parameters​
ParameterTypeDefault value
cursorCursorundefined
onBodybooleanfalse
Returns​

void

Inherited from​

BaseViewer.setCursor

setInputHandlerType()​
Call Signature​
setInputHandlerType(
type,
args,
options?): any;
Parameters​
ParameterType
typeCreate
argsICreateInputHandlerArgs
options?ISetInputHandlerOptions
Returns​

any

Call Signature​
setInputHandlerType(type): any;
Parameters​
ParameterType
typeDefault
Returns​

any

Call Signature​
setInputHandlerType(type): any;
Parameters​
ParameterType
typeLocked
Returns​

any

Call Signature​
setInputHandlerType(
type,
args,
options?): any;
Parameters​
ParameterType
typeSelectPixel
argsIInputHandlerArgs
options?ISetInputHandlerOptions
Returns​

any

setIntervalCheckLoop()​
setIntervalCheckLoop(intervalCheckLoop): void;
Parameters​
ParameterType
intervalCheckLoopIIntervalCheckLoop
Returns​

void

Inherited from​

BaseViewer.setIntervalCheckLoop

setMaxZoom()​
setMaxZoom(value): void;
Parameters​
ParameterType
valuenumber
Returns​

void

Inherited from​

BaseViewer.setMaxZoom

setTextEditorMode()​
setTextEditorMode(value): void;
Parameters​
ParameterType
valuenumber
Returns​

void

setTextWhizzModule()​
setTextWhizzModule(textWhizz): void;
Parameters​
ParameterType
textWhizzany
Returns​

void

setZoom()​
setZoom(
value,
params?,
ignoreZoomConfigRestrictions?,
withoutUpdate?): number;
Parameters​
ParameterTypeDefault value
valuenumberundefined
params?ZoomParamsundefined
ignoreZoomConfigRestrictions?booleanfalse
withoutUpdate?booleanfalse
Returns​

number

Overrides​

BaseViewer.setZoom

statusChanged()​
statusChanged(h): void;

Fires when status is updated.

Parameters​
ParameterType
hany
Returns​

void

Inherited from​

BaseViewer.statusChanged

statusChanged()​
statusChanged(h): void;
Parameters​
ParameterType
hany
Returns​

void

Inherited from​

BaseViewer.statusChanged

unlockViewer()​
unlockViewer(): void;

Hides the semi-transparent rectangle when it is shown over the Viewer

Returns​

void

Remarks​

To show this rectangle use the Viewer.lockViewer method.

updateWhitespace()​
updateWhitespace(): void;
Returns​

void

waitUpdate()​
waitUpdate(): Promise<void>;
Returns​

Promise<void>

zoomed()​
zoomed(h): void;

Fires when the content is zoomed in the control

Parameters​
ParameterType
hany
Returns​

void

Inherited from​

BaseViewer.zoomed

zoomed()​
zoomed(h): void;
Parameters​
ParameterType
hany
Returns​

void

Inherited from​

BaseViewer.zoomed

zoomToItems()​
zoomToItems(items?): void;
Parameters​
ParameterTypeDefault value
itemsBaseItem[][]
Returns​

void

Inherited from​

BaseViewer.zoomToItems

zoomToRectangle()​
zoomToRectangle(rect): void;
Parameters​
ParameterType
rectRectangleF
Returns​

void

zoomToSelection()​
zoomToSelection(): void;
Returns​

void

Overrides​

BaseViewer.zoomToSelection

Interfaces​

IOptions​

Properties​

backendUrl?​
optional backendUrl?: string;
canvasBackground?​
optional canvasBackground?: CanvasBackground;
frontEndTextRenderingEnabled?​
optional frontEndTextRenderingEnabled?: boolean;
holderElement​
holderElement: HTMLDivElement;
ignorePermissionsMode?​
optional ignorePermissionsMode?: boolean;
keyInputElement?​
optional keyInputElement?: HTMLDivElement;
productViewerPartId?​
optional productViewerPartId?: string;
readonlyCanvasMode?​
optional readonlyCanvasMode?: boolean;
rulerEnabled?​
optional rulerEnabled?: boolean;
surface?​
optional surface?: Surface;
zone?​
optional zone?: any;

Type Aliases​

CanvasBackground​

type CanvasBackground =
| "chess"
| {
color: string;
};

ContainersChangeData​

type ContainersChangeData = object;

Properties​

added​
added: MultiSelectMode[];
removed​
removed: MultiSelectMode[];

ModuleOfTextWhizz​

type ModuleOfTextWhizz = object;

Properties​

module​
module: typeof MultiSelectMode;
Was this page helpful?