Propiedades de Workbook

Esta clase Workbook tiene las propiedades siguientes.

Al crear una instancia de CubeViewer o Workbook, las propiedades siguientes son comunes entre los dos 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 Workbook. Un identificador exclusivo que puede utilizar para hacer referencia al Workbook específico.

El objectId se debe incluir con un sessionToken para identificar la sesión de TM1 Web.

Por ejemplo:

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

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 cuando se crea una instancia solo de un objeto Workbook.

vía de acceso: Tipo: Serie; La ruta en el árbol de carpetas de la aplicación del servidor TM1 para el libro de trabajo que se va a cargar.; Por ejemplo: "Applications/Planning Sample/Bottom Up Input/Budget Input"

replaceOnNavigate: Tipo: booleano (valor predeterminado true); Si true, durante la navegación del botón de acción a un nuevo libro de trabajo, este widget se sustituirá con el nuevo libro de trabajo y se cerrará el libro de trabajo existente.; Si false, es responsabilidad del cliente crear un nuevo libro de trabajo o de sustituirlo utilizando la información proporcionada al método onActionButtonExecution.

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 false.
baseSandbox: (Booleano) - True si este recinto de pruebas es el recinto de pruebas base, de lo contrario false.
defaultSandbox: (Booleano) - True si este recinto de pruebas es el recinto de pruebas predeterminado, de lo contrario 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.

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:

sheetIndex: Tipo: Entero; El índice basado en cero de la hoja que contiene la celda SUBNM cuyo subconjunto de dimensiones desea cambiar.
rowIndex: Tipo: Entero; El índice basado en cero de la fila que contiene la celda SUBNM cuyo subconjunto de dimensiones desea cambiar.
columnIndex: Tipo: Entero; El índice basado en cero de la columna que contiene la celda SUBNM cuyo subconjunto de dimensiones desea cambiar.
dimensión: Tipo: Serie; El nombre de la dimensión. No se debe utilizar junto con sheetIndex, rowIndex y columnIndex.
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:

sheetIndex: Tipo: Entero; El índice basado en cero de la hoja que contiene la celda SUBNM cuyo subconjunto de dimensiones desea cambiar.
rowIndex: Tipo: Entero; El índice basado en cero de la fila que contiene la celda SUBNM cuyo subconjunto de dimensiones desea cambiar.
columnIndex: Tipo: Entero; El índice basado en cero de la columna que contiene la celda SUBNM cuyo subconjunto de dimensiones desea cambiar.
dimensión: Tipo: Serie; El nombre de la dimensión. No se debe utilizar junto con sheetIndex, rowIndex y columnIndex.
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: (Object) element Un objeto que representa los elementos de dimensión de título para establecer. El objeto utiliza el formato siguiente:

sheetIndex: Tipo: Entero; El índice basado en cero de la hoja que contiene la celda SUBNM cuyo elemento de dimensión desea cambiar.
rowIndex: Tipo: Entero; El índice baso en cero de la fila que contiene la celda SUBNM cuyo elemento de dimensión desea cambiar.
columnIndex: Tipo: Entero; El índice basado en cero de la columna que contiene la celda SUBNM cuyo elemento de dimensión desea cambiar.
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 element.

Devuelve dojo.promise.Promise como una promesa que se resuelve cuando se establece el elemento de dimensión de título. Las devoluciones de llamada que se han registrado con la promesa se pasan a un objeto que coincide con el formato del elemento que se pasa 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: (Object[]) elements Una matriz de los elementos de dimensión de título para establecer. Cada objeto utiliza el formato siguiente:

sheetIndex: Tipo: Entero; El índice basado en cero de la hoja que contiene la celda SUBNM para el elemento de dimensión que desea cambiar. Es opcional cuando se utiliza con dimension, pero es necesario para rowIndex y columnIndex.
rowIndex: Tipo: Entero; El índice basado en cero de la fila que contiene la celda SUBNM para el elemento de dimensión que desea cambiar. No utilice este parámetro con el parámetro dimension.
columnIndex: Tipo: Entero; El índice basado en cero de la columna que contiene la celda SUBNM para el elemento de dimensión que desea cambiar. No utilice este parámetro con el parámetro dimension.
dimensión: Tipo: Serie; El nombre de la dimensión. No utilice este parámetro con rowIndex y columnIndex.
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 element.

Devuelve dojo.promise.Promise como una promesa que se resuelve cuando se establecen los elementos de dimensión de título. 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 elemento que se pasan en este método para los elementos que se han establecido correctamente.