getComponent

Referência da API JavaScript para o Visualizador do carrossel.

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

*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

carouselView

s7sdk.set.CarouselView

imageMapEffect

s7sdk.image.mageMapEffect

controlBar

s7sdk.common.ControlBar

setIndicator

s7sdk.set.SetIndicator

nextButton

s7sdk.common.PanRightButton

prevButton

s7sdk.common.PanLeftButton

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

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

Devoluções

{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

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

Nesta página