Aller au contenu principal

getSlides

Obtenez l'arbre des diapositives du bloc sous forme de tableau à plat en pré-ordre (uniquement pour slider_block).

Description​

Cette méthode renvoie les diapositives d'un bloc de diaporama sous forme de tableau à plat, en pré-ordre - chaque élément porte sa depth et parentId, vous permettant ainsi de reconstruire l'arbre côté client. Elle fonctionne uniquement pour les blocs de type slider_block. Elle renvoie une promesse qui se résout en un objet IBlockSlidesResponse.

Blocks.getSlides(

marker*

);

Schéma des paramètres​

Schéma

marker(obligatoire): string
Marqueur de bloc
exemple : "slider_block"

Exemples​

Exemple minimal​

const response = await Blocks.getSlides('slider_block');

Exemple de réponse​

{
  "total": 3,
  "time": 5,
  "timeInterval": "sec",
  "items": [
    {
      "id": 1,
      "parentId": null,
      "depth": 0,
      "position": 1,
      "visible": true,
      "time": 5,
      "timeInterval": "sec",
      "attributeValues": {}
    },
    {
      "id": 2,
      "parentId": 1,
      "depth": 1,
      "position": 1,
      "visible": true,
      "attributeValues": {}
    }
  ]
}

Schéma de réponse​

Schéma : IBlockSlidesResponse

total: number
Nombre total de diapositives.
exemple : 3

time: number
Temps d'affichage par défaut pour les diapositives.
exemple : 5

timeInterval: 'sec' | 'ms'
Unité du champ de temps.
exemple : "sec"

items: IBlockSlideItem[]
Tableau à plat en pré-ordre des éléments de diapositive.

items.id: number
Identifiant de la diapositive.
exemple : 1

items.parentId: number | null
Identifiant de la diapositive parente, ou null pour les diapositives racines.
exemple : null

items.depth: number
Profondeur de la diapositive dans l'arbre.
exemple : 0

items.position: number
Position de la diapositive parmi ses frères et sœurs.
exemple : 1

items.visible: boolean
Indique si la diapositive est visible.
exemple : true

items.time: number
Temps d'affichage pour la diapositive.
exemple : 5

items.timeInterval: 'sec' | 'ms'
Unité du champ de temps.
exemple : "sec"

items.attributeValues: IAttributeValues
Carte des valeurs d'attribut indexées par marqueur.