CubeViewer methods

The CubeViewer class has the following methods.

startup

Begins the startup sequence for this object. Call this function after the object is added to the document. The onLoad method is run after the startup sequence completes.

Applies to both CubeViewer and Workbook objects.

Syntax: startup()

Example:

document.body.appendChild(loadedCubeViewer.domNode);
loadedCubeViewer.startup();

See the Dojo documentation for dijit._WidgetBase#startup.

commitActiveSandbox

Commits changed data in the active sandbox to the base sandbox.

Returns dojo.promise.Promise. A promise that is resolved when the sandbox commit attempt is completed. Any callbacks that are registered with the promise are passed a boolean with a value of true if the sandbox commit was successful. A value of false is passed if the commit was unsuccessful.

copy

Copies the selected cells to the clipboard if a selection exists.

destroy

Destroys this object and prepares it for garbage collection.

See Dojo documentation for dijit._WidgetBase#destroy.

logout

Destroys the TM1® Web session that is associated with this object's sessionToken.

Returns dojo.promise.Promise as a promise that is resolved when the logout completes.

onLoad

Runs when the object is finished loading.

onTitleDimensionElementChange

Executed when a title dimension element is changed. Can be overridden during object construction or attached to by using the dojo/aspect module.

Syntax: onTitleDimensionElementChange: function(elementInfo){}

Parameter: elementInfo object. This object uses the following format:

dimension

String

The name of the dimension that was changed.

element

String

The name of the element that was changed.

elementIndex

Integer

The one-based index of the dimension element that was changed.

paste

Pastes the contents of the clipboard into the current selected area if a selection exists.

redo

Performs a redo action.

Returns dojo.promise.Promise) as a promise that is resolved when the redo action completes.

reset

Resets the cube view to its original saved state.

Returns: dojo.promise.Promise. A promise that is resolved when the cube view is reset.

save

Saves the layout of cube view and overwrites the existing layout.

Returns: dojo.promise.Promise. A promise that is resolved when the cube view is saved.

undo

Performs an undo action.

Returns dojo.promise.Promise as a promise that is resolved when the undo action completes.