TIBCO Spotfire Visualization

Source:

Methods

clearVisuals(pagetitle)

Clears all visuals of a page of the current TIBCO Spotfire document.
Parameters:
Name Type Description
pagetitle string The title of TIBCO Spotfire Page containing visuals to clear. If empty, the Spotfire active Page is used.
Source:

closevisual(id)

Undisplays a TIBCO Spotfire visualization.
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
Source:
Example
closevisual('1');

createbarchart(id, title, datatable, page)

Creates a Bar Chart visualization (but not display it. Use showvisual method to display all created visualizations).
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
title string The Table Plot visualization title. If empty, the Spotfire active Page is used.
datatable string The name of the TIBCO Spotfire Data Table. If empty, the Spotfire active data table is used.
page string The name of Tiboc Spotfire Page.
Source:
Throws:
If the id is null or empty.
Example
createbarchart('1', 'MyBarChart', 'Pipeline Pilot Data 1', 'Discngine Web Panel Start Page');

createboxplot(id, title, datatable, page)

Creates a Box Plot visualization (but not display it. Use showvisual method to display all created visualizations).
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
title string The Table Plot visualization title. If empty, the Spotfire active Page is used.
datatable string The name of the TIBCO Spotfire Data Table. If empty, the Spotfire active data table is used.
page string The name of Tiboc Spotfire Page.
Source:
Throws:
If the id is null or empty.
Example
createboxplot('1', 'MyBoxPlot', 'Pipeline Pilot Data 1', 'Discngine Web Panel Start Page');

createcombinationchart(id, title, datatable, page)

Creates a Combination Chart visualization (but not display it. Use showvisual method to display all created visualizations).
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
title string The Table Plot visualization title. If empty, the Spotfire active Page is used.
datatable string The name of the TIBCO Spotfire Data Table. If empty, the Spotfire active data table is used.
page string The name of Tiboc Spotfire Page.
Source:
Throws:
If the id is null or empty.
Example
createcombinationchart('1', 'MyCombinationChart', 'Pipeline Pilot Data 1', 'Discngine Web Panel Start Page');

createcrosstable(id, title, datatable, page)

Creates a Cross Table visualization (but not display it. Use showvisual method to display all created visualizations).
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
title string The Table Plot visualization title. If empty, the Spotfire active Page is used.
datatable string The name of the TIBCO Spotfire Data Table. If empty, the Spotfire active data table is used.
page string The name of Tiboc Spotfire Page.
Source:
Throws:
If the id is null or empty.
Example
createcrosstable('1', 'MyCrossTable', 'Pipeline Pilot Data 1', 'Discngine Web Panel Start Page');

createheatmap(id, title, datatable, page)

Creates a Heat Map visualization (but not display it. Use showvisual method to display all created visualizations).
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
title string The Table Plot visualization title. If empty, the Spotfire active Page is used.
datatable string The name of the TIBCO Spotfire Data Table. If empty, the Spotfire active data table is used.
page string The name of Tiboc Spotfire Page.
Source:
Throws:
If the id is null or empty.
Example
createheatmap('1', 'MyHeatMap', 'Pipeline Pilot Data 1', 'Discngine Web Panel Start Page');

createlinechart(id, title, datatable, page)

Creates a Line Chart visualization (but not display it. Use showvisual method to display all created visualizations).
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
title string The Table Plot visualization title. If empty, the Spotfire active Page is used.
datatable string The name of the TIBCO Spotfire Data Table. If empty, the Spotfire active data table is used.
page string The name of Tiboc Spotfire Page.
Source:
Throws:
If the id is null or empty.
Example
createlinechart('1', 'MyLineChart', 'Pipeline Pilot Data 1', 'Discngine Web Panel Start Page');

createpiechart(id, title, datatable, page)

Creates a Pie Chart visualization (but not display it. Use showvisual method to display all created visualizations).
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
title string The Table Plot visualization title. If empty, the Spotfire active Page is used.
datatable string The name of the TIBCO Spotfire Data Table. If empty, the Spotfire active data table is used.
page string The name of Tiboc Spotfire Page.
Source:
Throws:
If the id is null or empty.
Example
createpiechart('1', 'MyPieChart', 'Pipeline Pilot Data 1', 'Discngine Web Panel Start Page');

createscatterplot(id, title, datatable, page)

Creates a Scatter Plot visualization (but not display it. Use showvisual method to display all created visualizations).
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
title string The Table Plot visualization title. If empty, the Spotfire active Page is used.
datatable string The name of the TIBCO Spotfire Data Table. If empty, the Spotfire active data table is used.
page string The name of Tiboc Spotfire Page.
Source:
Throws:
If the id is null or empty.
Example
createscatterplot('1', 'MyScatterPlot', 'Pipeline Pilot Data 1', 'Discngine Web Panel Start Page');

createscatterplot3d(id, title, datatable, page)

Creates a Scatter Plot 3D visualization (but not display it. Use showvisual method to display all created visualizations).
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
title string The Table Plot visualization title. If empty, the Spotfire active Page is used.
datatable string The name of the TIBCO Spotfire Data Table. If empty, the Spotfire active data table is used.
page string The name of Tiboc Spotfire Page.
Source:
Throws:
If the id is null or empty.
Example
createscatterplot3d('1', 'My3DScatterPlot', 'Pipeline Pilot Data 1', 'Discngine Web Panel Start Page');

createtable(id, title, datatable, page)

Creates a Table Plot visualization (but not display it. Use showvisual method to display all created visualizations).
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
title string The Table Plot visualization title. If empty, the Spotfire active Page is used.
datatable string The name of the TIBCO Spotfire Data Table. If empty, the Spotfire active data table is used.
page string The name of Tiboc Spotfire Page.
Source:
Throws:
If the id is null or empty.
Example
createtable('1', 'MyTable', 'Pipeline Pilot Data 1', 'Discngine Web Panel Start Page');

createtreemap(id, title, datatable, page)

Creates a Treemap visualization (but not display it. Use showvisual method to display all created visualizations).
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
title string The Table Plot visualization title. If empty, the Spotfire active Page is used.
datatable string The name of the TIBCO Spotfire Data Table. If empty, the Spotfire active data table is used.
page string The name of Tiboc Spotfire Page.
Source:
Throws:
If the id is null or empty.
Example
createtreemap('1', 'MyTreemap', 'Pipeline Pilot Data 1', 'Discngine Web Panel Start Page');

showvisual(id)

Displays a TIBCO Spotfire visualization (no more modification will be allowed on this visualization).
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
Source:
Example
showvisual('1');