---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# AbstractTimelineSchedulePage - Global

# AbstractTimelineSchedulePage - Global {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 8 minutes de lecture

L'include de script AbstractTimelineSchedulePage est une classe d'aide qui facilite l'utilisation des données affichées sur les chronologies.

Le traitement des données affichées dans une chronologie commence par l'exécution de la fonction correspondante de l'include de script spécifié. Comme les autres includes de script, la syntaxe du langage est JavaScript et suit les contraintes de sécurité par défaut de ce type de ressource. Cependant, comme les différents types d'options d'affichage sont complexes, une classe d'aide a été créée. Pour afficher une chronologie, étendez la classe AbstractTimelineSchedulePage et associez-la à la page de calendrier correspondante. Au minimum, l'extension des classes devrait remplacer la méthode getItems(), car il s'agit du gestionnaire d'événements primaire pour renvoyer les éléments à afficher sur le client.

Le client traite les données renvoyées par AbstractTimelineSchedulePage en deux phases. La première phase effectue les mises à jour réelles de la chronologie. Immédiatement après, si elle est configurée, la deuxième phase affiche une zone de message de réussite, une zone de message d'erreur ou une invite de message de dialogue. Au cours de la première phase, les options disponibles pour la manipulation des données sont les suivantes :

* Ne mettre à jour aucun élément : il s'agit du comportement par défaut. N'effectuez aucune des étapes restantes de la première phase.
* Mettre à jour avec des éléments spécifiques : Cela se fait à l'aide de : add().
* Affichez la chronologie à l'aide de la fonction getItems() : Pour ce faire, utilisez : `setDoRenderTimeline(true).`

Remarque :  
Si les deux TimelineItems sont renvoyés et setDoReRenderTimeline qu'elle est définie sur vrai, le système ignore la setDoReRenderTimeline propriété et affiche explicitement uniquement les TimelineItems qui ont été ajoutés par la fonction add().

Les options disponibles pour la deuxième phase sont les suivantes :

* N'afficher aucune boîte de message : c'est le comportement par défaut.
* Affichez une boîte de dialogue Réussite : Pour ce faire, utilisez : setStatusSuccess().
* Affichez une boîte de dialogue d'erreur : Pour ce faire, utilisez : setStatusError().
* Afficher une boîte de dialogue de confirmation : Cela se fait à l'aide de : setStatusPrompt().

Remarque :  
Une classe de script include qui étend AbstractTimelineSchedulePage reçoit automatiquement tous les paramètres d'URI de l'URL d'origine dont le préfixe commence `par sysparm_timeline_`. Pour accéder aux valeurs de` celles-ci, utilisez : this.getParameter(<< sysparm_timeline_VARIABLE >>) ;` à l'intérieur de votre classe étendue.

Ceci est utile si vous avez besoin d'afficher une page de calendrier à partir d'un élément dynamique, par exemple à partir d'un menu contextuel à partir d'une liste. En transmettant des données dynamiques via l'URL, la page de calendrier inclut automatiquement ces paramètres à l'intérieur des appels Ajax et sera donc accessible à l'intérieur de l'include de script AbstractTimelineSchedulePage .

## AbstractTimelineSchedulePage : add(ObjTimeline d'objet) {#ariaid-title2}

