getComponent

Référence de l’API JavaScript pour la visionneuse de carrousel.

getComponent(componentId)

Renvoie une référence au composant SDK de la visionneuse utilisé par la visionneuse. La page web peut utiliser cette méthode pour étendre ou personnaliser le comportement de la visionneuse prête à l’emploi. Appelez cette méthode uniquement après l’exécution du rappel de la visionneuse initComplete. Sinon, le composant ne peut pas encore être créé par la logique de la visionneuse.

Paramètres

*componentID* : {String} identifiant du composant SDK de visionneuse utilisé par la visionneuse. Cette visionneuse prend en charge les identifiants de composant suivants :

Identifiant du composant

Nom de classe du composant SDK de visionneuse

parameterManager

s7sdk.ParameterManager

conteneur

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

Lorsque vous utilisez des API SDK, il est important d’utiliser l’espace de noms du SDK complet correct, comme décrit dans Espace de noms du SDK de la visionneuse.

Pour plus d’informations sur un composant particulier, consultez la documentation de l’API du SDK de la visionneuse .

Renvoie

{Object} Référence au composant SDK de visionneuse. La méthode renvoie null si componentId n’est pas un composant de visionneuse pris en charge ou si le composant n’a pas encore été créé par la logique de la visionneuse.

Exemple

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

Sur cette page