Documentation technique du dataplot

Utilisation de postal

Initialisation

Le widget utilise postal xframe et postal federation pour recevoir et envoyer des messages postal. Voici comment initialiser postal pour communiquer avec le dataplot.

Les scripts à inclure sont :

    <!-- Postal -->
    <script type="text/javascript" src="js/libs/browser-polyfill.min.js">
    </script>
    <script type="text/javascript" src="js/libs/lodash-3.10.1.custom.min.js">
    </script>
    <script type="text/javascript" src="js/libs/postal-2.0.4.min.js"></script>
    <script type="text/javascript" src="js/libs/postal.federation-0.5.3.min.js">
    </script>
    <script type="text/javascript" src="js/libs/postal.xframe-0.5.0.min.js">
    </script>

Le code javascript d'initialisation :

function initPostalFederation(postal) {
  postal.instanceId('<your unique name here>');
  // An empty allowedOrigins makes no restrictions on the site where
  // the dataplot code is coming from.
  postal.fedx.transports.xframe.configure({
    allowedOrigins: []
  });
  postal.fedx.addFilter([
    { channel: 'dataplot', topic: '#', direction: 'both' }
  ]);
  postal.fedx.signalReady();
}

Attention, il ne faut pas envoyer de messages trop vite, parce que l'initialisation du dataplot est asynchrone, et les messages envoyés avant que le dataplot ne soit initialisé sont perdus.

Messages échangés

Channel	Topic	Direction	Data	Description
dataplot	table.highlight.row	Réception / Émission	{ serieIndex: serieIndex, rowid: rowid }	En réception, affiche le popup du point identifié. Si on clique sur un point, l'identifiant de ce point est émis.
dataplot	catalog.load	Réception	{ url: url, colour: colour, name: name }	L'url est celle d'une VOTable dont le contenu est ajouté comme nouvelle courbe. La couleur et le nom de la courbe sont utlisées.