Viewer
Classes
Viewer
Extends
Implements
Constructors
Constructor
new Viewer(namedParameters): Viewer;
Parameters
| Parameter | Type |
|---|---|
namedParameters | IOptions |
Returns
Overrides
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
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
| Parameter | Type |
|---|---|
value | string |
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
| Parameter | Type |
|---|---|
v | number |
Returns
void
Inherited from
BaseViewer.bestFitWhiteSpacePc
canvas
Get Signature
get canvas(): Canvas;
Returns
clearSelectionOnDocumentClick
Get Signature
get clearSelectionOnDocumentClick(): boolean;
Returns
boolean
Set Signature
set clearSelectionOnDocumentClick(value): void;
Parameters
| Parameter | Type |
|---|---|
value | boolean |
Returns
void
clearSelectionOnViewerClick
Get Signature
get clearSelectionOnViewerClick(): boolean;
Returns
boolean
Set Signature
set clearSelectionOnViewerClick(value): void;
Parameters
| Parameter | Type |
|---|---|
value | boolean |
Returns
void
clientSideOptions
Get Signature
get clientSideOptions(): object;
Deprecated
Returns
object
Inherited from
colorParser
Get Signature
get colorParser(): IColorParser;
Returns
colorPreviewService
Get Signature
get colorPreviewService(): IListenableColorPreviewService;
Returns
IListenableColorPreviewService
commandManager
Get Signature
get commandManager(): CommandManager;
Returns
configuration
Get Signature
get configuration(): IViewerConfiguration;
Returns
Set Signature
set configuration(conf): void;
Parameters
| Parameter | Type |
|---|---|
conf | IViewerConfiguration |
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
| Parameter | Type |
|---|---|
value | number |
Returns
void
Implementation of
Inherited from
contentCtx
Get Signature
get contentCtx(): HTMLElement;
Returns
HTMLElement
Inherited from
contentHeight
Get Signature
get contentHeight(): number;
Content height in css pixels
Returns
number
Overrides
contentWidth
Get Signature
get contentWidth(): number;
Content width in css pixels
Returns
number
Overrides
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
| Parameter | Type |
|---|---|
v | number |
Returns
void
Inherited from
BaseViewer.delayedRefreshTimeout
designAtomsApiClient
Get Signature
get designAtomsApiClient(): IDesignAtomsApiClient;
Returns
element
Get Signature
get element(): HTMLDivElement;
Returns
HTMLDivElement
Inherited from
eventManager
Get Signature
get eventManager(): IEventManager;
Returns
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
height
Get Signature
get height(): any;
Gets the height (in pixels) of the control area.
Returns
any
Inherited from
history
Get Signature
get history(): History;
Returns
hitTestManager
Get Signature
get hitTestManager(): IHitTestManager;
Returns
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
id
Get Signature
get id(): string;
Returns
string
Inherited from
inputHandlerManager
Get Signature
get inputHandlerManager(): InputHandlerManager;
Returns
interactiveContainers
Get Signature
get interactiveContainers(): Container[];
ProductHandler.interactiveContainers
Returns
Container[]
Set Signature
set interactiveContainers(value): void;
Parameters
| Parameter | Type |
|---|---|
value | Container[] |
Returns
void
interactiveZonesHandler
Get Signature
get interactiveZonesHandler(): IInteractiveZonesHandler;
Returns
itemsDataApplier
Get Signature
get itemsDataApplier(): ItemsDataApplier;
Returns
licenseHandler
Get Signature
get licenseHandler(): LicenseHandler;
Returns
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
| Parameter | Type |
|---|---|
value | number |
Returns
void
Inherited from
modalBgClass
Get Signature
get modalBgClass(): string;
Gets modal background class name.
Returns
string
Set Signature
set modalBgClass(value): void;
Parameters
| Parameter | Type |
|---|---|
value | string |
Returns
void
pinchZoomEnabled
Get Signature
get pinchZoomEnabled(): boolean;
Returns
boolean
Set Signature
set pinchZoomEnabled(v): void;
Parameters
| Parameter | Type |
|---|---|
v | boolean |
Returns
void
Inherited from
previewMode
Get Signature
get previewMode(): boolean;
Returns
boolean
Set Signature
set previewMode(value): void;
Parameters
| Parameter | Type |
|---|---|
value | boolean |
Returns
void
productHandler
Get Signature
get productHandler(): ProductHandler;
Returns
productThemeManager
Get Signature
get productThemeManager(): ProductThemeManager;
Returns
renderingConfig
Get Signature
get renderingConfig(): any;
Returns
any
renderingConfigProvider
Get Signature
get renderingConfigProvider(): IRenderingConfigProvider;
Returns
returnValue
Get Signature
get returnValue(): string;
Returns
string
Inherited from
rgbColorParser
Get Signature
get rgbColorParser(): IRgbColorParser;
Returns
rulerDivision
Get Signature
get rulerDivision(): number;
Returns
number
Set Signature
set rulerDivision(v): void;
Parameters
| Parameter | Type |
|---|---|
v | number |
Returns
void
Inherited from
rulerEnabled
Get Signature
get rulerEnabled(): boolean;
Returns
boolean
Set Signature
set rulerEnabled(v): void;
Parameters
| Parameter | Type |
|---|---|
v | boolean |
Returns
void
Inherited from
rulerOffsetX
Get Signature
get rulerOffsetX(): number;
Returns
number
Set Signature
set rulerOffsetX(v): void;
Parameters
| Parameter | Type |
|---|---|
v | number |
Returns
void
Inherited from
rulerOffsetY
Get Signature
get rulerOffsetY(): number;
Returns
number
Set Signature
set rulerOffsetY(v): void;
Parameters
| Parameter | Type |
|---|---|
v | number |
Returns
void
Inherited from
rulerScale
Get Signature
get rulerScale(): number;
Returns
number
Set Signature
set rulerScale(v): void;
Parameters
| Parameter | Type |
|---|---|
v | number |
Returns
void
Inherited from
rulerWidth
Get Signature
get rulerWidth(): number;
Returns
number
Set Signature
set rulerWidth(v): void;
Parameters
| Parameter | Type |
|---|---|
v | number |
Returns
void
Inherited from
safetyLinesHandler
Get Signature
get safetyLinesHandler(): SafetyLinesHandler;
Returns
screenXDpi
Get Signature
get screenXDpi(): number;
Returns
number
Set Signature
set screenXDpi(v): void;
Parameters
| Parameter | Type |
|---|---|
v | number |
Returns
void
Inherited from
screenYDpi
Get Signature
get screenYDpi(): number;
Returns
number
Set Signature
set screenYDpi(v): void;
Parameters
| Parameter | Type |
|---|---|
v | number |
Returns
void
Inherited from
scrollBarsStyle
Get Signature
get scrollBarsStyle(): ScrollBarsStyle;
Returns
Set Signature
set scrollBarsStyle(value): void;
Parameters
| Parameter | Type |
|---|---|
value | ScrollBarsStyle |
Returns
void
Inherited from
scrollBarWidth
Get Signature
get scrollBarWidth(): number;
Returns
number
Inherited from
scrollingPosition
Get Signature
get scrollingPosition(): PointF;
Gets/sets the position of the scroll bars
Returns
PointF
Set Signature
set scrollingPosition(value): void;
Parameters
| Parameter | Type |
|---|---|
value | PointF |
Returns
void
Implementation of
Inherited from
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
Inherited from
selectedItems
Get Signature
get selectedItems(): Item[];
Returns
Item[]
Set Signature
set selectedItems(value): void;
Parameters
| Parameter | Type |
|---|---|
value | Item[] |
Returns
void
status
Get Signature
get status(): UpdateStatus;
The value which represents current status of Viewer control
Returns
Inherited from
surface
Get Signature
get surface(): Surface;
Returns
Surface
Set Signature
set surface(value): void;
Parameters
| Parameter | Type |
|---|---|
value | Surface |
Returns
void
surfaceHandler
Get Signature
get surfaceHandler(): SurfaceHandler;
Returns
textEditorMode
Get Signature
get textEditorMode(): TextEditorMode;
Returns
Set Signature
set textEditorMode(value): void;
Parameters
| Parameter | Type |
|---|---|
value | TextEditorMode |
Returns
void
textFormattingEnabled
Get Signature
get textFormattingEnabled(): boolean;
Returns
boolean
Set Signature
set textFormattingEnabled(v): void;
Parameters
| Parameter | Type |
|---|---|
v | boolean |
Returns
void
userEditContainer
Get Signature
get userEditContainer(): SurfaceContainer;
Returns
SurfaceContainer
Set Signature
set userEditContainer(value): void;
Parameters
| Parameter | Type |
|---|---|
value | SurfaceContainer |
Returns
void
variableItemHelper
Get Signature
get variableItemHelper(): VariableItemHelper;
Returns
viewportAlignment
Get Signature
get viewportAlignment(): ViewportAlignment;
Gets/sets a value that specifies content alignment in the control.
Returns
Set Signature
set viewportAlignment(v): void;
Parameters
| Parameter | Type |
|---|---|
v | ViewportAlignment |
Returns
void
Inherited from
viewportDiv
Get Signature
get viewportDiv(): HTMLDivElement;
Returns
HTMLDivElement
violationService
Get Signature
get violationService(): ViolationService;
Returns
violationServiceFactory
Get Signature
get violationServiceFactory(): ViolationServiceFactory;
Returns
watermarkConfig
Get Signature
get watermarkConfig(): WatermarkConfig;
Returns
WatermarkConfig
Set Signature
set watermarkConfig(value): void;
Parameters
| Parameter | Type |
|---|---|
value | WatermarkConfig |
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
workspaceHeight
Get Signature
get workspaceHeight(): number;
Gets a value that represents the height (in points) of the associated with this
Returns
number
Inherited from
workspaceWidth
Get Signature
get workspaceWidth(): number;
Gets a value that represents the width (in points) of the associated with this
Returns
number
Inherited from
zoom
Get Signature
get zoom(): number;
Returns
number
Inherited from
zoomConfig
Get Signature
get zoomConfig(): IRangeParams;
Returns
Overrides
zoomMode
Get Signature
get zoomMode(): ZoomMode;
Returns
Set Signature
set zoomMode(v): void;
Parameters
| Parameter | Type |
|---|---|
v | ZoomMode |
Returns
void
Inherited from
zoomQuality
Get Signature
get zoomQuality(): ZoomQuality;
Gets a value that specifies a zoom quality.
Returns
Inherited from
Methods
abort()
abort(): void;
Returns
void
Inherited from
calculateZoomByZoomMode()
calculateZoomByZoomMode(
zoomMode,
size?,
bestFitWhiteSpacePcArg?): number;
Parameters
| Parameter | Type | Default value |
|---|---|---|
zoomMode | ZoomMode | undefined |
size | SizeF | null |
bestFitWhiteSpacePcArg | number | null |
Returns
number
Inherited from
BaseViewer.calculateZoomByZoomMode
clearRenderCtx()
clearRenderCtx(ctx): void;
Parameters
| Parameter | Type |
|---|---|
ctx | HTMLElement |
Returns
void
Inherited from
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
dispose()
dispose(): void;
Removes the current Viewer from the application.
Returns
void
Overrides
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
| Parameter | Type | Description |
|---|---|---|
options? | IPreviewOptions | Preview rendering options |
Returns
Promise<Blob>
Blob containing the preview image of the current surface
getHandler()
Call Signature
getHandler(item): ItemHandler;
Parameters
| Parameter | Type |
|---|---|
item | BaseItem |
Returns
Call Signature
getHandler(item): PlainTextItemHandler;
Parameters
| Parameter | Type |
|---|---|
item | PlainTextItem |
Returns
Call Signature
getHandler(item): ShapeItemHandler;
Parameters
| Parameter | Type |
|---|---|
item | ShapeItem |
Returns
Call Signature
getHandler(item): RectangleItemHandler;
Parameters
| Parameter | Type |
|---|---|
item | RectangleItem |
Returns
Call Signature
getHandler(item): PlaceholderItemHandler;
Parameters
| Parameter | Type |
|---|---|
item | PlaceholderItem |
Returns
Call Signature
getHandler(item): BoundedTextItemHandler;
Parameters
| Parameter | Type |
|---|---|
item | BoundedTextItem |
Returns
Call Signature
getHandler(item): ImageItemHandler;
Parameters
| Parameter | Type |
|---|---|
item | ImageItem |
Returns
Call Signature
getHandler(item): PlaceholderItemHandler;
Parameters
| Parameter | Type |
|---|---|
item | PlaceholderItem |
Returns
Call Signature
getHandler(item): AutoScaledTextItemHandler;
Parameters
| Parameter | Type |
|---|---|
item | AutoScaledTextItem |
Returns
Call Signature
getHandler(item): ArchedTextItemHandler;
Parameters
| Parameter | Type |
|---|---|
item | ArchedTextItem |
Returns
Call Signature
getHandler<THandler>(item): THandler;
Type Parameters
| Type Parameter |
|---|
THandler extends ItemHandler |
Parameters
| Parameter | Type |
|---|---|
item | Item |
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
getScrollBars()
getScrollBars(): object;
Returns
object
horizontal
horizontal: number;
vertical
vertical: number;
Inherited from
getSurfacePreview()
getSurfacePreview(surfaceIndex, options?): Promise<Blob>;
Parameters
| Parameter | Type | Description |
|---|---|---|
surfaceIndex | number | Index of the surface to preview |
options? | IPreviewOptions | Preview 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
| Parameter | Type |
|---|---|
e | MouseEvent |
Returns
boolean
initialize()
initialize(namedParameters?): void;
Parameters
| Parameter | Type |
|---|---|
namedParameters | { ignore?: boolean; intervalCheckLoop?: any; readonlyCanvasMode?: boolean; } |
namedParameters.ignore? | boolean |
namedParameters.intervalCheckLoop? | any |
namedParameters.readonlyCanvasMode? | boolean |
Returns
void
Overrides
initTextEditor()
initTextEditor(
fontService,
useSimpleFontList,
textEditor?,
textInputIssueUserConfirmationDelegate?): void;
Parameters
| Parameter | Type | Default value |
|---|---|---|
fontService | IFontService | undefined |
useSimpleFontList | boolean | undefined |
textEditor | TextEditorMode | TextEditorMode.Default |
textInputIssueUserConfirmationDelegate | Func<Promise<boolean>, string> | null |
Returns
void
lockViewer()
lockViewer(): void;
Returns
void
onDocumentClick()
onDocumentClick(e): void;
Parameters
| Parameter | Type |
|---|---|
e | MouseEvent |
Returns
void
Overrides
BaseViewer._onDocumentClick;
onResize()
onResize(sender, updateButtonGroup): void;
Parameters
| Parameter | Type |
|---|---|
sender | any |
updateButtonGroup | any |
Returns
void
Overrides
BaseViewer._onResize;
onResize()
onResize(h): void;
Parameters
| Parameter | Type |
|---|---|
h | any |
Returns
void
Inherited from
onResize()
onResize(h): void;
Parameters
| Parameter | Type |
|---|---|
h | any |
Returns
void
Inherited from
queryItems()
queryItems(selectors, queryOptions?): Item[];
Parameters
| Parameter | Type |
|---|---|
selectors | string |
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
releaseHandler()
releaseHandler(itemHandler): void;
Parameters
| Parameter | Type |
|---|---|
itemHandler | ItemHandler |
Returns
void
scrolled()
scrolled(h): void;
Fires when scroll position of the control is changed
Parameters
| Parameter | Type |
|---|---|
h | any |
Returns
void
Inherited from
scrolled()
scrolled(h): void;
Parameters
| Parameter | Type |
|---|---|
h | any |
Returns
void
Inherited from
setCursor()
setCursor(cursor, onBody?): void;
Parameters
| Parameter | Type | Default value |
|---|---|---|
cursor | Cursor | undefined |
onBody | boolean | false |
Returns
void
Inherited from
setInputHandlerType()
Call Signature
setInputHandlerType(
type,
args,
options?): any;
Parameters
| Parameter | Type |
|---|---|
type | Create |
args | ICreateInputHandlerArgs |
options? | ISetInputHandlerOptions |
Returns
any
Call Signature
setInputHandlerType(type): any;
Parameters
| Parameter | Type |
|---|---|
type | Default |
Returns
any
Call Signature
setInputHandlerType(type): any;
Parameters
| Parameter | Type |
|---|---|
type | Locked |
Returns
any
Call Signature
setInputHandlerType(
type,
args,
options?): any;
Parameters
| Parameter | Type |
|---|---|
type | SelectPixel |
args | IInputHandlerArgs |
options? | ISetInputHandlerOptions |
Returns
any
setIntervalCheckLoop()
setIntervalCheckLoop(intervalCheckLoop): void;
Parameters
| Parameter | Type |
|---|---|
intervalCheckLoop | IIntervalCheckLoop |
Returns
void
Inherited from
BaseViewer.setIntervalCheckLoop
setMaxZoom()
setMaxZoom(value): void;
Parameters
| Parameter | Type |
|---|---|
value | number |
Returns
void
Inherited from
setTextEditorMode()
setTextEditorMode(value): void;
Parameters
| Parameter | Type |
|---|---|
value | number |
Returns
void
setTextWhizzModule()
setTextWhizzModule(textWhizz): void;
Parameters
| Parameter | Type |
|---|---|
textWhizz | any |
Returns
void
setZoom()
setZoom(
value,
params?,
ignoreZoomConfigRestrictions?,
withoutUpdate?): number;
Parameters
| Parameter | Type | Default value |
|---|---|---|
value | number | undefined |
params? | ZoomParams | undefined |
ignoreZoomConfigRestrictions? | boolean | false |
withoutUpdate? | boolean | false |
Returns
number
Overrides
statusChanged()
statusChanged(h): void;
Fires when status is updated.
Parameters
| Parameter | Type |
|---|---|
h | any |
Returns
void
Inherited from
statusChanged()
statusChanged(h): void;
Parameters
| Parameter | Type |
|---|---|
h | any |
Returns
void
Inherited from
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
| Parameter | Type |
|---|---|
h | any |
Returns
void
Inherited from
zoomed()
zoomed(h): void;
Parameters
| Parameter | Type |
|---|---|
h | any |
Returns
void
Inherited from
zoomToItems()
zoomToItems(items?): void;
Parameters
| Parameter | Type | Default value |
|---|---|---|
items | BaseItem[] | [] |
Returns
void
Inherited from
zoomToRectangle()
zoomToRectangle(rect): void;
Parameters
| Parameter | Type |
|---|---|
rect | RectangleF |
Returns
void
zoomToSelection()
zoomToSelection(): void;
Returns
void
Overrides
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;