La classe CubeViewer ha le seguenti proprietà.
Quando si crea un'istanza di un oggetto CubeViewer o Foglio di lavoro, le seguenti proprietà sono comuni ai due tipi di oggetto:
- sessionToken
- Tipo:stringa
- Specifica la sessione TM1® Web da utilizzare per questo oggetto. Non utilizzare questa proprietà con le proprietà per
adminHost, tm1Server, username, password e camPassport. Se questa proprietà non viene specificata, e non vengono fornite ulteriori credenziali, durante l'avvio viene visualizzata una finestra di dialogo di accesso.
- objectId
- Tipo:stringa
- L'ID del CubeViewer. Un numero univoco che è possibile utilizzare per fare riferimento al CubeViewer specifico.
- adminHost
- Tipo:stringa
- Valore predefinito:
localhost
- L'host admin da utilizzare quando viene caricato l'oggetto. Non utilizzare questa proprietà con la proprietà
sessionToken.
- tm1Server
- Tipo:stringa
- Il server TM1 da utilizzare quando l'oggetto viene caricato. Non utilizzare questa proprietà con la proprietà
sessionToken. Se questa proprietà non viene specificata e non viene fornito alcun sessionToken, durante l'avvio viene visualizzata una finestra di dialogo di accesso.
- nome utente
- Tipo:stringa
- Il nome user da utilizzare quando viene caricato l'oggetto. Non utilizzare questa proprietà con la proprietà
sessionToken o camPassport. Se questa proprietà non viene specificata e non viene fornito alcun sessionToken o camPassport, durante l'avvio viene visualizzata una finestra di dialogo di accesso.
- Password
- Tipo:stringa
- La password da utilizzare quando viene caricato l'oggetto. Se questa proprietà non viene specificata e non viene fornito alcun
sessionToken, durante l'avvio viene visualizzata una finestra di dialogo di accesso.
- camPassport
- Tipo:stringa
- Il passaporto di autenticazione Cognos®
Analytics (passaporto CAM) da utilizzare quando si carica un oggetto. Non utilizzare questa proprietà con
username o sessionToken.
- domNode
- Tipo: elemento HTML
- L'elemento HTML sottostante che rappresenta il widget. Questa proprietà viene definita automaticamente durante la creazione dell'oggetto
e non dovrebbe essere fornita durante la creazione dell'istanza.
- Per ulteriori informazioni, consultare la documentazione Dojo per dijit._WidgetBase (https://dojotoolkit.org/reference-guide/1.10/dijit/_WidgetBase.html).
Quando si crea solo l'istanza di un oggetto CubeViewer vengono utilizzate le seguenti proprietà:
- vista
- Tipo:stringa
- Il nome della vista cubo da caricare.
- cubo
- Tipo:stringa
- Il nome del cubo che contiene la vista che si desidera caricare.
- isPublic
- Tipo: boolean
- Valore predefinito:
true
- Il tipo di accesso della vista cubo da caricare.
- Il valore
true indica che si desidera caricare una vista cubo pubblica.
- Il valore
false indica che si desidera caricare una vista cubo privata.
Richiamo proprietà
Tutte le proprietà che assumono un valore vengono richiamate con il seguente formato:
get("property_Name").
Ad esempio: get("sandboxes");
- sandboxes
- Richiama tutte le sandbox disponibili.
- Restituisce
dojo.promise.Promise come una promessa che viene risolta una volta che le sandbox sono state richiamate. Quando la promessa viene risolta, un array di oggetti che rappresentano le sandbox disponibili viene passato alla callback registrata con la promessa.
- Ogni oggetto utilizza il seguente formato:
name: (Stringa) - Il nome della sandbox.active: (Booleano) - True se questa sandbox è quella attiva per l'oggetto, altrimenti false.baseSandbox: (Booleano) - True se questa sandbox è quella di base, altrimenti false.defaultSandbox: (Booleano) - True se questa sandbox è quella predefinita, altrimenti false.
Proprietà di impostazione
Tutte le proprietà che impostano un valore
vengono richiamate con il seguente formato:
set("property_Name", value)
Ad esempio: set("activeSandbox", "theSandbox");
- activeSandbox
- Imposta la sandbox specificata come attiva.
- Parametro: (String) sandbox. Il nome della
sandbox da impostare come attiva.
- Restituisce:
dojo.promise.Promise come una promessa che viene risolta quando viene impostata la sandbox attiva.
- automaticRecalculation
- Attiva o disattiva il ricalcolo automatico.
- Parametri: Booleani.
True attiva il ricalcolo automatico.False disattiva il ricalcolo automatico.
- Restituisce:
dojo.promise.Promise. Una promessa che viene risolta quando il ricalcolo automatico viene abilitato o disabilitato.
- chartType
- Imposta il tipo di grafico dell'oggetto CubeViewer.
- Parametri:
tm1web.cubeview.ChartType. Il tipo di grafico da impostare.
- Restituisce:
dojo.promise.Promise. Una promessa che viene risolta quando viene impostato il tipo di grafico.
- dimensionBarVisible
- Imposta la visualizzazione della barra delle dimensioni.
- Parametri: Booleani.
True attiva la visualizzazione della barra delle dimensioni.False disattiva la visualizzazione della barra delle dimensioni.
- displayMode
- Imposta la modalità di visualizzazione dell'oggetto CubeViewer.
- Parametri:
tm1web.cubeview.DisplayMode. La modalità di visualizzazione da impostare.
- Restituisce:
dojo.promise.Promise. Una promessa che viene risolta quando viene impostata la modalità di visualizzazione.
- subset
- Imposta un oggetto del sottoinsieme
- Parametro: (Object) subset Un oggetto che rappresenta l'oggetto sottoinsieme dimensione da impostare. L'oggetto utilizza il seguente formato:
- dimensione
- Tipo:stringa
- Il nome dimensione.
- setExpression
- Tipo:stringa
- L'espressione MDX utilizzata per definire il sottoinsieme. Da non utilizzare con subset. Ossia,
deve essere fornito dall'input un nome setExpression o un nome del sottoinsieme.
- subset
- Tipo:stringa
- Il nome del sottoinsieme della dimensione da impostare. Da non utilizzare con setExpression.
- alias
- Tipo:stringa
- L'alias del sottoinsieme della dimensione da impostare.
- element
- Tipo:stringa
- Il nome dell'elemento. Non deve essere utilizzato con elementIndex.
- elementIndex
- Tipo: interro
- L'indice con base uno sull'elemento dimensione da impostare. Non deve essere utilizzato con elemento.
- Restituisce:
dojo.promise.Promise come promessa risolta quando vengono impostati gli oggetti sottoinsieme. Le callback registrate con la promessa vengono passate come un oggetto che corrisponde al formato del sottoinsieme a sua volta passato in questo metodo. Viene passato un valore null se il sottoinsieme non viene modificato.
- subsets
- Imposta più oggetti del sottoinsieme.
- Parametro: (Object[]) subsets Un array di oggetti sottoinsieme da impostare. Ogni oggetto utilizza il seguente formato:
- dimensione
- Tipo:stringa
- Il nome dimensione.
- setExpression
- Tipo:stringa
- L'espressione MDX utilizzata per definire il sottoinsieme. Da non utilizzare con subset. Ovvero, dall'input viene fornito un setExpression o un sottoinsieme.
- subset
- Tipo:stringa
- Il nome del sottoinsieme della dimensione da impostare. Da non utilizzare con setExpression.
- alias
- Tipo:stringa
- L'alias del sottoinsieme della dimensione da impostare.
- element
- Tipo:stringa
- Il nome dell'elemento. Non deve essere utilizzato con elementIndex.
- elementIndex
- Tipo: interro
- L'indice con base uno sull'elemento dimensione da impostare. Non deve essere utilizzato con elemento.
- Restituisce:
dojo.promise.Promise come promessa risolta quando vengono impostati gli oggetti sottoinsieme. Le callback registrate con la promessa vengono passate come un array di oggetti che corrispondono al formato degli oggetti sottoinsieme a loro volta
passati in questo metodo per i sottoinsiemi che sono stati impostati correttamente.
- titleDimensionElement
- Imposta un elemento dimensione titolo.
- Parametro: oggetto elemento. L'elemento della dimensione titolo da impostare. Quest'oggetto utilizza il seguente formato:
- dimensione
- Stringa
- Il nome della dimensione.
- element
- Stringa
- Il nome dell'elemento. Non utilizzare questo parametro con
elementIndex.
- elementIndex
- Numero intero
- L'indice con base uno sull'elemento dimensione da impostare. Non utilizzare questo parametro con il parametro
element.
- Restituisce:
dojo.promise.Promise. Una promessa che viene risolta quando viene impostato l'elemento della dimensione titolo. A qualsiasi callback registrata con la promessa viene trasmesso un oggetto che corrisponde al formato dell'elemento trasmesso in questo metodo. Se l'elemento non è stato modificato, viene passato un valore null.
- titleDimensionElements
- Imposta più elementi dimensione titolo
- Parametro: object[] elementi. Un array di elementi della dimensione titolo da impostare. Ogni oggetto utilizza il seguente formato:
- dimensione
- Stringa
- Il nome della dimensione.
- element
- Stringa
- Il nome dell'elemento. Non utilizzare questo parametro con
elementIndex.
- elementIndex
- Numero intero
- L'indice con base uno sull'elemento dimensione da impostare. Non utilizzare questo parametro con il parametro
element.
- Restituisce:
dojo.promise.Promise. Una promessa che viene risolta quando vengono impostati gli elementi della dimensione titolo. A qualsiasi callback registrata con la promessa viene trasmesso un array di oggetti che corrisponde al formato degli oggetti dell'elemento trasmessi in questo metodo. L'array trasmesso riporta informazioni sugli elementi correttamente impostati.