Bibliothèque JavaScript de TM1 Web

La bibliothèque JavaScript de Cognos TM1 Web permet d'accéder à l'aide d'un programme aux objets de feuille Web et aux objets CubeViewer de TM1 Web dans un environnement de développement de pages Web associant HTML, JavaScript et Dojo. Une bonne connaissance de JavaScript, de Dojo Toolkit et du modèle Objet de Document (DOM) est nécessaire pour utiliser la bibliothèque JavaScript.

Présentation

La bibliothèque JavaScript de Cognos TM1 Web contient les principales classes suivantes :

Classe Workbook
Représente une feuille Web de TM1 Web.
Classe CubeViewer
Représente un objet CubeViewer de TM1 Web.

Ces classes principales constituent une extension de la classe de widget du Toolkit Dojo appelée dijit._WidgetBase. Cette extension permet aux objets Workbook d'être affectés en tant qu'enfants aux autres objets Dojo, par exemple à un conteneur à onglets Dojo ou à un autre conteneur.

Pour plus d'informations sur Dojo, consultez sa documentation : http://dojotoolkit.org/documentation/.

Les objets de feuille Web et CubeViewer disposent également d'un ensemble de propriétés et de méthodes accessibles à l'aide d'un programme. Ces objets sont chargés de manière asynchrone et leur chargement doit être terminé pour que le code puisse interagir avec eux.

Remarque :

Dans la bibliothèque JavaScript de Cognos TM1 Web, les objets suivants sont obsolètes :

  • tm1web/cubeview/CubeViewer
  • tm1web/websheet/Workbook

Vous devez utiliser tm1web/api/CubeViewer et tm1web/api/Workbook à la place. Les modules présents dans les packages tm1web/cubeview et tm1web/websheet sont désormais des alias des modules figurant dans le package tm1web/api package.

Configuration

La configuration suivante est nécessaire pour utiliser la bibliothèque JavaScript de Cognos TM1 Web.

  1. Installez Cognos TM1 Web et vérifiez que vous pouvez vous connecter à l'interface utilisateur standard avec un navigateur Web.
  2. Ajoutez les références requises à la section head des fichiers de page Web personnalisés qui utilisent la bibliothèque JavaScript.

    Pour plus d'informations, voir Balises HTML <head> et <body> requises pour l'utilisation de la bibliothèque JavaScript.

Premiers pas avec la bibliothèque JavaScript

Après avoir configuré votre environnement Cognos TM1 Web, vous pouvez commencer à coder vos pages Web pour accéder aux objets à l'aide de la bibliothèque JavaScript. Pour obtenir plus d'informations et consulter des exemples, reportez-vous aux rubriques suivantes :

Configuration du programme de chargement AMD de la bibliothèque JavaScript

A partir d'IBM® Planning Analytics Local 2.0.0, il n'est plus obligatoire d'ajouter la version de Dojo fournie avec TM1 Web pour charger les modules de la bibliothèque JavaScript de TM1 Web.

TM1 Web prend désormais en charge l'utilisation du programme de chargement AMD à partir de Dojo version 1.7 pour charger les modules de la bibliothèque JavaScript.

Pour plus d'informations, voir Configuration du programme de chargement AMD de la bibliothèque JavaScript.