Propriétés de la classe Workbook

La classe Workbook a les propriétés suivantes.

Lors de l'instanciation de CubeViewer ou de Workbook, les propriétés suivantes sont communes aux deux objets.

sessionToken: Type : Chaîne; Indique la session TM1® Web à utiliser pour cet objet. N'utilisez pas cette propriété avec les propriétés pour adminHost, tm1Server, username, password et camPassport. Si cette propriété n'est pas définie, et sans autres données d'identification, une boîte de dialogue de connexion s'affiche pour l'utilisateur au démarrage de la session.

objectId

Type : Chaîne

ID classeur. Identificateur unique que vous pouvez utiliser pour référencer le classeur spécifique.

La propriété objectId doit être incluse dans une propriété sessionToken pour identifier la session TM1 Web.

Par exemple :

new Workbook({
    sessionToken: "previousSessionToken",
    objectId: "objectIdOfNewWorkbook"
});

adminHost: Type : Chaîne; Valeur par défaut : localhost; Hôte Admin à utiliser lors du chargement de l'objet. N'utilisez pas cette propriété avec la propriété sessionToken.

tm1Server: Type : Chaîne; Serveur TM1 à utiliser lorsque l'objet est chargé. N'utilisez pas cette propriété avec la propriété sessionToken. Si la propriété n'est pas définie, et si aucun jeton sessionToken n'est fourni, une boîte de dialogue de connexion s'affiche pour l'utilisateur au démarrage de la session.

username: Type : Chaîne; Nom d'utilisateur à utiliser lors du chargement de l'objet. N'utilisez pas cette propriété avec les propriétés sessionToken ou camPassport. Si la propriété n'est pas définie, et si aucun jeton sessionToken ou camPassport n'est fourni, une boîte de dialogue de connexion s'affiche pour l'utilisateur au démarrage de la session.

Mot de passe: Type : Chaîne; Mot de passe à utiliser lors du chargement de l'objet. Si la propriété n'est pas définie, et si aucun jeton sessionToken n'est fourni, une boîte de dialogue de connexion s'affiche pour l'utilisateur au démarrage de la session.

camPassport: Type : Chaîne; Passeport d'authentification Cognos® Analytics (passeport CAM) à utiliser lorsque vous chargez un objet. N'utilisez pas cette propriété avec username ou sessionToken.

domNode: Type : élément HTML; Elément HTML sous-jacent qui représente le widget. Cette propriété est automatiquement définie lors de la construction d'objets et ne doit pas être fournie lors de l'instanciation.; Pour plus d'informations, voir la documentation Dojo pour dijit._WidgetBase (https://dojotoolkit.org/reference-guide/1.10/dijit/_WidgetBase.html).

Les propriétés suivantes ne sont utilisées que lors de l'instanciation d'un objet Workbook.

chemin: Type : Chaîne; Chemin d'accès dans l'arborescence du dossier d'application du serveur TM1 pour le classeur à charger.; Par exemple : "Applications/Planning Sample/Bottom Up Input/Budget Input"

replaceOnNavigate: Type : Booléen (true par défaut); Si true, lors de la navigation à l'aide du bouton d'action, ce widget sera remplacé par le nouveau classeur et le classeur existant sera fermé.; Si false, le consommateur est chargé de créer un classeur ou de remplacer celui-ci à l'aide des informations fournies à la méthode onActionButtonExecution.

Propriétés d'extraction

Toutes les propriétés qui extraient une valeur sont appelées avec le format suivant :

get("property_Name").

Par exemple : get("sandboxes");

bacs à sable

Extrait tous les bacs à sable disponibles.

Renvoie dojo.promise.Promise en tant que promesse résolue lors de l'extraction des bacs à sable. Lorsque la promesse est résolue, un tableau d'objets représentant les bacs à sable disponibles est transmis aux rappels enregistrés avec la promesse.

Chaque objet doit avoir le format suivant :

name: (chaîne) - Nom du bac à sable.
active: (Booléen)- True si ce bac à sable est le bac à sable actif de l'objet, sinon false.
baseSandbox: (Booléen)- True si ce bac à sable est le bac à sable de base, sinon false.
defaultSandbox: (Booléen)- True si ce bac à sable est le bac à sable par défaut, sinon false.

Propriétés de définition

Toutes les propriétés qui définissent une valeur sont appelées avec le format suivant :

set("property_Name", value)

Par exemple : set("activeSandbox", "theSandbox");

activeSandbox: Définit le bac à sable indiqué comme actif.; Paramètre : (chaîne) bac à sable. Nom du bac à sable à définir comme actif.; Renvoie : dojo.promise.Promise en tant que promesse résolue lors de la définition du bac à sable actif.

subset

Définit un objet de sous-ensemble.

Paramètre : (objet) subset Objet qui représente l'objet de sous-ensemble de dimension à définir. L'objet utilise le format suivant :

sheetIndex: Type : Entier; Indice, en indexation 0, de la feuille contenant la cellule SUBNM dont vous voulez modifier le sous-ensemble de dimension.
rowIndex: Type : Entier; Indice, en indexation 0, de la ligne contenant la cellule SUBNM dont vous voulez modifier le sous-ensemble de dimension.
columnIndex: Type : Entier; Indice, en indexation 0, de la colonne contenant la cellule SUBNM dont vous voulez modifier le sous-ensemble de dimension.
dimension: Type : Chaîne; Nom de la dimension. Ne doit pas être utilisé conjointement avec sheetIndex, rowIndex et columnIndex.
setExpression: Type : Chaîne; Expression MDX utilisée pour définir le sous-ensemble. Ne doit pas être utilisée conjointement avec subset. Cela signifie qu'une propriété setExpression ou un nom de sous-ensemble est fourni en entrée.
subset: Type : Chaîne; Nom de sous-ensemble du sous-ensemble de dimension à définir. Ne doit pas être utilisé conjointement avec setExpression.
alias: Type : Chaîne; Alias du sous-ensemble de dimension à définir.
élément: Type : Chaîne; Nom de l'élément. Ne doit pas être utilisé avec elementIndex.
elementIndex: Type : Entier; Indice, en indexation 1, de l'élément de dimension à définir. Ne doit pas être utilisé avec element.

