getComponent

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

getComponent(componentId)

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

パラメータ

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

コンポーネントID

ビューアSDKコンポーネントのクラス名

parameterManager

s7sdk.ParameterManager

コンテナ

s7sdk.common.Container

mediaSet

s7sdk.set.MediaSet

zoomView

s7sdk.image.ZoomView

flyoutZoomView

s7sdk.image.FlyoutZoomView

spinView

s7sdk.set.SpinView

videoPlayer

s7sdk.video.VideoPlayer

コントロール

s7sdk.common.ControlBar

videoScrubber

s7sdk.video.VideoScrubber

videoTime

s7sdk.video.VideoTime

closedCaptionButton

s7sdk.common.ClosedCaptionButton

スウォッチ

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名前空間を使用することが重要です。

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

戻り値

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

例

このページ