getComponent getcomponent

eCatalog Viewer用JavaScript API リファレンス

getComponent(componentId)

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

パラメーター section-4fb77a645fdd45b3aaa5079c31e3bb05

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

コンポーネント ID
Viewer SDK コンポーネントクラス名
parameterManager
s7sdk.ParameterManager
コンテナ
s7sdk.common.Container
mediaSet
s7sdk.set.MediaSet
pageView
s7sdk.set.PageView
primaryControls
s7sdk.common.ControlBar
secondaryControls
s7sdk.common.ControlBar
gridView
s7sdk.set.ThumbnailGridView
tableOfContents
s7sdk.set.TableOfContents
infoPanelPopup
s7sdk.info.InfoPanelPopup
imageMapEffect
s7sdk.image.ImageMapEffect
leftButton
s7sdk.common.PanLeftButton
rightButton
s7sdk.common.PanRightButton
zoomInButton
s7sdk.common.ZoomInButton
zoomOutButton
s7sdk.common.ZoomOutButton
zoomResetButton
s7sdk.common.ZoomResetButton
secondaryZoomResetButton
s7sdk.common.ZoomResetButton
thumbnailPageButton
s7sdk.common.ThumbnailPageButton
fullScreenButton
s7sdk.common.FullScreenButton
toolBarLeftButton
s7sdk.common.PanLeftButton
toolBarRightButton
s7sdk.common.PanRightButton
firstPageButton
s7sdk.common.PanLeftButton
secondaryFirstPageButton
s7sdk.common.PanLeftButton
lastPageButton
s7sdk.common.PanRightButton
secondaryLastPageButton
s7sdk.common.PanRightButton
closeButton
s7sdk.common.CloseButton
socialShare
s7sdk.share.SocialShare
twitterShare
s7sdk.share.TwitterShare
facebookShare
s7sdk.share.FacebookShare
linkShare
s7sdk.share.LinkShare
emailShare
s7sdk.share.EmailShare
embedShare
s7sdk.share.EmbedShare
を印刷
s7sdk.share.Print
件のダウンロード
s7sdk.common.Download
件のお気に入りエフェクト
s7sdk.favorites.FavoritesEffect
件のお気に入りビュー
s7sdk.favorites.FavoritesView
のお気に入りメニュー
s7sdk.favorites.FavoritesMenu
addFavoriteButton
s7sdk.favorites.AddFavoriteButton
removeFavoriteButton
s7sdk.favorites.RemoveFavoriteButton
viewAllFavoriteButton
s7sdk.favorites.ViewAllFavoriteButton

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

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

返品 section-1d3cf85bc7cc4dfe9670e038d02b9101

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

section-9e9332aa86b74a5fb321375c03fdc5b3

<instance>.setHandlers({
 "initComplete":function() {
  var pageView = <instance>.getComponent("pageView");
}
})
recommendation-more-help
dynamic-media-developer-resources-help-aem-viewers-ref