getComponent

JavaScript API reference for Inline Zoom 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.

Parameters

*componentID* - {String} an ID of the Viewer SDK component used by the viewer. This viewer supports the following component IDs:

When working with SDK APIs it is important to use correct fully qualified SDK namespace as described in Viewer SDK.

Refer to the Viewer SDK documentation for more information about a particular component.

Returns

{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.

Example

<instance>.setHandlers({ 
 "initComplete":function() { 
  var flyoutZoomView = <instance>.getComponent("flyout"); 
} 
})