Difference: DashbordApi (1 vs. 8)

Revision 82017-05-04 - PascalWassong

 
META TOPICPARENT name="WidgetsProjet"

API d'un widget pour le dashboard

Liste des fonctions qu'un widget doit implémenter pour pouvoir être intégré dans le dashboard

La communication avec postal peut être activée ou désactivée pour chaque widget. C'est la fonction communicateWithOther qui est appelée. Cette fonction est donc l'endroit idéal pour gérer tout ce qui concerne postal, et elle peut être utilisée par la fonction initialisation.

La fonction reset est appelée pour remettre le widget à zéro. Ça veut dire que tout le DOM doit être réinitialiser, toutes les variables remises à leur état initial. C'est aussi une fonction qu'il est utile d'appeler à partir de initialisation.

Nom méthode Arguments Retour Détails
Changed:
<
<
id aucun une chaîne de caractère, un identifiant pour ce widget C'est à partir de ce mot que sont créés les identifiants des instances de ce widget, en ajoutant un numéro à la fin s'il y a plusieurs instances
>
>
id aucun une chaîne de caractère, un identifiant pour ce widget C'est à partir de ce mot que sont créés les identifiants des instances de ce widget, en ajoutant un numéro à la fin s'il y a plusieurs instances. La caractère , (virgule) est interdit.
 
name aucun une chaîne de caractère C'est le texte qui va être affiché à l'utilisateur pour créér un widget de ce type
description aucun une chaîne de caractère C'est le texte qui va servir de tooltip à ce widget
icon aucun un caractère Le caractère identifie une icône de la fonte FontAwesome. Par exemple : &#f129;
capabilities aucun un objet 
return {
      isIframe: false,
      canBeShared: true,
      isSampEnabled: true,
      canSaveAsPng: true,
      canCommunicate: true,
      canBeFullscreen: true
    }
Changed:
<
<
initialise 1. dashboardId : l'identifiant unique de ce widget. Il doit être inclut dans tous les attributs id qui sont créé dans le DOM, pour les distinguer des autres widgets du même type.
2. loadedData contient dans le champ votables la liste des votables chargées. C'est le résultat de l'événement table.load.data.
3. postal : l'objet postal.
4. env : indique l'environnement dans lequel le widget se trouve. C'est une chaîne de caracatères qui a 3 valeurs possibles : dashboard, portal et alone. 		aucun Appeler les fonctions communicateWithOther(true) et reset()
>
>
initialise 1. dashboardId : l'identifiant unique de ce widget. Il doit être inclut dans tous les attributs id qui sont créé dans le DOM, pour les distinguer des autres widgets du même type.
2. options contient dans le champ loadedVotables un tableau de la liste des votables chargées. C'est le résultat de l'événement table.load.data. Contient aussi le champ urlArguments avec les arguments venant de l'url spécifique à ce widget. Contient aussi le champ globalUrlArguments avec les arguments venant de l'url commun à tous les widgets. Les valeurs par défaut sont [] et ''.
3. postal : l'objet postal.
4. env : indique l'environnement dans lequel le widget se trouve. C'est une chaîne de caracatères qui a 3 valeurs possibles : dashboard, portal et alone. 		aucun Appeler les fonctions communicateWithOther(true) et reset()
 
communicateWithOther isCommunicating : booleen indiquant s'il faut activer ou désactiver la communication via postal aucun  
close aucun aucun Une implémentation minimum est this.communicateWithOther(false)
showShareUrl aucun aucun Affiche une boîte de dialogue, avec un lien. Peut utiliser la fonction utilities.paramsToUrlArguments
shareArguments aucun une chaîne de caractères donnant la configuration du widget Exemple pour positionner un AL : ra=xxx&dec=yyy. S'il n'y a pas d'argument, renvoyer la chaîne vide : ''
reset aucun aucun Réinitialise tout le widget. Ràz des variables, création du DOM, qu'il faut ajouter : $('#' + dashboardId).html(…)
resize width, height : la taille en pixels de l'espace disponible. aucun Indique au widget qu'il a changé de taille. Ça lui permet de réagir pour s'adapter.
saveAsPng aucun aucun  
sendSamp aucun aucun  

-- PascalWassong - 2017-03-28

