DeepSeeUtils

Provides additional methods for working with DeepSee.

Where This Object Is Available

This object is available in client-side JavaScript code, if that code includes DeepSee.js. See “Introduction to DeepSee.js.”

Creating This Object

When you include DeepSee.js in your client code, the DeepSeeUtils object is automatically available.

Methods of This Object

The DeepSeeUtils object provides the following methods:

getCubeList()

getCubeList(connection,finalFunc)

Where:

connection — Is a DeepSee data connector object.
finalFunc — Specifies the name of the function to execute when results are available

This method retrieves information about the available cubes. It calls the POST /Info/Cubes REST call, which is described in the next reference in this book. The response object from that call is available to the function specified by finalFunc.

getCubeListings()

getCubeListings(connection,finalFunc)

Where:

connection — Is a DeepSee data connector object.
cubename — Specifies the logical name of a DeepSee cube.
finalFunc — Specifies the name of the function to execute when results are available

This method retrieves information about the listings available to the given cube. It calls the POST /Info/Listings/:cube REST call, which is described in the next reference in this book. The response object from that call is available to the function specified by finalFunc.

getDashboardList()

getDashboardList(connection,finalFunc)

This method retrieves information about the available dashboards. It calls the POST /Info/Dashboards REST call, which is described in the next reference in this book. The response object from that call is available to the function specified by finalFunc.

getErrorMessage()

getErrorMessage(data)

Where data is a response object returned by any of the DeepSee REST services, which are described in the next reference in this book.

This method returns the text of the error message contained in that object, if any.

getFiltersForDataSource()

getFiltersForDataSource(connection,cubename,finalcallback)

Where:

connection — Is a DeepSee data connector object.
cubename — Specifies the logical name of a DeepSee cube.
finalcallback — Specifies the name of the function to execute when results are available

This method retrieves information about the available filters for the given cube. It calls the POST /Info/Filters/:datasource REST call, which is described in the next reference in this book. The response object from that call is available to the function specified by finalFunc.

getMembersForFilter()

getMembersForFilter(connection,cubeName,filterSpec,finalCallback)

Where:

connection — Is a DeepSee data connector object.
cubename — Specifies the logical name of a DeepSee cube.
filterSpec — Specifies the filter whose members you want to retrieve.
finalcallback — Specifies the name of the function to execute when results are available

This method retrieves information about members of the given filter. It calls the POST /Info/FilterMembers/:datasource/:filterSpec REST call, which is described in the next reference in this book. The response object from that call is available to the function specified by finalFunc.

getPivotList()

getPivotList(connection,finalFunc)

Where:

connection — Is a DeepSee data connector object.
finalFunc — Specifies the name of the function to execute when results are available

This method retrieves information about the available pivot tables. It calls the POST /Info/Pivots REST call, which is described in the next reference in this book. The response object from that call is available to the function specified by finalFunc.

getResultsAsArray()

getResultsAsArray(data)

Where data is a response object returned by any of the DeepSee REST services, which are described in the next reference in this book.

This method returns an array of results from that object as follows:

If the response object contains an Result.Filters array, the method returns that array.
Otherwise, if the response object contains an Result.FilterMembers array, the method returns that array.
Otherwise, if the response object contains an Result.Listings array, the method returns that array.

Otherwise the method returns nothing.

isError()

isError(data)

Where data is a response object returned by any of the DeepSee REST services, which are described in the next reference in this book.

This method returns true if the response object indicates that an error occurred. Returns false otherwise.