getComponent

Referência da API do JavaScript para o Visualizador de catálogo eletrônico

getComponent(componentId)

Retorna uma referência ao componente do 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 este método somente após a initComplete o retorno de chamada do visualizador foi executado, caso contrário, o componente pode não ser criado ainda pela lógica do visualizador.

Parâmetros

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

ID do componente

Nome da classe do componente SDK do visualizador

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

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

print

s7sdk.share.Print

download

s7sdk.common.Download

favoritosEfeito

s7sdk.favorites.FavoritesEffect

favoritosView

s7sdk.favorites.FavoritesView

favoritesMenu

s7sdk.favorites.FavoritesMenu

addFavoriteButton

s7sdk.favorites.AddFavoriteButton

removeFavoriteButton

s7sdk.favorites.RemoveFavoriteButton

viewAllFavoriteButton

s7sdk.favorites.ViewAllFavoriteButton

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

Consulte a API do SDK do visualizador documentação para obter mais informações sobre um componente específico.

Devoluções

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

Exemplo

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

Nesta página