Revision 72017-05-03 - PascalWassong

 
META TOPICPARENT name="WidgetsProjet"

API d'un widget pour le dashboard

Liste des fonctions qu'un widget doit implémenter pour pouvoir être intégré dans le dashboard

La communication avec postal peut être activée ou désactivée pour chaque widget. C'est la fonction communicateWithOther qui est appelée. Cette fonction est donc l'endroit idéal pour gérer tout ce qui concerne postal, et elle peut être utilisée par la fonction initialisation.

La fonction reset est appelée pour remettre le widget à zéro. Ça veut dire que tout le DOM doit être réinitialiser, toutes les variables remises à leur état initial. C'est aussi une fonction qu'il est utile d'appeler à partir de initialisation.

Nom méthode Arguments Retour Détails
id aucun une chaîne de caractère, un identifiant pour ce widget C'est à partir de ce mot que sont créés les identifiants des instances de ce widget, en ajoutant un numéro à la fin s'il y a plusieurs instances
name aucun une chaîne de caractère C'est le texte qui va être affiché à l'utilisateur pour créér un widget de ce type
description aucun une chaîne de caractère C'est le texte qui va servir de tooltip à ce widget
icon aucun un caractère Le caractère identifie une icône de la fonte FontAwesome. Par exemple : &#f129;
capabilities aucun un objet 
return {
      isIframe: false,
      canBeShared: true,
      isSampEnabled: true,
      canSaveAsPng: true,
      canCommunicate: true,
      canBeFullscreen: true
    }
initialise 1. dashboardId : l'identifiant unique de ce widget. Il doit être inclut dans tous les attributs id qui sont créé dans le DOM, pour les distinguer des autres widgets du même type.
2. loadedData contient dans le champ votables la liste des votables chargées. C'est le résultat de l'événement table.load.data.
3. postal : l'objet postal.
4. env : indique l'environnement dans lequel le widget se trouve. C'est une chaîne de caracatères qui a 3 valeurs possibles : dashboard, portal et alone. 		aucun Appeler les fonctions communicateWithOther(true) et reset()
communicateWithOther isCommunicating : booleen indiquant s'il faut activer ou désactiver la communication via postal aucun  
close aucun aucun Une implémentation minimum est this.communicateWithOther(false)
Changed:
<
<
shareUrl aucun aucun Affiche une boîte de dialogue, avec un lien. Peut utiliser la fonction utilities.paramsToUrlArguments
>
>
showShareUrl aucun aucun Affiche une boîte de dialogue, avec un lien. Peut utiliser la fonction utilities.paramsToUrlArguments
Added:
>
>
shareArguments aucun une chaîne de caractères donnant la configuration du widget Exemple pour positionner un AL : ra=xxx&dec=yyy. S'il n'y a pas d'argument, renvoyer la chaîne vide : ''
 
reset aucun aucun Réinitialise tout le widget. Ràz des variables, création du DOM, qu'il faut ajouter : $('#' + dashboardId).html(…)
resize width, height : la taille en pixels de l'espace disponible. aucun Indique au widget qu'il a changé de taille. Ça lui permet de réagir pour s'adapter.
saveAsPng aucun aucun  
sendSamp aucun aucun  

-- PascalWassong - 2017-03-28

Revision 62017-05-02 - PascalWassong

 
META TOPICPARENT name="WidgetsProjet"

API d'un widget pour le dashboard

Liste des fonctions qu'un widget doit implémenter pour pouvoir être intégré dans le dashboard

La communication avec postal peut être activée ou désactivée pour chaque widget. C'est la fonction communicateWithOther qui est appelée. Cette fonction est donc l'endroit idéal pour gérer tout ce qui concerne postal, et elle peut être utilisée par la fonction initialisation.

La fonction reset est appelée pour remettre le widget à zéro. Ça veut dire que tout le DOM doit être réinitialiser, toutes les variables remises à leur état initial. C'est aussi une fonction qu'il est utile d'appeler à partir de initialisation.

