BaseViewer
Classes
BaseViewer
Extended by
Constructors
Constructor
new BaseViewer(): BaseViewer;
Returns
Properties
onDocumentClick
onDocumentClick: (e) => void;
Parameters
| Parameter | Type |
|---|---|
e | MouseEvent |
Returns
void
Accessors
actualRulerWidth
Get Signature
get actualRulerWidth(): number;
Returns
number
actualSizeHorizontalScale
Get Signature
get actualSizeHorizontalScale(): number;
Gets value which represents the ratio of screen horizontal resolution to the canvas resolution.
Returns
number
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
clientSideOptions
Get Signature
get clientSideOptions(): object;
Deprecated
Returns
object
contentAngle
Get Signature
get contentAngle(): number;
Returns
number
Set Signature
set contentAngle(value): void;
Parameters
| Parameter | Type |
|---|---|
value | number |
Returns
void
contentCtx
Get Signature
get contentCtx(): HTMLElement;
Returns
HTMLElement
contentHeight
Get Signature
get contentHeight(): any;
Gets a value that represents the height of the control's content taking into account its vertical resolution and zoom value
Returns
any
contentWidth
Get Signature
get contentWidth(): any;
Gets a value that represents the width of the control's content taking into account its horizontal resolution and zoom value
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
element
Get Signature
get element(): HTMLDivElement;
Returns
HTMLDivElement
exceptionDescription
Get Signature
get exceptionDescription(): string;
The value which represents description of exception which was thrown during calling remote scripting method
Deprecated
Returns
string
height
Get Signature
get height(): any;
Gets the height (in pixels) of the control area.
Returns
any
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;
id
Get Signature
get id(): string;
Returns
string
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
pinchZoomEnabled
Get Signature
get pinchZoomEnabled(): boolean;
Returns
boolean
Set Signature
set pinchZoomEnabled(v): void;
Parameters
| Parameter | Type |
|---|---|
v | boolean |
Returns
void
returnValue
Get Signature
get returnValue(): string;
Returns
string
rulerDivision
Get Signature
get rulerDivision(): number;
Returns
number
Set Signature
set rulerDivision(v): void;
Parameters
| Parameter | Type |
|---|---|
v | number |
Returns
void
rulerEnabled
Get Signature
get rulerEnabled(): boolean;
Returns
boolean
Set Signature
set rulerEnabled(v): void;
Parameters
| Parameter | Type |
|---|---|
v | boolean |
Returns
void
rulerOffsetX
Get Signature
get rulerOffsetX(): number;
Returns
number
Set Signature
set rulerOffsetX(v): void;
Parameters
| Parameter | Type |
|---|---|
v | number |
Returns
void
rulerOffsetY
Get Signature
get rulerOffsetY(): number;
Returns
number
Set Signature
set rulerOffsetY(v): void;
Parameters
| Parameter | Type |
|---|---|
v | number |
Returns
void
rulerScale
Get Signature
get rulerScale(): number;
Returns
number
Set Signature
set rulerScale(v): void;
Parameters
| Parameter | Type |
|---|---|
v | number |
Returns
void
rulerWidth
Get Signature
get rulerWidth(): number;
Returns
number
Set Signature
set rulerWidth(v): void;
Parameters
| Parameter | Type |
|---|---|
v | number |
Returns
void
screenXDpi
Get Signature
get screenXDpi(): number;
Returns
number
Set Signature
set screenXDpi(v): void;
Parameters
| Parameter | Type |
|---|---|
v | number |
Returns
void
screenYDpi
Get Signature
get screenYDpi(): number;
Returns
number
Set Signature
set screenYDpi(v): void;
Parameters
| Parameter | Type |
|---|---|
v | number |
Returns
void
scrollBarsStyle
Get Signature
get scrollBarsStyle(): ScrollBarsStyle;
Returns
Set Signature
set scrollBarsStyle(value): void;
Parameters
| Parameter | Type |
|---|---|
value | ScrollBarsStyle |
Returns
void
scrollBarWidth
Get Signature
get scrollBarWidth(): number;
Returns
number
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
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
status
Get Signature
get status(): UpdateStatus;
The value which represents current status of Viewer control
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
width
Get Signature
get width(): any;
Gets the width (in pixels) of the control area.
Returns
any
workspaceHeight
Get Signature
get workspaceHeight(): number;
Gets a value that represents the height (in points) of the associated with this
Returns
number
workspaceWidth
Get Signature
get workspaceWidth(): number;
Gets a value that represents the width (in points) of the associated with this
Returns
number
zoom
Get Signature
get zoom(): number;
Returns
number
zoomConfig
Get Signature
get zoomConfig(): IRangeParams;
Returns
zoomMode
Get Signature
get zoomMode(): ZoomMode;
Returns
Set Signature
set zoomMode(v): void;
Parameters
| Parameter | Type |
|---|---|
v | ZoomMode |
Returns
void
zoomQuality
Get Signature
get zoomQuality(): ZoomQuality;
Gets a value that specifies a zoom quality.
Returns
Methods
abort()
abort(): void;
Returns
void
calculateZoomByZoomMode()
calculateZoomByZoomMode(
zoomMode,
size?,
bestFitWhiteSpacePcArg?): number;
Parameters
| Parameter | Type | Default value |
|---|---|---|
zoomMode | ZoomMode | undefined |
size | SizeF | null |
bestFitWhiteSpacePcArg | number | null |
Returns
number
clearRenderCtx()
clearRenderCtx(ctx): void;
Parameters
| Parameter | Type |
|---|---|
ctx | HTMLElement |
Returns
void
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
dispose()
dispose(): void;
Releases all resources
Returns
void
getActualScrollPosition()
getActualScrollPosition(): any;
Returns
any
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.
getScrollBars()
getScrollBars(): object;
Returns
object
horizontal
horizontal: number;
vertical
vertical: number;
getViewportLocation()
getViewportLocation(): any;
Returns
any
ignoreDocumentClickOnce()
ignoreDocumentClickOnce(): void;
Returns
void
initialize()
initialize(intervalCheckLoop?): void;
Parameters
| Parameter | Type | Default value |
|---|---|---|
intervalCheckLoop | any | null |
Returns
void
onResize()
onResize(h): void;
Parameters
| Parameter | Type |
|---|---|
h | any |
Returns
void
onResize()
onResize(h): void;
Parameters
| Parameter | Type |
|---|---|
h | any |
Returns
void
refresh()
refresh(): void;
Refreshes the control immediately.
Returns
void
scrolled()
scrolled(h): void;
Fires when scroll position of the control is changed
Parameters
| Parameter | Type |
|---|---|
h | any |
Returns
void
scrolled()
scrolled(h): void;
Parameters
| Parameter | Type |
|---|---|
h | any |
Returns
void
setCursor()
setCursor(cursor, onBody?): void;
Parameters
| Parameter | Type | Default value |
|---|---|---|
cursor | Cursor | undefined |
onBody | boolean | false |
Returns
void
setIntervalCheckLoop()
setIntervalCheckLoop(intervalCheckLoop): void;
Parameters
| Parameter | Type |
|---|---|
intervalCheckLoop | IIntervalCheckLoop |
Returns
void
setMaxZoom()
setMaxZoom(value): void;
Parameters
| Parameter | Type |
|---|---|
value | number |
Returns
void
setZoom()
setZoom(
zoom,
params,
ignoreZoomConfigRestrictions?,
withoutUpdate?): number;
Parameters
| Parameter | Type | Default value |
|---|---|---|
zoom | number | undefined |
params | ZoomParams | undefined |
ignoreZoomConfigRestrictions | boolean | false |
withoutUpdate | boolean | false |
Returns
number
statusChanged()
statusChanged(h): void;
Fires when status is updated.
Parameters
| Parameter | Type |
|---|---|
h | any |
Returns
void
statusChanged()
statusChanged(h): void;
Parameters
| Parameter | Type |
|---|---|
h | any |
Returns
void
zoomed()
zoomed(h): void;
Fires when the content is zoomed in the control
Parameters
| Parameter | Type |
|---|---|
h | any |
Returns
void
zoomed()
zoomed(h): void;
Parameters
| Parameter | Type |
|---|---|
h | any |
Returns
void
zoomToItems()
zoomToItems(items?): void;
Parameters
| Parameter | Type | Default value |
|---|---|---|
items | BaseItem[] | [] |
Returns
void
zoomToSelection()
zoomToSelection(): void;
Returns
void
ZoomParams
Constructors
Constructor
new ZoomParams(): ZoomParams;
Returns
Properties
centerPageX?
optional centerPageX?: number;
centerPageY?
optional centerPageY?: number;
preventEvent?
optional preventEvent?: boolean;
skipZoomToCenter?
optional skipZoomToCenter?: boolean;
workspaceX?
optional workspaceX?: number;
workspaceY?
optional workspaceY?: number;