Table of Contents

Vizpad-related actionTypes

Ramya Priya Updated by Ramya Priya

A partial list of actionTypes supported

The actionType field can be used with any of the given values to get results for different types of tasks. Here is a partial collection of actionTypes supported (with samples).

actionType values

Description

Sample code

getAllFiltersApplied

Provides the list of all filters

telliusFrame.postMessage({
    actionType: "getAllFiltersApplied"
}, "*");

getVizpadFiltersApplied

Provides the list of all filters applied to a Vizpad

telliusFrame.postMessage({
    actionType: "getVizpadFiltersApplied"
}, "*");

getVizFiltersApplied

Provides the list of all filters applied to a Viz

telliusFrame.postMessage({
    actionType: "getVizFiltersApplied"
}, "*");

getBusinessViewColumns

Provides the list of columns in a Business View

telliusFrame.postMessage({
    actionType: "getBusinessViewColumns"
}, "*");

getResolutionApplied

Provides the resolution applied to a Vizpad

telliusFrame.postMessage({
    actionType: "getResolutionApplied"
}, "*");

Getting the list of columns in a Business View

For example, if the embedding app sends a postMessage with the actionType set as getBusinessViewColumns, Tellius sends back the following information:

{
    columns: ["list_of_columns"],
    columnNames: ["list_of_columnNames"],
    actionType: "BVCOLUMNS",
}

Applying resolution

Resolutions can be applied to both the Viz and Vizpad.

To a Viz
telliusFrame.postMessage({
    actionType: "resolution",
    vizId: "ID_of_Viz",
    resolution: "monthly",
}, "*");
To a Vizpad
telliusFrame.postMessage({
    actionType: "resolution",
    resolution: "monthly",
}, "*");

Did we help you?

Apply and delete filters

Edit, save, and share a Vizpad

Contact