getComponent getcomponent

Referência da API JavaScript para o eCatalog Viewer

getComponent(componentId)

Retorna uma referência ao componente de SDK do Visualizador usado pelo visualizador. A página da Web pode usar esse método para estender ou personalizar o comportamento do visualizador pronto para uso. Chame esse método somente após o initComplete o retorno de chamada do visualizador foi executado, caso contrário, o componente pode não ter sido criado ainda pela lógica do visualizador.

Parâmetros section-4fb77a645fdd45b3aaa5079c31e3bb05

*componentID* - {String} uma ID do componente do Visualizador SDK usada pelo visualizador. Esse visualizador é compatível com as seguintes IDs de componente:

ID do componente
Nome da classe do componente do visualizador do SDK
parameterManager
s7sdk.ParameterManager
container
s7sdk.common.Container
mediaSet
s7sdk.set.MediaSet
pageView
s7sdk.set.PageView
primaryControls
s7sdk.common.ControlBar
secondaryControls
s7sdk.common.ControlBar
gridView
s7sdk.set.ThumbnailGridView
sumário
s7sdk.set.TableOfContent
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
imprimir
s7sdk.share.Print
baixar
s7sdk.common.Download
favoritosEffect
s7sdk.favoritos.FavoritesEffect
favoritesView
s7sdk.favoritos.FavoritesView
favoritosMenu
s7sdk.favoritos.MenuFavoritos
addFavoriteButton
s7sdk.favoritos.AddFavoriteButton
removeFavoriteButton
s7sdk.favoritos.RemoveFavoriteButton
viewAllFavoriteButton
s7sdk.favoritos.ViewAllFavoriteButton
searchButton
s7sdk.common.SearchButton
searchPanel
s7sdk.search.SearchPanel
searchManager
s7sdk.search.SearchManager
searchEffect
s7sdk.search.SearchEffect

Ao trabalhar com APIs de SDK, é importante usar o namespace de SDK totalmente qualificado e correto, conforme descrito em Namespace do visualizador do SDK.

Consulte a Visualizador da API do SDK para obter mais informações sobre um componente específico.

Devoluções section-1d3cf85bc7cc4dfe9670e038d02b9101

{Object} uma referência ao componente do Visualizador SDK. O método retorna null se a variável componentId não é um componente de visualizador compatível ou se o componente ainda não foi criado pela lógica do visualizador.

Exemplo section-9e9332aa86b74a5fb321375c03fdc5b3

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