getComponent

eCatalog查看器的JavaScript API引用

getComponent(componentId)

返回对查看器所使用的查看器SDK组件的引用。 网页可以使用此方法来扩展或自定义现成查看器的行为。 仅在运行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

使用SDK API时,务必按照查看器SDK命名空间中所述,使用正确的完全限定的SDK命名空间。

有关特定组件的更多信息,请参阅​查看器SDK API​文档。

返回结果

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

示例

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

在此页面上