DocumentationDynamic Media Viewers Reference Guide

getComponent getcomponent

Last update: Wed Jan 26 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • User

JavaScript API reference for Mixed Media 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 section-4fb77a645fdd45b3aaa5079c31e3bb05

*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
zoomView
s7sdk.image.ZoomView
flyoutZoomView
s7sdk.image.FlyoutZoomView
spinView
s7sdk.set.SpinView
videoPlayer
s7sdk.video.VideoPlayer
controls
s7sdk.common.ControlBar
videoScrubber
s7sdk.video.VideoScrubber
videoTime
s7sdk.video.VideoTime
closedCaptionButton
s7sdk.common.ClosedCaptionButton
swatches
s7sdk.set.Swatches
colorSwatches
s7sdk.set.Swatches
zoomInButton
s7sdk.common.ZoomInButton
zoomOutButton
s7sdk.common.ZoomOutButton
zoomResetButton
s7sdk.common.ZoomResetButton
spinLeftButton
s7sdk.common.PanLeftButton
spinRightButton
s7sdk.common.PanRightButton
mutableVolume
s7sdk.video.MutableVolume
playPauseButton
s7sdk.common.PlayPauseButton
fullScreenButton
s7sdk.common.FullScreenButton
closeButton
s7sdk.common.CloseButton

When working with SDK APIs, it is important to use correct and fully qualified SDK namespace as described in Localization of user interface elements.

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

Returns section-1d3cf85bc7cc4dfe9670e038d02b9101

{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 section-9e9332aa86b74a5fb321375c03fdc5b3

recommendation-more-help
b7426f53-aad9-4c00-83fc-664f30f681e8