HTML5 Viewer SDK API Documentation 

Namespaces


Class Index

Classes in s7sdk

Class s7sdk.ZoomCapabilityState


Extends s7sdk.CapabilityState.

Manages a set of zoom capabilities. ZoomCapabilityState can be used to determine the current state of the ZoomView component. For example, if the component can zoom in, then the ZOOM_IN capability flag will be set. This means that the current frame is not fully zoomed in.

Class Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
<static>  
s7sdk.ZoomCapabilityState.PAN_DOWN
Indicates that the zoom view can pan down.
<static>  
s7sdk.ZoomCapabilityState.PAN_LEFT
Indicates that the zoom view can pan left.
<static>  
s7sdk.ZoomCapabilityState.PAN_RIGHT
Indicates that the zoom view can pan right.
<static>  
s7sdk.ZoomCapabilityState.PAN_UP
Indicates that the zoom view can pan up.
<static>  
s7sdk.ZoomCapabilityState.ZOOM_IN
Indicates that the zoom view can do a stepwise zoom in; zoom limit has not been reached.
<static>  
s7sdk.ZoomCapabilityState.ZOOM_IN_CONT
Indicates the zoom view can do a continuous zoom in; maximum resolution has not been reached.
<static>  
s7sdk.ZoomCapabilityState.ZOOM_OUT
Indicates that the zoom view can zoom out.
<static>  
s7sdk.ZoomCapabilityState.ZOOM_RESET
Indicates that the zoom view is not in its initial zoom state and that the zoom can be reset.
Methods borrowed from class s7sdk.CapabilityState:
clone, hasCapability, toString
Class Detail
s7sdk.ZoomCapabilityState(caps)
Checking capability flags:

if(zoomState.hasCapability(s7sdk.ZoomCapabilityState.ZOOM_IN) {
   // We know that the ZoomView is able to zoom in
} 
Parameters:
{Number} caps
(Optional) The initial capabilities. If undefined, then no capabilities are set.
Field Detail
<static> s7sdk.ZoomCapabilityState.PAN_DOWN
Indicates that the zoom view can pan down.

<static> s7sdk.ZoomCapabilityState.PAN_LEFT
Indicates that the zoom view can pan left.

<static> s7sdk.ZoomCapabilityState.PAN_RIGHT
Indicates that the zoom view can pan right.

<static> s7sdk.ZoomCapabilityState.PAN_UP
Indicates that the zoom view can pan up.

<static> s7sdk.ZoomCapabilityState.ZOOM_IN
Indicates that the zoom view can do a stepwise zoom in; zoom limit has not been reached.

<static> s7sdk.ZoomCapabilityState.ZOOM_IN_CONT
Indicates the zoom view can do a continuous zoom in; maximum resolution has not been reached.

<static> s7sdk.ZoomCapabilityState.ZOOM_OUT
Indicates that the zoom view can zoom out.

<static> s7sdk.ZoomCapabilityState.ZOOM_RESET
Indicates that the zoom view is not in its initial zoom state and that the zoom can be reset.

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Jan 30 2020 16:40:37 GMT+0200 (EET)