Nom méthode Arguments Retour Détails
id aucun une chaîne de caractère, un identifiant pour ce widget C'est à partir de ce mot que sont créés les identifiants des instances de ce widget, en ajoutant un numéro à la fin s'il y a plusieurs instances
name aucun une chaîne de caractère C'est le texte qui va être affiché à l'utilisateur pour créér un widget de ce type
description aucun une chaîne de caractère C'est le texte qui va servir de tooltip à ce widget
icon aucun un caractère Le caractère identifie une icône de la fonte FontAwesome. Par exemple : &#f129;
capabilities aucun un objet 
return {
      isIframe: false,
      canBeShared: true,
      isSampEnabled: true,
      canSaveAsPng: true,
      canCommunicate: true,
      canBeFullscreen: true
    }
initialise 1. dashboardId : l'identifiant unique de ce widget. Il doit être inclut dans tous les attributs id qui sont créé dans le DOM, pour les distinguer des autres widgets du même type.
2. loadedData contient dans le champ votables la liste des votables chargées. C'est le résultat de l'événement table.load.data.
3. postal : l'objet postal.
4. env : indique l'environnement dans lequel le widget se trouve. C'est une chaîne de caracatères qui a 3 valeurs possibles : dashboard, portal et alone. 		aucun Appeler les fonctions communicateWithOther(true) et reset()
communicateWithOther isCommunicating : booleen indiquant s'il faut activer ou désactiver la communication via postal aucun  
close aucun aucun Une implémentation minimum est this.communicateWithOther(false)
shareUrl aucun aucun Affiche une boîte de dialogue, avec un lien. Peut utiliser la fonction utilities.paramsToUrlArguments
reset aucun aucun Réinitialise tout le widget. Ràz des variables, création du DOM, qu'il faut ajouter : $('#' + dashboardId).html(…)
Changed:
<
<
resize aucun aucun Indique au widget qu'il a changé de taille. Ça lui permet de réagir pour s'adapter.
>
>
resize width, height : la taille en pixels de l'espace disponible. aucun Indique au widget qu'il a changé de taille. Ça lui permet de réagir pour s'adapter.
 
saveAsPng aucun aucun  
sendSamp aucun aucun  

-- PascalWassong - 2017-03-28

Added:
>
>

Revision 52017-05-02 - PascalWassong

 
META TOPICPARENT name="WidgetsProjet"

API d'un widget pour le dashboard

Liste des fonctions qu'un widget doit implémenter pour pouvoir être intégré dans le dashboard

La communication avec postal peut être activée ou désactivée pour chaque widget. C'est la fonction communicateWithOther qui est appelée. Cette fonction est donc l'endroit idéal pour gérer tout ce qui concerne postal, et elle peut être utilisée par la fonction initialisation.

La fonction reset est appelée pour remettre le widget à zéro. Ça veut dire que tout le DOM doit être réinitialiser, toutes les variables remises à leur état initial. C'est aussi une fonction qu'il est utile d'appeler à partir de initialisation.

Nom méthode Arguments Retour Détails
id aucun une chaîne de caractère, un identifiant pour ce widget C'est à partir de ce mot que sont créés les identifiants des instances de ce widget, en ajoutant un numéro à la fin s'il y a plusieurs instances
name aucun une chaîne de caractère C'est le texte qui va être affiché à l'utilisateur pour créér un widget de ce type
description aucun une chaîne de caractère C'est le texte qui va servir de tooltip à ce widget
icon aucun un caractère Le caractère identifie une icône de la fonte FontAwesome. Par exemple : &#f129;
capabilities aucun un objet 
return {
      isIframe: false,
      canBeShared: true,
      isSampEnabled: true,
      canSaveAsPng: true,
      canCommunicate: true,
      canBeFullscreen: true
    }
initialise 1. dashboardId : l'identifiant unique de ce widget. Il doit être inclut dans tous les attributs id qui sont créé dans le DOM, pour les distinguer des autres widgets du même type.
2. loadedData contient dans le champ votables la liste des votables chargées. C'est le résultat de l'événement table.load.data.
3. postal : l'objet postal.
4. env : indique l'environnement dans lequel le widget se trouve. C'est une chaîne de caracatères qui a 3 valeurs possibles : dashboard, portal et alone. 		aucun Appeler les fonctions communicateWithOther(true) et reset()
communicateWithOther isCommunicating : booleen indiquant s'il faut activer ou désactiver la communication via postal aucun  
close aucun aucun Une implémentation minimum est this.communicateWithOther(false)
shareUrl aucun aucun Affiche une boîte de dialogue, avec un lien. Peut utiliser la fonction utilities.paramsToUrlArguments
reset aucun aucun Réinitialise tout le widget. Ràz des variables, création du DOM, qu'il faut ajouter : $('#' + dashboardId).html(…)
Added:
>
>
resize aucun aucun Indique au widget qu'il a changé de taille. Ça lui permet de réagir pour s'adapter.
 
