getComponent

Last update: October 12, 2021

CREATED FOR:

  • Developer
  • User

JavaScript API reference for Basic 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:

Component IDViewer SDK component class name
parameterManagers7sdk.ParameterManager
containers7sdk.common.Container
mediaSets7sdk.set.MediaSet
zoomViews7sdk.image.ZoomView
zoomInButtons7sdk.common.ZoomInButton
zoomOutButtons7sdk.common.ZoomOutButton
zoomResetButtons7sdk.common.ZoomResetButton
fullScreenButtons7sdk.common.FullScreenButton
closeButtons7sdk.common.CloseButton

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

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

Returns

The {Object} is 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 zoomView = <instance>.getComponent("zoomView");
}
})

Experience Manager