Aller au contenu

timeline

L’échelle et les couloirs des vues timeline du Pro (import '@dzcalendar/pro').

Type{ readonly slot?: number | 'day'; readonly maxLanes?: number; readonly fillLanes?: number; readonly step?: DurationLike | undefined; readonly follow?: boolean | { readonly before?: DurationLike } | undefined; readonly ticks?: number | { readonly every: number; readonly label?: number } | undefined; readonly span?: DurationLike | undefined }
Par défautnon défini
Modifiable en direct (update())Oui
Déclaré danspackages/core/src/kernel.ts

La timeline dessine le temps en travers, une ligne par ressource (resourceTimelineDay, …Week, …Month, …Year) ou une seule ligne pour tout (timelineDay…). Sept réglages, fusionnés clé par clé avec update({ timeline }) — slot: undefined revient à la valeur par défaut :

  • slot : la largeur d’un créneau en temps.
  • maxLanes : les couloirs de la ligne d’une ressource ; le dernier porte « +N » quand plus d’événements se chevauchent.
  • fillLanes : les couloirs d’une timeline sans ressources — une valeur de départ : dans un navigateur, sa ligne unique remplit la vue et les couloirs sont mesurés.
  • step : ce dont ◀ ▶ font glisser la timeline ({ minutes: 15 }, { hours: 1 }) au lieu de changer de période.
  • follow : la timeline garde l’instant présent à l’écran à mesure que le temps passe.
  • span : le temps visible d’un coup ({ hours: 4 }), quelle que soit la place.
  • ticks : un petit repère toutes les tant de minutes dans chaque créneau.

Un créneau en minutes doit diviser un jour, et les couloirs sont des entiers de 1 ou plus ; un pas s’écrit en heures et en minutes, plus long que rien, une étendue en jours, heures et minutes ; toute autre valeur lève une RangeError à la création ou à update(). Un créneau d’horloge qui traverse un changement d’heure garde sa vraie largeur. La largeur à l’écran est celle de la feuille de style (--dz-tl-slot), sauf si span la fixe ; les colonnes de la zone des ressources sont viewOptions.timeline.areaColumns.

Typenumber
Par défaut12
Modifiable en direct (update())Oui
Déclaré danspackages/core/src/kernel.ts

Les couloirs d’une timeline sans ressources, avant la mesure : dans un navigateur, sa ligne unique a la hauteur de la vue et tient autant de couloirs que la place le permet.

Typeboolean | { readonly before?: DurationLike } | undefined
Par défautfalse
Modifiable en direct (update())Oui
Déclaré danspackages/core/src/kernel.ts

L’instant présent reste à l’écran, son créneau au bord gauche (à 22:47 en quarts d’heure, 22:45), ce qui vient ensuite montré ; la timeline avance quand le créneau suivant commence ; passé la fin de la période (minuit sur une timeline d’un jour), la suivante arrive. Le suivi se met en pause dès que la personne se déplace dans le temps — un défilement, un glissement, une autre période — et « Aujourd’hui » (navigate('today')) le reprend. Pensé pour la supervision : une timeline qui montre ce qui tourne maintenant.

Avec { before: { minutes: 5 } }, le présent reste plutôt à cette distance du bord gauche — un peu de ce qui vient de se passer à l’écran — et l’axe glisse chaque minute : le défilement adouci de l’adaptateur d’animation (GSAP avec @dzcalendar/motion-gsap), sinon celui du navigateur, d’un coup quand les animations sont réduites. Ce glissement est celui de la vue : il ne met pas le suivi en pause.

Typenumber
Par défaut3
Modifiable en direct (update())Oui
Déclaré danspackages/core/src/kernel.ts

Les événements qui se chevauchent que la ligne d’une ressource empile ; au-delà, son dernier couloir porte « +N », qui ouvre le reste.

Typenumber | 'day'
Par défaut30 minutes pour un jour, 60 jusqu'à une semaine, des jours au-delà
Modifiable en direct (update())Oui
Déclaré danspackages/core/src/kernel.ts

Des minutes par créneau (un diviseur du jour : 15, 30, 60, 120…) ou 'day'. Par défaut 30 minutes pour un jour, une heure jusqu’à une semaine, un jour au-delà.

TypeDurationLike | undefined
Par défautnon défini
Modifiable en direct (update())Oui
Déclaré danspackages/core/src/kernel.ts

Des heures et des minutes ({ minutes: 15 }, { hours: 1 }, 'PT30M'). Avec lui, ◀ ▶ et navigate('prev' | 'next') font défiler la timeline d’autant ; au bout de l’axe, la période suivante ou précédente arrive, là où allait le glissement. Une vue d’un jour s’arrête à minuit en chemin ; une vue de plusieurs jours (views: { supervision: { family: 'timeline', duration: { days: 3 } } }) le traverse. calendar.shift({ minutes: -45 }) fait glisser de n’importe quel autre nombre d’heures et de minutes (un jour ou plus, ou rien, lève une RangeError, comme l’option). Un jour ou plus, c’est le dateIncrement d’une vue, pas un pas.

Typenumber | { readonly every: number; readonly label?: number } | undefined
Par défautnon défini
Modifiable en direct (update())Oui
Déclaré danspackages/core/src/kernel.ts

Comme sur une règle : { every: 1, label: 5 } dessine un court trait chaque minute et écrit l’heure toutes les cinq (label, un multiple de every) ; un nombre vaut pour les deux. Aussi dense que la place le permet : les heures seulement quand elles tiennent, les traits de minute seulement à quelques pixels d’écart — à 4 heures à l’écran, les traits seuls. Des minutes entre de petits repères dans chaque créneau : 5 en quarts d’heure dessine 10:05 et 10:10 entre 10:00 et 10:15 — un court trait et son heure dans l’en-tête, écrite plus petite dans une police à chasse fixe (--dz-tl-tick-font), et une fine ligne pointillée à travers les lignes. Dessinés quand ils divisent le créneau et sont plus courts que lui ; des minutes entières qui divisent un jour, sinon une RangeError.

TypeDurationLike | undefined
Par défautnon défini
Modifiable en direct (update())Oui
Déclaré danspackages/core/src/kernel.ts

Des jours, des heures et des minutes ({ hours: 4 }, 'PT1H', { days: 1 }) : le temps à l’écran d’un coup. La largeur d’un créneau est la place partagée entre autant de créneaux, mesurée à nouveau quand la taille du calendrier change — quatre heures remplissent un téléphone comme un grand écran. Plus longue que la période, la période tient ; plus courte qu’un créneau, un créneau la remplit. Changée par update(), le moment au centre de ce qui est montré y reste, et le présent garde sa place tant que follow est actif : une fenêtre de quatre heures qui glisse avec l’horloge. Choisissez un slot qui lui va (24 heures en quarts d’heure, ce sont 96 têtes étroites). Sans elle, la largeur est celle de la feuille de style, --dz-tl-slot.

import { createCalendar } from '@dzcalendar/dom';
import '@dzcalendar/pro';
const calendar = createCalendar(element, {
timeZone: 'Europe/Paris',
initialView: 'resourceTimelineWeek',
resources: [{ id: 'benali', title: 'Dr Benali' }, { id: 'room1', title: 'Room 1' }],
timeline: { slot: 120, maxLanes: 2 },
});
// Later: back to the default slot, lanes unchanged.
calendar.update({ timeline: { slot: undefined } });

En Angular et en Vue elle va dans options ; en React c’est une prop.

La journée, une ligne par ressource, un créneau par heure (30 minutes par défaut).