saveAsPng aucun aucun  
sendSamp aucun aucun  

-- PascalWassong - 2017-03-28

Deleted:
<
<

Revision 42017-04-27 - PascalWassong

 
META TOPICPARENT name="WidgetsProjet"

API d'un widget pour le dashboard

Liste des fonctions qu'un widget doit implémenter pour pouvoir être intégré dans le dashboard

La communication avec postal peut être activée ou désactivée pour chaque widget. C'est la fonction communicateWithOther qui est appelée. Cette fonction est donc l'endroit idéal pour gérer tout ce qui concerne postal, et elle peut être utilisée par la fonction initialisation.

La fonction reset est appelée pour remettre le widget à zéro. Ça veut dire que tout le DOM doit être réinitialiser, toutes les variables remises à leur état initial. C'est aussi une fonction qu'il est utile d'appeler à partir de initialisation.

Nom méthode Arguments Retour Détails
id aucun une chaîne de caractère, un identifiant pour ce widget C'est à partir de ce mot que sont créés les identifiants des instances de ce widget, en ajoutant un numéro à la fin s'il y a plusieurs instances
name aucun une chaîne de caractère C'est le texte qui va être affiché à l'utilisateur pour créér un widget de ce type
description aucun une chaîne de caractère C'est le texte qui va servir de tooltip à ce widget
icon aucun un caractère Le caractère identifie une icône de la fonte FontAwesome. Par exemple : &#f129;
capabilities aucun un objet 
return {
      isIframe: false,
      canBeShared: true,
      isSampEnabled: true,
      canSaveAsPng: true,
      canCommunicate: true,
      canBeFullscreen: true
    }
Changed:
<
<
initialise 1. dashboardId : l'identifiant unique de ce widget. Il doit être inclut dans tous les attributs id qui sont créé dans le DOM, pour les distinguer des autres widgets du même type.
2. loadedData contient dans le champ votables la liste des votables chargées. C'est le résultat de l'événement table.load.data.
3. postal : l'objet postal
4. isInDashboard : true si le widget fonctionne à l'intérieur de dashboard, false s'il est seul sur une page 		aucun Appeler les fonctions communicateWithOther(true) et reset()
>
>
initialise 1. dashboardId : l'identifiant unique de ce widget. Il doit être inclut dans tous les attributs id qui sont créé dans le DOM, pour les distinguer des autres widgets du même type.
2. loadedData contient dans le champ votables la liste des votables chargées. C'est le résultat de l'événement table.load.data.
3. postal : l'objet postal.
4. env : indique l'environnement dans lequel le widget se trouve. C'est une chaîne de caracatères qui a 3 valeurs possibles : dashboard, portal et alone. 		aucun Appeler les fonctions communicateWithOther(true) et reset()
 
communicateWithOther isCommunicating : booleen indiquant s'il faut activer ou désactiver la communication via postal aucun  
close aucun aucun Une implémentation minimum est this.communicateWithOther(false)
shareUrl aucun aucun Affiche une boîte de dialogue, avec un lien. Peut utiliser la fonction utilities.paramsToUrlArguments
reset aucun aucun Réinitialise tout le widget. Ràz des variables, création du DOM, qu'il faut ajouter : $('#' + dashboardId).html(…)
saveAsPng aucun aucun  
sendSamp aucun aucun  

-- PascalWassong - 2017-03-28

Revision 32017-04-24 - PascalWassong

 
META TOPICPARENT name="WidgetsProjet"

API d'un widget pour le dashboard

Liste des fonctions qu'un widget doit implémenter pour pouvoir être intégré dans le dashboard

