Table of Contents

ControlAddIn "Calendar UTCAP"

Namespace: CapVision.Core.Controls

Methods

SetRenderer

Définit l'affichage à utiliser.

Actuellement le calendrier supporter uniquement l'affichage sous la forme d'un planning d'équipe (TeamPlan).

procedure SetRenderer(rendererOptions: JsonObject)

Parameters

Name Type Description
rendererOptions JsonObject

Options du renderer.

Examples

Planning d'équipe (TeamPlan)

{
    renderer: 2,
    options: {
        StartingDate: "2024-01-01", // Date de début du calendrier
        EndingDate: "2024-01-31", // Date de fin du calendrier
        Locale: "fr-FR", // (Optionnel) Langue du calendrier
        TimePrecision: "2 hours", // (Optionnel) Précision des sous-périodes quotidiennes.
        SubDayPeriodNames: "{\"08:00\": \"8-10h\",\"10:00\": \"10-12h\",\"14:00\": \"14-16h\",\"16:00\": \"16-18h\"}", // (Optionnel) Nom des sous-périodes quotidiennes. Les clés sont les heures de début des sous-périodes. Les périodes non listées sont masquées. Les périodes débutent à minuit et on intervalle fixe définit par TimePrecision.
        CollapsedHeaderMaxVisibleRows: 2, // (Optionnel) Indique le nombre de lignes affichées par ressource par défaut avant de nécessiter de cliquer sur le bouton d'expansion pour voir les tâches supplémentaires.
        SubDayPeriodWidth: "100*", // (Optionnel) Largeur des sous-périodes quotidiennes en pixels. Peut être un nombre, ou un string avec "*" après le nombre, pour indiquer d'occuper toute la largeur disponible.
        HeaderColumnWidth: 150, // (Optionnel) Largeur du bandeau des ressources.
        DayFormat: "dddd dd MMMM yyyy" // (Optionnel) Format des dates à afficher pour chaque jour. Si non renseigné, le format par défaut de la locale est utilisé.
    }
};

GetCalendar

Retourne un objet Calendar dans l'événement OnAfterGetCalendar()

procedure GetCalendar()

CreateTask

Ajoute une tâche dans le calendrier.

procedure CreateTask(task: JsonObject)

Parameters

Name Type Description
task JsonObject

Tâche à ajouter

Examples

La structure d'une tâche est la suivante :

{
    id: "d94cdc7d-d477-4ae5-89cb-119f5d892f5d", // Identifiant unique de la tâche
    startingDateTime: "2024-01-01T08:00:00", // Date et heure de début de la tâche
    endingDateTime: "2024-01-01T10:00:00", // Date et heure de fin de la tâche
    isWholeDay: false, // (Optionnel) Spécifie si la tâche dure toute la journée, cette option n'est pas supportée actuellement
    assignedTo: "d155207f-23a7-4d70-a554-670833258c71", // Identifiant de la ressource à laquelle la tâche est assignée
    text: "Réunion", // (Optionnel) Texte principal de la tâche
    secondaryText: "Salle 1", // (Optionnel) Texte secondaire de la tâche
    tertiaryText: "Bâtiment C", // (Optionnel) Texte tertiaire de la tâche
    quantity: 2, // (Optionnel) Quantité de la tâche, utilisez-la pour, par exemple, indiquer la durée de la tâche
    isEditable: true, // (Optionnel) Indique si la tâche est modifiable dans le calendrier
    style: {
        background: "#ff0000", // (Optionnel) Couleur de fond de la tâche
        borderLeft: "#00ff00" // (Optionnel) Couleur de la bordure gauche de la tâche
    }
}

CreateTasks

Ajoute un ensemble de tâches dans le calendrier.

procedure CreateTasks(tasks: JsonArray)

Parameters

Name Type Description
tasks JsonArray

Tableau de tâches à ajouter (voir CreateTask pour la structure de chaque tâche).

DeleteTask

Supprime la tâche spécifiée.

procedure DeleteTask(taskId: Text)

Parameters

Name Type Description
taskId Text

Identifiant de la tâche à supprimer.

DeleteTasks

Supprime les tâches spécifiées.

procedure DeleteTasks(tasks: JsonArray)

Parameters

Name Type Description
tasks JsonArray

Tableau des identifiants de tâches à supprimer.

CreateResource

Créé la ressource pour affichage dans le calendrier.

procedure CreateResource(resource: JsonObject)

Parameters

Name Type Description
resource JsonObject

Resource à ajouter.

Examples

La structure d'une ressource est la suivante :

