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 ]
|
String | The tile mode that defines the layout of the page. |
[ panels ]
|
Object | Specifies whether the panels should be visible using key< |
[ customLayout ]
|
String | Script to apply a custom layout instead of tile mode. In the script, the layout is in the object "layout", and the list of visualizations for the page in the object "visuals". The method getVisual can be used to retrieve a visualization by its name and type. See TIBCO Spotfire API - VisualTypeIdentifiers for the list of available types and TIBCO Spotfire API - LayoutDefinition for layout examples. |
[ showWebPanel ]
|
Boolean | Obsolete. Specifies whether the Web Panel should be visible. |
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 identify 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. |