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. 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 } |
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 |