Propiedades de CubeViewer

La clase CubeViewer tiene las propiedades siguientes.

Al crear una instancia de un objeto CubeViewer o Workbook, las propiedades siguientes son comunes entre los dos tipos de objetos:

sessionToken: Tipo: Serie; Especifica la sesión de TM1® Web que se utilizará para este objeto. No utilice esta propiedad con las propiedades para adminHost, tm1Server, username, password y camPassport. Si esta propiedad no está especificada, y no se proporciona ninguna credencial adicional, se muestra al usuario un diálogo de inicio de sesión durante el arranque.

objectId: Tipo: Serie; El ID del CubeViewer. Un número exclusivo que puede utilizar para hacer referencia al CubeViewer específico.

adminHost: Tipo: Serie; Valor predeterminado: localhost; El host de administración para utilizar cuando se carga el objeto. No utilice esta propiedad con la propiedad sessionToken.

tm1Server: Tipo: Serie; El servidor de TM1 que se utilizará cuando se cargue el objeto. No utilice esta propiedad con la propiedad sessionToken. Si esta propiedad no está especificada y no se proporciona ningún sessionToken, se muestra al usuario un diálogo de inicio de sesión durante el arranque.

nombre de usuario: Tipo: Serie; El nombre de usuario para utilizar cuando se carga el objeto. No utilice esta propiedad con las propiedades sessionToken o camPassport. Si esta propiedad no está especificada y no se proporciona sessionToken ni camPassport, se muestra al usuario un diálogo de inicio de sesión durante el arranque.

contraseña: Tipo: Serie; La contraseña para utilizar cuando se carga el objeto. Si esta propiedad no está especificada y no se proporciona ningún sessionToken, se muestra al usuario un diálogo de inicio de sesión durante el arranque.

camPassport: Tipo: Serie; El pasaporte de autenticación de Cognos® Analytics (pasaporte CAM) que se debe utilizar al cargar un objeto. No utilice esta propiedad con username ni sessionToken.