La communication avec postal peut être activée ou désactivée pour chaque widget. C'est la fonction communicateWithOther qui est appelée. Cette fonction est donc l'endroit idéal pour gérer tout ce qui concerne postal, et elle peut être utilisée par la fonction initialisation.

La fonction reset est appelée pour remettre le widget à zéro. Ça veut dire que tout le DOM doit être réinitialiser, toutes les variables remises à leur état initial. C'est aussi une fonction qu'il est utile d'appeler à partir de initialisation.

Nom méthode Arguments Retour Détails
id aucun une chaîne de caractère, un identifiant pour ce widget C'est à partir de ce mot que sont créés les identifiants des instances de ce widget, en ajoutant un numéro à la fin s'il y a plusieurs instances
name aucun une chaîne de caractère C'est le texte qui va être affiché à l'utilisateur pour créér un widget de ce type
description aucun une chaîne de caractère C'est le texte qui va servir de tooltip à ce widget
icon aucun un caractère Le caractère identifie une icône de la fonte FontAwesome. Par exemple : &#f129;
capabilities aucun un objet 
return {
      isIframe: false,
      canBeShared: true,
      isSampEnabled: true,
      canSaveAsPng: true,
      canCommunicate: true,
      canBeFullscreen: true
    }
Changed:
<
<
initialise dashboardId : l'identifiant unique de ce widget. Il doit être inclut dans tous les attributs id qui sont créé dans le DOM, pour les distinguer des autres widgets du même type.
postal : l'objet postal
isInDashboard : true si le widget fonctionne à l'intérieur de dashboard, false s'il est seul sur une page 		aucun Appeler les fonctions communicateWithOther(true) et reset()
>
>
initialise 1. dashboardId : l'identifiant unique de ce widget. Il doit être inclut dans tous les attributs id qui sont créé dans le DOM, pour les distinguer des autres widgets du même type.
2. loadedData contient dans le champ votables la liste des votables chargées. C'est le résultat de l'événement table.load.data.
3. postal : l'objet postal
4. isInDashboard : true si le widget fonctionne à l'intérieur de dashboard, false s'il est seul sur une page 		aucun Appeler les fonctions communicateWithOther(true) et reset()
 
communicateWithOther isCommunicating : booleen indiquant s'il faut activer ou désactiver la communication via postal aucun  
close aucun aucun Une implémentation minimum est this.communicateWithOther(false)
shareUrl aucun aucun Affiche une boîte de dialogue, avec un lien. Peut utiliser la fonction utilities.paramsToUrlArguments
reset aucun aucun Réinitialise tout le widget. Ràz des variables, création du DOM, qu'il faut ajouter : $('#' + dashboardId).html(…)
saveAsPng aucun aucun  
sendSamp aucun aucun  

-- PascalWassong - 2017-03-28

Revision 22017-04-11 - PascalWassong

 
META TOPICPARENT name="WidgetsProjet"

API d'un widget pour le dashboard

Liste des fonctions qu'un widget doit implémenter pour pouvoir être intégré dans le dashboard

La communication avec postal peut être activée ou désactivée pour chaque widget. C'est la fonction communicateWithOther qui est appelée. Cette fonction est donc l'endroit idéal pour gérer tout ce qui concerne postal, et elle peut être utilisée par la fonction initialisation.

La fonction reset est appelée pour remettre le widget à zéro. Ça veut dire que tout le DOM doit être réinitialiser, toutes les variables remises à leur état initial. C'est aussi une fonction qu'il est utile d'appeler à partir de initialisation.

Nom méthode Arguments Retour Détails
id aucun une chaîne de caractère, un identifiant pour ce widget C'est à partir de ce mot que sont créés les identifiants des instances de ce widget, en ajoutant un numéro à la fin s'il y a plusieurs instances
name aucun une chaîne de caractère C'est le texte qui va être affiché à l'utilisateur pour créér un widget de ce type
description aucun une chaîne de caractère C'est le texte qui va servir de tooltip à ce widget
Changed:
<
<
icon aucun un caractère Le caractère identifie une icône de la fonte FontAwesome. Par exemple : &samp;#f129;
>
>
icon aucun un caractère Le caractère identifie une icône de la fonte FontAwesome. Par exemple : &#f129;
 
