HTML5 Viewer SDK API Documentation 

Namespaces


Class Index

Classes in s7sdk

Class s7sdk.SpinCapabilityState


Extends s7sdk.CapabilityState.

Manages a set of spin capabilities. SpinCapabilityState can be used to determine the current state of the SpinView 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.

Any time the current frame can be changed the associated SpinCapabilityState flags should be enabled.

Class Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
<static>  
s7sdk.SpinCapabilityState.PAN_DOWN
Indicates that the spin view can pan down.
<static>  
s7sdk.SpinCapabilityState.PAN_LEFT
Indicates that the spin view can pan left.
<static>  
s7sdk.SpinCapabilityState.PAN_RIGHT
Indicates that the spin view can pan right.
<static>  
s7sdk.SpinCapabilityState.PAN_UP
Indicates that the spin view can pan up.
<static>  
s7sdk.SpinCapabilityState.SPIN_EAST
Indicates that the spin view can spin east.
<static>  
s7sdk.SpinCapabilityState.SPIN_NORTH
Indicates that the spin view can spin north.
<static>  
s7sdk.SpinCapabilityState.SPIN_SOUTH
Indicates that the spin view can spin south.
<static>  
s7sdk.SpinCapabilityState.SPIN_WEST
Indicates that the spin view can spin west.
<static>  
s7sdk.SpinCapabilityState.ZOOM_IN
Indicates that the spin view can do a stepwise zoom in; zoom limit has not been reached.
<static>  
s7sdk.SpinCapabilityState.ZOOM_IN_CONT
Indicates the spin view can do a continuous zoom in; maximum resolution has not been reached.
<static>  
s7sdk.SpinCapabilityState.ZOOM_OUT
Indicates that the spin view can zoom out.
<static>  
s7sdk.SpinCapabilityState.ZOOM_RESET
Indicates that the spin 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.SpinCapabilityState(caps)
Checking capability flags:

if(spinState.hasCapability(s7sdk.SpinCapabilityState.SPIN_WEST) {
   // We know that the SpinView is able to spin west
} 
Parameters:
{Number} caps
(Optional) The initial capabilities. If undefined, then no capabilities are set.
See:
s7sdk.set.SpinView
Field Detail
<static> s7sdk.SpinCapabilityState.PAN_DOWN
Indicates that the spin view can pan down.

<static> s7sdk.SpinCapabilityState.PAN_LEFT
Indicates that the spin view can pan left.

<static> s7sdk.SpinCapabilityState.PAN_RIGHT
Indicates that the spin view can pan right.

<static> s7sdk.SpinCapabilityState.PAN_UP
Indicates that the spin view can pan up.

<static> s7sdk.SpinCapabilityState.SPIN_EAST
Indicates that the spin view can spin east.

<static> s7sdk.SpinCapabilityState.SPIN_NORTH
Indicates that the spin view can spin north.

<static> s7sdk.SpinCapabilityState.SPIN_SOUTH
Indicates that the spin view can spin south.

<static> s7sdk.SpinCapabilityState.SPIN_WEST
Indicates that the spin view can spin west.

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

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

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

<static> s7sdk.SpinCapabilityState.ZOOM_RESET
Indicates that the spin 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)