Interface: VisualizationAPI

VisualizationAPI

API class that is used to control visualizations.

Example

content.getFeature('Visualization')

Methods

getLocalFilters() → {FiltersAPI}

Gets the local filters.

Returns:
Type
FiltersAPI

getSlots() → {SlotsAPI}

Returns the slots interface, which can be used to get and set information about the slots and data mappings in the visualization.

Returns:

Slots object

Type
SlotsAPI

getType() → {String}

Returns the visulization type that is being used.

Returns:

Type (e.g. Bar, Area, etc)

Type
String
Example
// will return the string 'Bar'
visualization.getType()

hasUnavailableMetadataColumns() → {Boolean}

Returns true if hasUnavailableMetadataColumns references a column that is no longer available.

Returns:
Type
Boolean

setType(type, options)

Sets the visualization type, where 'auto' will set the visualization to the recommended type.

Parameters:
Name Type Description
type String

For example: auto, Bar, Area, etc.

options SetOptions
To Do:
  • - define the type enum (can be found in SmartsToVizMapping.js)