JavaScript API reference for Spin Viewer
getComponent(componentId)
Returns a reference to the Viewer SDK component that is used by the viewer. The web page can use this method to extend or customize the behavior of the out-of-box viewer. Call this method only after the initComplete
viewer callback has run, otherwise the component may not be created yet by the viewer logic.
*
componentID*
- {String}
an ID of the Viewer SDK component used by the viewer. This viewer supports the following component IDs:
Component ID |
Viewer SDK component class name |
---|---|
parameterManager |
s7sdk.ParameterManager |
container |
s7sdk.common.Container |
mediaSet |
s7sdk.set.MediaSet |
spinView |
s7sdk.set.SpinView |
zoomInButton |
s7sdk.common.ZoomInButton |
zoomOutButton |
s7sdk.common.ZoomOutButton |
zoomResetButton |
s7sdk.common.ZoomResetButton |
fullScreenButton |
s7sdk.common.FullScreenButton |
closeButton |
s7sdk.common.CloseButton |
spinLeftButton |
s7sdk.common.PanLeftButton |
spinRightButton |
s7sdk.common.PanRightButton |
When working with SDK APIs it is important to use a correct, fully qualified SDK namespace as described in Viewer SDK.
See the Viewer SDK API documentation for more information about a particular component.
{Object}
a reference to Viewer SDK component. The method returns null
if the componentId
is not a supported viewer component or if the component was not yet created by the viewer logic.
<instance>.setHandlers({
"initComplete":function() {
var spinView = <instance>.getComponent("spinView");
}
})