{ id: "d155207f-23a7-4d70-a554-670833258c71", // Identifiant unique de la ressource name: "Emilie Dupont", // (Optionnel) Nom de la ressource description: "Chargée de la gestion des stocks", // (Optionnel) Description de la ressource imageColor: "#ffd574", // (Optionnel) Couleur de l'anneau autour de l'image de la ressource image: "iVBORw...", // (Optionnel) Image de la ressource encodée en Base64 collapsed: false, // (Optionnel) Indique si la ressource est repliée }

CreateResources

Ajoute des ressources dans le calendrier.

procedure CreateResources(resources: JsonArray)

Parameters

Name Type Description
resources JsonArray

Tableau de ressource à ajouter (voir CreateResource pour la structure de chaque tâche)

DeleteResource

Supprime la ressource spécifiée.

procedure DeleteResource(id: Text)

Parameters

Name Type Description
id Text

Identifiant de la ressource à supprimer du calendrier.

DeleteResources

Supprime les ressources spécifiées du calendrier.

procedure DeleteResources(resources: JsonArray)

Parameters

Name Type Description
resources JsonArray

Tableau des identifiants de ressources à supprimer.

CreateMarker

Créé un marqueur sur le calendrier.

procedure CreateMarker(marker: JsonObject)

Parameters

Name Type Description
marker JsonObject

Marqueur à ajouter.

Examples

La structure d'un marqueur est la suivante :

{
    id: "64dd4c30-d78e-4757-b879-f15dfa34a986", // Identifiant unique du marqueur
    anchorType: "cell", // Type d'ancrage du marqueur. La seule valeur supportée actuellement est "cell".
    anchorId: "d155207f-23a7-4d70-a554-670833258c71/2024-01-01", // Spécifie l'adressage de l'élément sur lequel le marqueur doit être positionné. 
    title: "Jour férié", // (Optionnel) Titre du marqueur
    style: {
        color1: "#fcc700", // (Optionnel) Couleur principale du marqueur
        color2: "#000" // (Optionnel) Couleur secondaire du marqueur
    },
    shape: "line" // Forme du marqueur. La seule valeur supportée actuellement est "line".
}

Pour anchorType = cell, anchorId doit être de la forme "ID de la ressource/YYYY-MM-DD".

Pour un shape = line, le marqueur est affiché comme une ligne horizontale. Le style de la ligne supporte une ou deux couleurs. Si vous spécifiez une seule couleur, la ligne est affichée de façon unie. Sinon, elle affiche une alternance des deux couleurs.

CreateMarkers

Créé les marqueurs sur le calendrier.

procedure CreateMarkers(markers: JsonArray)

Parameters

Name Type Description
markers JsonArray

Tableau de marqueurs à ajouter (voir CreateMarker pour la structure de chaque marqueur)

DeleteMarkers

Supprime tous les marqueurs du calendrier.

procedure DeleteMarkers()

SetTaskTooltip

Définit l'info-bulle pour une tâche.

procedure SetTaskTooltip(taskTooltip: JsonObject)

Parameters

Name Type Description
taskTooltip JsonObject

Info-bulle à lier à une tâche.

Examples

Structure d'une info-bulle :

{
    id: "d94cdc7d-d477-4ae5-89cb-119f5d892f5d", // Identifiant de la tâche à laquelle lier l'info-bulle
    content: "Réunion", // Contenu de l'info-bulle. Vous pouvez utiliser du HTML pour formater le contenu.
}

Remarks

Vous ne pouvez pas appeler cette méthode pour une tâche qui n'existe pas.

SetTasksTooltip

Définit l'info-bulle à afficher pour un ensemble de tâches.

procedure SetTasksTooltip(taskTooltips: JsonArray)

Parameters

Name Type Description
taskTooltips JsonArray

Tableau d'info-bulles (voir SetTaskTooltip pour le format d'une info-bulle).

Remarks

Vous ne pouvez pas appeler cette méthode pour des tâches qui n'existent pas.

OpenTaskContextMenu

Ouvre un menu contextuel sur une tâche. Cette méthode est généralement appelée en réaction à l'événement OnTaskContextMenuRequested.

procedure OpenTaskContextMenu(taskId: Text, items: JsonArray)

Parameters

Name Type Description
taskId Text

Identifiant de la tâche pour laquelle ouvrir le menu. Notez que vous pouvez indiquer n'importe quel identifiant ici, mais il sera réutilisé par OnTaskContextMenuClicked comme identifiant de la tâche concernée par le menu contextuel.
items JsonArray

Liste des entrées du menu contextuel à afficher (voir OpenCalendarContextMenu pour le format d'une entrée de menu contextuel).

OpenCalendarContextMenu

Déclenche l'ouverture du menu contextuel. Cette méthode est généralement appelée en réaction à l'événement OnCalendarContextMenuRequested.

procedure OpenCalendarContextMenu(selectedDate: DateTime, selectedResourceId: Text, items: JsonArray)

Parameters

Name Type Description
selectedDate DateTime

Date pour laquelle le menu doit être ouvert.
selectedResourceId Text

Ressource pour laquelle le menu doit être ouvert.
items JsonArray

Liste des entrées du menu contextuel à afficher.

Examples

Structure d'une entrée de menu contextuel :

{
    id: "delete", // Identifiant de l'entrée
    caption: "Supprimer", // Texte de l'entrée, si vous indiquez un tiret (-), l'entrée sera affichée comme une séparation
    image: "Delete" // (Optionnel) Nom de l'icône à afficher. Le nom de l'icône doit correspondre à un nom parmis ceux de la liste Office UI Fabric Icons (https://uifabricicons.azurewebsites.net/).
}

Ping

Produit un événement Pong après le délai spécifié.

procedure Ping(Timeout: Integer)

Parameters

Name Type Description
Timeout Integer

Délai en millisecondes jusqu'à la réception de l'événement Pong.

See also