getComponent

最終更新日： 2024年7月22日
  • トピック：

作成対象：

  • 開発者
  • ユーザー

カルーセルビューアのJavaScript API リファレンス。

getComponent(componentId)

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

パラメーター

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

コンポーネント IDビューア SDK コンポーネントのクラス名
parameterManagers7sdk.ParameterManager
containers7sdk.common.Container
mediaSets7sdk.set.MediaSet
carouselViews7sdk.set.CarouselView
s7sdk.image.mageMapEffect
controlBars7sdk.common.ControlBar
setIndicators7sdk.set.SetIndicator
nextButtons7sdk.common.PanRightButton
prevButtons7sdk.common.PanLeftButton

SDK API を使用する場合は、「 ビューア SDK 名前空間」で説明されているように、正しい完全修飾 SDK 名前空間を使用することが重要です。

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

戻り値

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

例 

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

Experience Manager