Saltar al contenido principal

getSlides

Obtiene el árbol de diapositivas del bloque como un array plano en preorden (solo slider_block).

Descripción

Este método devuelve las diapositivas de un bloque deslizante como un array plano en preorden; cada elemento lleva su depth y parentId, para que puedas reconstruir el árbol en el cliente. Funciona solo para bloques del tipo slider_block. Devuelve una Promesa que se resuelve en un objeto IBlockSlidesResponse.

Blocks.getSlides(

marker*

);

Esquema de parámetros

Esquema

marker(requerido): string
Marcador del bloque
ejemplo: "slider_block"

Ejemplos

Ejemplo mínimo

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

Ejemplo de respuesta

{
"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": {}
}
]
}

Esquema de respuesta

Esquema: IBlockSlidesResponse

total: number
Número total de diapositivas.
ejemplo: 3

time: number
Tiempo de visualización predeterminado para las diapositivas.
ejemplo: 5

timeInterval: 'sec' | 'ms'
Unidad del campo de tiempo.
ejemplo: "sec"

items: IBlockSlideItem[]
Array plano en preorden de elementos de diapositivas.

items.id: number
Identificador de la diapositiva.
ejemplo: 1

items.parentId: number | null
Identificador de la diapositiva padre, o null para las diapositivas raíz.
ejemplo: null

items.depth: number
Profundidad de la diapositiva en el árbol.
ejemplo: 0

items.position: number
Posición de la diapositiva entre sus hermanos.
ejemplo: 1

items.visible: boolean
Si la diapositiva es visible.
ejemplo: true

items.time: number
Tiempo de visualización para la diapositiva.
ejemplo: 5

items.timeInterval: 'sec' | 'ms'
Unidad del campo de tiempo.
ejemplo: "sec"

items.attributeValues: IAttributeValues
Mapa de valores de atributos indexados por marcador.