getComponent getcomponent

混在メディアビューア用のJavaScript API リファレンス

getComponent(componentId)

ビューアが使用する Viewer SDK コンポーネントへの参照を返します。 Web ページでは、この方法を使用して、標準ビューアの動作を拡張またはカスタマイズできます。 このメソッドは initComplete ビューアコールバックが実行された後にのみ呼び出します。それ以外の場合、コンポーネントはビューアロジックによってまだ作成されていない可能性があります。

パラメーター section-4fb77a645fdd45b3aaa5079c31e3bb05

*componentID* - ビューアが使用する Viewer SDK コンポーネントの ID を {String} します。 このビューアは、次のコンポーネント ID をサポートしています。

コンポーネント ID
ビューア SDK コンポーネントのクラス名
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

SDK API を使用する場合は、「 ユーザーインターフェイス要素のローカライゼーション」で説明されているように、正しい完全修飾された SDK 名前空間を使用することが重要です。

特定のコンポーネントについて詳しくは、Viewer SDK API ドキュメントを参照してください。

戻り値 section-1d3cf85bc7cc4dfe9670e038d02b9101

{Object} Viewer SDK コンポーネントへのリファレンスです。 componentId がサポートされているビューアコンポーネントでない場合や、コンポーネントがまだビューアロジックで作成されていない場合、メソッドは null を返します。

section-9e9332aa86b74a5fb321375c03fdc5b3

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