getComponent

Référence de l’API JavaScript pour la visionneuse de catalogue électronique

getComponent(componentId)

Renvoie une référence au composant SDK de visionneuse utilisé par la visionneuse. La page Web peut utiliser cette méthode pour étendre ou personnaliser le comportement du lecteur prêt à 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} un identifiant du composant SDK de visionneuse utilisé par la visionneuse. Cette visionneuse prend en charge les ID de composant suivants :

ID de composant

Nom de classe du composant SDK de visionneuse

parameterManager

s7sdk.ParameterManager

conteneur

s7sdk.common.Conteneur

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

imprimer

s7sdk.share.Print

télécharger

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

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

Pour plus d’informations sur un composant particulier, consultez la documentation API du kit de développement de visionneuse.

Renvoie

{Object} une 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 pageView = <instance>.getComponent("pageView"); 
} 
})

Sur cette page