Ajoute un objet TimelineItem qui sera renvoyé au client et affiché de manière appropriée sur la chronologie.
{#r_ATSP-add_O__table_efq_q14_15__entry__3}

| Nom | Type | Description |
|-|-|-|
| Chronologie Obj | Objet | L'objet TimelineItem à ajouter à la chronologie. |
[Tableau 1. Paramètres]

{#r_ATSP-add_O__table_efq_q14_15} {#r_ATSP-add_O__table_ffq_q14_15__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 2. Renvoie]

{#r_ATSP-add_O__table_ffq_q14_15}

## AbstractTimelineSchedulePage : addSeparator() {#ariaid-title3}

Ajoute un séparateur d'images horizontales à la liste des éléments de chronologie. Tous les éléments futurs ajoutés via add() seront ajoutés dans la chronologie suivante.
Tous les éléments futurs ajoutés à l'aide de la méthode add() sont ajoutés dans l'image de chronologie suivante.
{#r_ATSP-addSeparator__table_gfq_q14_15__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 3. Paramètres]

{#r_ATSP-addSeparator__table_gfq_q14_15} {#r_ATSP-addSeparator__table_hfq_q14_15__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 4. Renvoie]

{#r_ATSP-addSeparator__table_hfq_q14_15}  
L'exemple de code suivant montre comment appeler cette méthode.

    // Inside of a script include that extends AbstractTimelineSchedulePage
          this.addSeparator();
        
## AbstractTimelineSchedulePage : elementMoveX(String spanSysId, String newStartDateTimeMs) {#ariaid-title4}

Gestionnaire d'événements lorsqu'un parcours de chronologie se déplace horizontalement.
{#r_ATSP-elementMoveX_S_S__table_x3f_tc4_15__entry__3}

| Nom | Type | Description |
|-|-|-|
| spanSysId (en anglais seulement) | Chaîne | L'ID système du parcours actuel en cours d'ajustement. |
| newStartDateTimeMs | Chaîne | La nouvelle heure de début du parcours, en millisecondes. Assurez-vous d'analyser la chaîne à l'aide de parseInt() avant d'effectuer des comparaisons numériques. |
[Tableau 5. Paramètres]

{#r_ATSP-elementMoveX_S_S__table_x3f_tc4_15} {#r_ATSP-elementMoveX_S_S__table_y3f_tc4_15__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 6. Renvoie]

{#r_ATSP-elementMoveX_S_S__table_y3f_tc4_15}

## AbstractTimelineSchedulePage : elementMoveXY(String spanSysId, String itemSysId, String itemSysId, String newItemSysId, String newStartDateTimeMs) {#ariaid-title5}

Gestionnaire d'événements lorsqu'un parcours de chronologie se déplace à la fois horizontalement et verticalement.
{#r_ATSP-elementMoveXY_S_S_S_S_S__table_bjf_tc4_15__entry__3}

| Nom | Type | Description |
|-|-|-|
| spanSysId (en anglais seulement) | Chaîne | L'ID système du parcours actuel en cours d'ajustement. |
| itemSysId | Chaîne | L'ID système de l'élément de chronologie associé au parcours actuel. |
| nouveauItemSysId | Chaîne | ID système de l'élément de chronologie (une ligne) dans lequel le parcours actuel a été déplacé. |
| newStartDateTimeMs | Chaîne | La nouvelle heure de début du parcours, en millisecondes. Assurez-vous d'analyser la chaîne à l'aide de parseInt() avant d'effectuer des comparaisons numériques. |
[Tableau 7. Paramètres]

{#r_ATSP-elementMoveXY_S_S_S_S_S__table_bjf_tc4_15} {#r_ATSP-elementMoveXY_S_S_S_S_S__table_cjf_tc4_15__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 8. Renvoie]

{#r_ATSP-elementMoveXY_S_S_S_S_S__table_cjf_tc4_15}

## AbstractTimelineSchedulePage : elementMoveY(String spanSysId, String itemSysId, String newItemSysId) {#ariaid-title6}

Gestionnaire d'événements lorsqu'un parcours de chronologie se déplace verticalement.
{#r_ATSP-elementMoveY_S_S_S__table_z3f_tc4_15__entry__3}

| Nom | Type | Description |
|-|-|-|
| spanSysId (en anglais seulement) | Chaîne | L'ID système du parcours actuel en cours d'ajustement. |
| itemSysId | Chaîne | L'ID système de l'élément de chronologie associé au parcours actuel. |
| nouveauItemSysId | Chaîne | ID système de l'élément de chronologie (une ligne) dans lequel le parcours actuel a été déplacé. |
[Tableau 9. Paramètres]

{#r_ATSP-elementMoveY_S_S_S__table_z3f_tc4_15} {#r_ATSP-elementMoveY_S_S_S__table_ajf_tc4_15__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 10. Renvoie]

{#r_ATSP-elementMoveY_S_S_S__table_ajf_tc4_15}

## AbstractTimelineSchedulePage : elementSuccessor(String spanSysId, String newSuccSpanId) {#ariaid-title7}

Gestionnaire d'événements lorsqu'une relation de chronologie a été créée entre deux parcours.
{#r_ATSP-elementSuccessor_S_S__table_djf_tc4_15__entry__3}

| Nom | Type | Description |
|-|-|-|
| spanSysId (en anglais seulement) | Chaîne | L'ID système du parcours actuel qui sera un prédécesseur de la relation nouvellement créée. |
| newSuccSpanId | Chaîne | L'ID système du parcours du successeur à partir de la relation créée. |
[Tableau 11. Paramètres]

{#r_ATSP-elementSuccessor_S_S__table_djf_tc4_15} {#r_ATSP-elementSuccessor_S_S__table_ejf_tc4_15__entry__2}

| Type | Description |
|-|-|
| nul | Valeur de retour |
[Tableau 12. Renvoie]

{#r_ATSP-elementSuccessor_S_S__table_ejf_tc4_15}

## AbstractTimelineSchedulePage : elementTimeAdjustEnd(String spanSysId, String newEndDateTimeMs) {#ariaid-title8}

Gestionnaire d'événements indiquant quand la date de fin d'un parcours de chronologie a été modifiée.
{#r_ATSP-elementTimeAdjustEnd_S_S__table_qbb_3g4_15__entry__3}

| Nom | Type | Description |
|-|-|-|
| spanSysId (en anglais seulement) | Chaîne | ID système du parcours actuel en cours d'ajustement. |
| newEndDateTimeMs | Chaîne | La nouvelle heure de fin du parcours, en millisecondes. Assurez-vous d'analyser la chaîne à l'aide de parseInt() avant d'effectuer des comparaisons numériques. |
[Tableau 13. Paramètres]

{#r_ATSP-elementTimeAdjustEnd_S_S__table_qbb_3g4_15} {#r_ATSP-elementTimeAdjustEnd_S_S__table_rbb_3g4_15__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 14. Renvoie]

{#r_ATSP-elementTimeAdjustEnd_S_S__table_rbb_3g4_15}

## AbstractTimelineSchedulePage : elementTimeAdjustStart(String spanSysId, String newStartDateTimeMs) {#ariaid-title9}

Gestionnaire d'événements lorsque la date de début d'un parcours de chronologie a été modifiée.
{#r_ATSP-elementTimeAdjustStart_S_S__table_obb_3g4_15__entry__3}

| Nom | Type | Description |
|-|-|-|
| spanSysId (en anglais seulement) | Chaîne | ID système du parcours actuel en cours d'ajustement. |
| newStartDateTimeMs | Chaîne | La nouvelle heure de début du parcours, en millisecondes. Assurez-vous d'analyser la chaîne à l'aide de parseInt() avant d'effectuer des comparaisons numériques. |
[Tableau 15. Paramètres]

{#r_ATSP-elementTimeAdjustStart_S_S__table_obb_3g4_15} {#r_ATSP-elementTimeAdjustStart_S_S__table_pbb_3g4_15__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 16. Renvoie]

{#r_ATSP-elementTimeAdjustStart_S_S__table_pbb_3g4_15}

## AbstractTimelineSchedulePage : getItems() {#ariaid-title10}

Gestionnaire d'événements pour le retour des éléments de calendrier à afficher sur la chronologie.
{#r_ATSP-getItems__table_v3f_tc4_15__entry__3}

| Nom | Type | Description |
|-|-|-|
| aucun |   |   |
[Tableau 17. Paramètres]

{#r_ATSP-getItems__table_v3f_tc4_15} {#r_ATSP-getItems__table_w3f_tc4_15__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 18. Renvoie]

{#r_ATSP-getItems__table_w3f_tc4_15}

## AbstractTimelineSchedulePage : inputBox(String strInputText) {#ariaid-title11}

Gestionnaire d'événements lorsqu'une chaîne a été saisie dans la zone de saisie du volet gauche.
{#r_ATSP-inputBox_S__table_sbb_3g4_15__entry__3}

| Nom | Type | Description |
|-|-|-|
| strInputText | Chaîne | Texte qui a été saisi dans la zone de saisie du volet de gauche. |
[Tableau 19. Paramètres]

{#r_ATSP-inputBox_S__table_sbb_3g4_15} {#r_ATSP-inputBox_S__table_tbb_3g4_15__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 20. Renvoie]

{#r_ATSP-inputBox_S__table_tbb_3g4_15}

## AbstractTimelineSchedulePage : itemMove(String itemSysId, String newItemSysId) {#ariaid-title12}

Gestionnaire d'événements lorsqu'un élément de ligne de chronologie a été déplacé et glissé dans un autre élément de ligne.
{#r_ATSP-itemMove_S_S__table_ubb_3g4_15__entry__3}

| Nom | Type | Description |
|-|-|-|
| itemSysId | Chaîne | L'ID système de l'élément de chronologie associé au parcours actuel. |
| nouveauItemSysId | Chaîne | ID système de l'élément de chronologie (une ligne) dans lequel le parcours actuel a été déplacé. |
[Tableau 21. Paramètres]

{#r_ATSP-itemMove_S_S__table_ubb_3g4_15} {#r_ATSP-itemMove_S_S__table_vbb_3g4_15__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 22. Renvoie]

{#r_ATSP-itemMove_S_S__table_vbb_3g4_15}

## AbstractTimelineSchedulePage : setDoRenderTimeline(Booléen b) {#ariaid-title13}

Indique s'il faut ou non restituer tous les éléments de chronologie à l'aide de la fonction getItems().
{#r_ATSP-setDoReRenderTimeline_B__table_kfq_q14_15__entry__3}

| Nom | Type | Description |
|-|-|-|
| b | Booléen | Si vrai, restituez la chronologie en effectuant un nouvel appel d'événement au gestionnaire getItems() du serveur. |
[Tableau 23. Paramètres]

{#r_ATSP-setDoReRenderTimeline_B__table_kfq_q14_15} {#r_ATSP-setDoReRenderTimeline_B__table_lfq_q14_15__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 24. Renvoie]

{#r_ATSP-setDoReRenderTimeline_B__table_lfq_q14_15}

## AbstractTimelineSchedulePage : setPageTitle(String strTitle) {#ariaid-title14}

Spécifie le texte à afficher comme titre de la chronologie.
Le titre de la page peut être défini (et mis à jour) à partir de n'importe quel événement interactif ; Toutefois, il est recommandé de le définir lors de l'événement getItems().
{#r_ATSP-setPageTitle_S__table_ifq_q14_15__entry__3}

| Nom | Type | Description |
|-|-|-|
| strTitle (en anglais seulement) | Chaîne | Texte à afficher sur le titre de la chronologie. |
[Tableau 25. Paramètres]

{#r_ATSP-setPageTitle_S__table_ifq_q14_15} {#r_ATSP-setPageTitle_S__table_jfq_q14_15__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 26. Renvoie]

{#r_ATSP-setPageTitle_S__table_jfq_q14_15}

## AbstractTimelineSchedulePage : setStatusError(String strTitle, String strMessage) {#ariaid-title15}

Définit la demande d'événement actuel sur un état d'erreur avec un titre et un message spécifiés à afficher dans la phase deux du traitement des événements GlideChronologie .
{#r_ATSP-setStatusError_S_S__table_mfq_q14_15__entry__3}

| Nom | Type | Description |
|-|-|-|
| strTitle (en anglais seulement) | Chaîne | Texte à afficher dans le titre de la boîte de dialogue. |
| strMessage | Chaîne | Texte à afficher dans la boîte de dialogue. Le texte peut contenir une mise en forme HTML. |
[Tableau 27. Paramètres]

{#r_ATSP-setStatusError_S_S__table_mfq_q14_15} {#r_ATSP-setStatusError_S_S__table_nfq_q14_15__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 28. Renvoie]

{#r_ATSP-setStatusError_S_S__table_nfq_q14_15}

## AbstractTimelineSchedulePage : setStatusPrompt(String strTitle, String strOkFunction, String strCancelFunction, String strCloseFunction) {#ariaid-title16}

Définit la demande d'événement actuel sur un état d'erreur d'invite avec un titre et un message spécifiés à afficher dans une boîte de dialogue de confirmation pendant la deuxième phase du traitement des événements GlideTimeline . La boîte de confirmation affiche un bouton OK et un bouton Annuler qui génèrent chacun de nouveaux événements qui appelleront les fonctions spécifiées les arguments du paramètre. Les fonctions personnalisées définies pour OK, Annuler et Fermer reçoivent les mêmes arguments de paramètre que celles de l'événement actuel.
La boîte de confirmation affiche un bouton OK et un bouton Annuler qui génèrent chacun de nouveaux événements qui appelleront les fonctions spécifiées les arguments du paramètre.  
Remarque :  
Les fonctions personnalisées définies pour OK, Annuler et Fermer reçoivent les mêmes arguments de paramètre que celles de l'événement actuel.
{#r_ATSP-setStatusPrompt_S_S_S_S__table_t3f_tc4_15__entry__3}

| Nom | Type | Description |
|-|-|-|
| strTitle (en anglais seulement) | Chaîne | Texte à afficher dans la boîte de dialogue. Le texte peut contenir une mise en forme HTML. |
| strOkFunction | Chaîne | Fonction à appeler dans la classe d'include de script actuelle si l'utilisateur clique sur le bouton OK . |
| strCancelFunction | Chaîne | Fonction à appeler dans la classe d'include de script actuelle si l'utilisateur clique sur le bouton Annuler . |
| strCloseFunction | Chaîne | Fonction à appeler dans la classe de script include actuelle si l'utilisateur clique sur le bouton Fermer . |
[Tableau 29. Paramètres]

{#r_ATSP-setStatusPrompt_S_S_S_S__table_t3f_tc4_15} {#r_ATSP-setStatusPrompt_S_S_S_S__table_u3f_tc4_15__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 30. Renvoie]

{#r_ATSP-setStatusPrompt_S_S_S_S__table_u3f_tc4_15}  

    var MyTimelineScriptIncludeClass = Class.create();
          MyTimelineScriptIncludeClass.prototype = Object.extendsObject(AbstractTimelineSchedulePage, {
          
          getItems: function() {
          //...
          },
          
          elementTimeAdjustEnd: function(spanSysId, newEndDateTimeMs) {
          // Display a status prompt dialog box
          this.setStatusPrompt('Confirm Action', 'Are you sure you want to do that?',
          'this._myOkHandlerFunction',  
          'this._myCancelHandlerFunction',
          'this._myCloseHandlerFunction');
          },
          
          _myOkHandlerFunction: function(spanSysId, newEndDateTimeMs) { // ... },
          
          _myCancelHandlerFunction: function(spanSysId, newEndDateTimeMs) { // ... },
          
          _myCloseHandlerFunction: function(spanSysId, newEndDateTimeMs) { // ... }
          };
        
## AbstractTimelineSchedulePage : setStatusSuccess(String strTitle, String strMessage) {#ariaid-title17}

Définit la demande d'événement actuel à un état de réussite avec un titre et un message spécifiés à afficher dans la phase deux du traitement des événements GlideChronolise .
{#r_ATSP-setStatusSuccess_S_S__table_ofq_q14_15__entry__3}

| Nom | Type | Description |
|-|-|-|
| strTitle (en anglais seulement) | Chaîne | Texte à afficher dans le titre de la boîte de dialogue. |
| strMessage | Chaîne | Texte à afficher dans la boîte de dialogue. Le texte peut contenir une mise en forme HTML. |
[Tableau 31. Paramètres]

{#r_ATSP-setStatusSuccess_S_S__table_ofq_q14_15} {#r_ATSP-setStatusSuccess_S_S__table_pfq_q14_15__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 32. Renvoie]

{#r_ATSP-setStatusSuccess_S_S__table_pfq_q14_15}