capabilities aucun un objet 
return {
      isIframe: false,
      canBeShared: true,
      isSampEnabled: true,
      canSaveAsPng: true,
      canCommunicate: true,
      canBeFullscreen: true
    }
Changed:
<
<
initialise dashboardId : l'identifiant unique de ce widget. Il doit être inclut dans tous id qui sont créé dans le DOM, pour les distinguer des autres widgets du même type.
postal : l'objet postal
isInDashboard : true si le widget fonctionne à l'intérieur de dashboard, false s'il est seul sur une page 		aucun Appeler les fonctions communicateWithOther(true) et reset()
>
>
initialise dashboardId : l'identifiant unique de ce widget. Il doit être inclut dans tous les attributs id qui sont créé dans le DOM, pour les distinguer des autres widgets du même type.
postal : l'objet postal
isInDashboard : true si le widget fonctionne à l'intérieur de dashboard, false s'il est seul sur une page 		aucun Appeler les fonctions communicateWithOther(true) et reset()
 
communicateWithOther isCommunicating : booleen indiquant s'il faut activer ou désactiver la communication via postal aucun  
close aucun aucun Une implémentation minimum est this.communicateWithOther(false)
Changed:
<
<
shareUrl aucun une chaîne de caractère Utiliser la fonction utilities.paramsToUrlArguments
>
>
shareUrl aucun aucun Affiche une boîte de dialogue, avec un lien. Peut utiliser la fonction utilities.paramsToUrlArguments
 
reset aucun aucun Réinitialise tout le widget. Ràz des variables, création du DOM, qu'il faut ajouter : $('#' + dashboardId).html(…)
saveAsPng aucun aucun  
sendSamp aucun aucun  

-- PascalWassong - 2017-03-28

Revision 12017-03-28 - PascalWassong

 
META TOPICPARENT name="WidgetsProjet"

API d'un widget pour le dashboard

Liste des fonctions qu'un widget doit implémenter pour pouvoir être intégré dans le dashboard

La communication avec postal peut être activée ou désactivée pour chaque widget. C'est la fonction communicateWithOther qui est appelée. Cette fonction est donc l'endroit idéal pour gérer tout ce qui concerne postal, et elle peut être utilisée par la fonction initialisation.

La fonction reset est appelée pour remettre le widget à zéro. Ça veut dire que tout le DOM doit être réinitialiser, toutes les variables remises à leur état initial. C'est aussi une fonction qu'il est utile d'appeler à partir de initialisation.

Nom méthode Arguments Retour Détails
id aucun une chaîne de caractère, un identifiant pour ce widget C'est à partir de ce mot que sont créés les identifiants des instances de ce widget, en ajoutant un numéro à la fin s'il y a plusieurs instances
name aucun une chaîne de caractère C'est le texte qui va être affiché à l'utilisateur pour créér un widget de ce type
description aucun une chaîne de caractère C'est le texte qui va servir de tooltip à ce widget
icon aucun un caractère Le caractère identifie une icône de la fonte FontAwesome. Par exemple : &samp;#f129;
capabilities aucun un objet 
return {
      isIframe: false,
      canBeShared: true,
      isSampEnabled: true,
      canSaveAsPng: true,
      canCommunicate: true,
      canBeFullscreen: true
    }
initialise dashboardId : l'identifiant unique de ce widget. Il doit être inclut dans tous id qui sont créé dans le DOM, pour les distinguer des autres widgets du même type.
postal : l'objet postal
isInDashboard : true si le widget fonctionne à l'intérieur de dashboard, false s'il est seul sur une page 		aucun Appeler les fonctions communicateWithOther(true) et reset()
communicateWithOther isCommunicating : booleen indiquant s'il faut activer ou désactiver la communication via postal aucun  
close aucun aucun Une implémentation minimum est this.communicateWithOther(false)
shareUrl aucun une chaîne de caractère Utiliser la fonction utilities.paramsToUrlArguments
reset aucun aucun Réinitialise tout le widget. Ràz des variables, création du DOM, qu'il faut ajouter : $('#' + dashboardId).html(…)
saveAsPng aucun aucun  
sendSamp aucun aucun  

-- PascalWassong - 2017-03-28

View topic | History: r8 < r7 < r6 < r5 | More topic actions...
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback