getComponent

eCatalogビューアのJavaScript APIリファレンス

getComponent(componentId)

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

パラメータ

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

コンポーネントID

ビューア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

favoritesEffect

s7sdk.favorites.FavoritesEffect

favoritesView

s7sdk.favorites.FavoritesView

favoritesMenu

s7sdk.favorites.FavoritesMenu

addFavoriteButton

s7sdk.favorites.AddFavoriteButton

removeFavoriteButton

s7sdk.favorites.RemoveFavoriteButton

viewAllFavoriteButton

s7sdk.favorites.ViewAllFavoriteButton

searchButton

s7sdk.common.SearchButton

searchPanel

s7sdk.search.SearchPanel

searchManager

s7sdk.search.SearchManager

searchEffect

s7sdk.search.SearchEffect

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

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

戻り値

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

例

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

このページ