Renvoie dojo.promise.Promise en tant que promesse résolue lors de la définition des objets de sous-ensemble. Un objet correspondant au format du sous-ensemble transmis dans cette méthode est transmis à tous les appels enregistrés avec la promesse. Si le sous-ensemble n'a pas été modifié, la valeur null est transmise.

sous-ensembles

Définit plusieurs objets de sous-ensemble.

Paramètre : (objet[]) sous-ensembles Tableau des objets de sous-ensemble à définir. Chaque objet doit avoir le format suivant :

sheetIndex: Type : Entier; Indice, en indexation 0, de la feuille contenant la cellule SUBNM dont vous voulez modifier le sous-ensemble de dimension.
rowIndex: Type : Entier; Indice, en indexation 0, de la ligne contenant la cellule SUBNM dont vous voulez modifier le sous-ensemble de dimension.
columnIndex: Type : Entier; Indice, en indexation 0, de la colonne contenant la cellule SUBNM dont vous voulez modifier le sous-ensemble de dimension.
dimension: Type : Chaîne; Nom de la dimension. Ne doit pas être utilisé conjointement avec sheetIndex, rowIndex et columnIndex.
setExpression: Type : Chaîne; Expression MDX utilisée pour définir le sous-ensemble. Ne doit pas être utilisée conjointement avec subset. Cela signifie qu'une propriété setExpression ou un sous-ensemble est fourni en entrée.
subset: Type : Chaîne; Nom de sous-ensemble du sous-ensemble de dimension à définir. Ne doit pas être utilisé conjointement avec setExpression.
alias: Type : Chaîne; Alias du sous-ensemble de dimension à définir.
élément: Type : Chaîne; Nom de l'élément. Ne doit pas être utilisé avec elementIndex.
elementIndex: Type : Entier; Indice, en indexation 1, de l'élément de dimension à définir. Ne doit pas être utilisé avec element.

Renvoie dojo.promise.Promise en tant que promesse résolue lors de la définition des objets de sous-ensemble. Un tableau d'objets correspondant au format des objets de sous-ensemble transmis dans cette méthode est transmis à tous les appels enregistrés avec la promesse pour les sous-ensembles dont la définition a abouti.

titleDimensionElement

Définit un élément de la dimension en titre.

Paramètre : (objet) élément Objet qui représente les éléments de dimension en titre à définir. L'objet utilise le format suivant :

sheetIndex: Type : Entier; Indice, en indexation 0, de la feuille contenant la cellule SUBNM dont vous voulez modifier l'élément de dimension.
rowIndex: Type : Entier; Indice, en indexation 0, de la ligne contenant la cellule SUBNM dont vous voulez modifier l'élément de dimension.
columnIndex: Type : Entier; Indice, en indexation 0, de la colonne contenant la cellule SUBNM dont vous voulez modifier l'élément de dimension.
élément: Type : Chaîne; Nom de l'élément. Ne doit pas être utilisé avec elementIndex.
elementIndex: Type : Entier; Indice, en indexation 1, de l'élément de dimension à définir. Ne doit pas être utilisé avec element.

Renvoie dojo.promise.Promise en tant que promesse résolue lors de la définition de l'élément de dimension en titre. Un objet correspondant au format de l'élément transmis dans cette méthode est transmis à tous les appels enregistrés avec la promesse. Si l'élément n'a pas été modifié, la valeur null est transmise.

titleDimensionElements

Définit plusieurs éléments de la dimension en titre.

Paramètre : (Object[]) éléments Tableau des éléments de dimension en titre à définir. Chaque objet doit avoir le format suivant :

sheetIndex: Type : Entier; Indice, en indexation 0, de la feuille contenant la cellule SUBNM de l'élément de dimension à modifier. Facultatif lorsqu'il est utilisé avec dimension, mais obligatoire pour rowIndex et columnIndex.
rowIndex: Type : Entier; Indice, en indexation 0, de la ligne contenant la cellule SUBNM de l'élément de dimension à modifier. N'utilisez pas ce paramètre avec le paramètre dimension.
columnIndex: Type : Entier; Indice, en indexation 0, de la colonne contenant la cellule SUBNM de l'élément de dimension à modifier. N'utilisez pas ce paramètre avec le paramètre dimension.
dimension: Type : Chaîne; Nom de la dimension. N'utilisez pas ce paramètre avec rowIndex ou columnIndex.
élément: Type : Chaîne; Nom de l'élément. Ne doit pas être utilisé avec elementIndex.
elementIndex: Type : Entier; Indice, en indexation 1, de l'élément de dimension à définir. Ne doit pas être utilisé avec element.

Renvoie dojo.promise.Promise en tant que promesse résolue lors de la définition des éléments de dimension en titre. Un tableau d'objets correspondant au format des objets d'éléments transmis dans cette méthode est transmis à tous les appels enregistrés avec la promesse pour les éléments dont la définition a abouti.