domNode: Tipo: HTMLElement; El elemento HTML subyacente que representa el widget. Esta propiedad se define automáticamente durante la construcción del objeto y no se debe proporcionar durante la instanciación.; Para obtener más información, consulte Documentación de Dojo para dijit._WidgetBase (https://dojotoolkit.org/reference-guide/1.10/dijit/_WidgetBase.html).

Las propiedades siguientes se utilizan al crear una instancia solo de un objeto CubeViewer.

vista: Tipo: Serie; El nombre de la vista de cubo para cargar.

cubo: Tipo: Serie; El nombre del cubo que contiene la vista que desea cargar.

isPublic: Tipo: Booleano; Valor predeterminado: true; El tipo de acceso de la vista de cubo que se va a cargar.; Un valor de true indica que desea cargar una vista de cubo pública.; Un valor de false indica que desea cargar una vista de cubo privada.

Obtener propiedades

Todas las propiedades que obtienen un valor se invocan con el formato siguiente:

get("property_Name").

Por ejemplo: get("sandboxes");

recintos de pruebas

Recupera todos los recintos de pruebas disponibles.

Devuelve dojo.promise.Promise como una promesa que se ha resuelto cuando se recuperan los recintos de pruebas. Cuando la promesa se resuelve, se pasa una matriz de objetos que representan los recintos de pruebas disponibles a cualquier devolución de llamada registrada con la promesa.

Cada objeto utiliza el formato siguiente:

name: (Serie) - El nombre del recinto de pruebas.
active: (Booleano) - True si este recinto de pruebas es el recinto de pruebas activo para el objeto, de lo contrario es false.
baseSandbox: (Booleano) - True si este recinto de pruebas es el recinto de pruebas base, de lo contrario es false.
defaultSandbox: (Booleano) - True si este recinto de pruebas es el recinto de pruebas predeterminado, de lo contrario es false.

Establecer propiedades

Todas las propiedades que establecen un valor se invocan con el formato siguiente:

set("property_Name", value)

Por ejemplo: set("activeSandbox", "theSandbox");

activeSandbox: Establece el recinto de pruebas especificado como activo.; Parámetro: (Serie) sandbox. El nombre del recinto de pruebas para establecer como activo.; Devuelve: dojo.promise.Promise como una promesa que se resuelve cuando se establece el recinto de pruebas activo.

automaticRecalculation

Establece el recálculo automático para activar o desactivar.

Parámetros: Booleano.

True activa el recálculo automático.
False desactiva el recálculo automático.

Devuelve: dojo.promise.Promise. Una promesa que se resuelve cuando el recálculo automático está habilitado o inhabilitado.

chartType: Establece el tipo de gráfico del objeto CubeViewer.; Parámetros: tm1web.cubeview.ChartType. El tipo de gráfico para establecer.; Devuelve: dojo.promise.Promise. Una promesa que se resuelve cuando se establece el tipo de gráfico.

dimensionBarVisible

Establece la visibilidad de la barra de dimensiones.

Parámetros: Booleano.

True activa la visualización de la barra de dimensiones.
False desactiva la visualización de la barra de dimensiones.

displayMode: Establece la modalidad de visualización del objeto CubeViewer.; Parámetros: tm1web.cubeview.DisplayMode. La modalidad de visualización para establecer.; Devuelve: dojo.promise.Promise. Una promesa que se resuelve cuando se establece la modalidad de visualización.

subconjunto

Establece un objeto de subconjunto.

Parámetro: (Objeto) subset Un objeto que representa el objeto de subconjunto de dimensiones para establecer. El objeto utiliza el formato siguiente:

dimensión: Tipo: Serie; El nombre de la dimensión.
setExpression: Tipo: Serie; La expresión MDX utilizada para definir el subconjunto. No se va a utilizar junto con el subconjunto. Es decir, se proporciona una setExpression o un nombre de subconjunto de la entrada.
subconjunto: Tipo: Serie; El nombre de subconjunto de dimensiones para establecer. No se debe utilizar junto con setExpression.
alias: Tipo: Serie; El alias del subconjunto de dimensiones para establecer.
elemento: Tipo: Serie; El nombre del elemento. No se debe utilizar con elementIndex.
elementIndex: Tipo: Entero; El índice basado en uno del elemento de dimensión para establecer. No se debe utilizar con el elemento.

Devuelve dojo.promise.Promise como una promesa que se resuelve cuando se establecen los objetos de subconjunto. Las devoluciones de llamada que se han registrado con la promesa se pasan a un objeto que coincide con el formato del subconjunto que se pasa en este método. Se pasa un valor de nulo, si el subconjunto no se ha modificado.

subconjuntos

Define varios objetos de subconjunto.

Parámetro: (Object[]) subsets Una matriz de objetos de subconjunto para establecer. Cada objeto utiliza el formato siguiente:

dimensión: Tipo: Serie; El nombre de la dimensión.
setExpression: Tipo: Serie; La expresión MDX utilizada para definir el subconjunto. No se va a utilizar junto con el subconjunto. Es decir, se proporciona una setExpression o un subconjunto de la entrada.
subconjunto: Tipo: Serie; El nombre de subconjunto de dimensiones para establecer. No se debe utilizar junto con setExpression.
alias: Tipo: Serie; El alias del subconjunto de dimensiones para establecer.
elemento: Tipo: Serie; El nombre del elemento. No se debe utilizar con elementIndex.
elementIndex: Tipo: Entero; El índice basado en uno del elemento de dimensión para establecer. No se debe utilizar con el elemento.

Devuelve dojo.promise.Promise como una promesa que se resuelve cuando se establecen los objetos de subconjunto. Las devoluciones de llamada que se han registrado con la promesa se pasan a una matriz de objetos que coinciden con el formato de los objetos de subconjunto que se pasan en este método para los subconjuntos que se han establecido correctamente.

titleDimensionElement

Establece un elemento de dimensión de título.

Parámetro: objeto de elemento. El elemento de dimensión de título para establecer. Este objeto utiliza el formato siguiente:

dimensión: Serie; El nombre de la dimensión.
elemento: Serie; El nombre del elemento. No utilice este parámetro con elementIndex.
elementIndex: Entero; El índice basado en uno del elemento de dimensión para establecer. No utilice este parámetro con el parámetro element.

Devuelve: dojo.promise.Promise. Una promesa que se resuelve cuando se establece el elemento de dimensión de título. Las devoluciones de llamada que están registradas con la promesa se pasan a un objeto que coincide con el formato del elemento que se ha pasado en este método. Se pasa un valor de nulo si el elemento no se ha cambiado.

titleDimensionElements

Establece varios elementos de dimensión de título.

Parámetro: elementos object[]. Una matriz de elementos de dimensión de título para establecer. Cada objeto utiliza el formato siguiente:

dimensión: Serie; El nombre de la dimensión.
elemento: Serie; El nombre del elemento. No utilice este parámetro con elementIndex.
elementIndex: Entero; El índice basado en uno del elemento de dimensión para establecer. No utilice este parámetro con el parámetro element.

Devuelve dojo.promise.Promise. Una promesa que se resuelve cuando se establecen elementos de dimensión de título. Las devoluciones de llamada que están registradas con la promesa se pasan a una matriz de objetos que coinciden con el formato de los objetos de elemento que se han pasado en este método. La matriz pasada vuelve a informar sobre los elementos que se han establecido correctamente.