Class

SpotfirePage

SpotfirePage(pageDescription)

Constructor

new SpotfirePage(pageDescription)

Represents a page to be added to the current TIBCO Spotfire® document.

Parameters:
Name Type Description
pageDescription String | PageDescription

The title or page description.

title String

The title of the page.

[ tileMode = Vertically ] String

The tile mode that defines the layout of the page (Vertically|Horizontally).

[ showWebPanel = true ] Boolean

Specifies whether or not the Web Panel should be visible or not.

Methods

addVisual(visualTypeName, visualDescription)

Adds a visualization on the current page.

Parameters:
Name Type Description
visualTypeName string

The type name of the visualization to be added.

visualDescription Object

The visualization properties needed for the constructor.

getVisual(visualTypeName, visualDescription)

Gets the existing visualization with the same type and title.

Parameters:
Name Type Description
visualTypeName string

the type name of the visual to be added

visualDescription Object

all the visual properties. May have general.title to identified the already added views

raiseDataVisualizationCreated(dataVisualizationCreated)

Notify subscribers that a new data visualization has been created on this page.

Parameters:
Name Type Description
dataVisualizationCreated SpotfireVisualization

The new data visualization created.

subscribeToAddVisualisation(subscriber)

Adds a subscriber to be notified when a new visualization is created.

Parameters:
Name Type Description
subscriber AddVisualizationCallback

The callback to be raised when a new data visualization is created.

sender SpotfirePage

The page on which the new visualization was created.

dataVisualizationCreated SpotfireVisualization

The new visualization created.