getComponent getcomponent

eCatalog查看器的JavaScript API参考

getComponent(componentId)

返回对查看器使用的查看器SDK组件的引用。 网页可以使用此方法来扩展或自定义开箱即用查看器的行为。 仅在以下情况下调用此方法: initComplete 查看器回调已运行,否则查看器逻辑可能尚未创建组件。

参数 section-4fb77a645fdd45b3aaa5079c31e3bb05

*componentID* - {String} 查看器使用的查看器SDK组件的ID。 此查看器支持以下组件ID:

组件Id
查看器SDK组件类名称
参数管理器
s7sdk.ParameterManager
容器
s7sdk.common.Container
mediaSet
s7sdk.set.MediaSet
pageView
s7sdk.set.PageView
primaryControls
s7sdk.common.ControlBar
secondaryControls
s7sdk.common.ControlBar
网格视图
s7sdk.set.ThumbnailGridView
目录
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
searchButton
s7sdk.common.SearchButton
searchPanel
s7sdk.search.SearchPanel
searchManager
s7sdk.search.SearchManager
searchEffect
s7sdk.search.SearchEffect

在使用SDK API时,请务必使用正确的完全限定的SDK命名空间,如中所述 Viewer SDK命名空间.

请参阅 Viewer SDK API 文档,以了解有关特定组件的更多信息。

返回 section-1d3cf85bc7cc4dfe9670e038d02b9101

{Object} 对查看器SDK组件的引用。 方法返回 null 如果 componentId 不是支持的查看器组件,或者该组件尚未由查看器逻辑创建。

示例 section-9e9332aa86b74a5fb321375c03fdc5b3

<instance>.setHandlers({
 "initComplete":function() {
  var pageView = <instance>.getComponent("pageView");
}
})
recommendation-more-help
b7426f53-aad9-4c00-83fc-664f30f681e8