Spotfire Pages

Page

The Document holds the page collection and a reference to the active page. Each page has a set of visuals and panels. It also holds references to the active visual, filtering, marking and data table.

If you add a new page, it will only contain the filter and the details-on-demand panels. Auto-configure the page based on a template page indicating which page to mimic: The panels are configured like the panels on the template page, but no visuals are added to the page.

Related API documentation

• ActivePageReference
• Visual
• DataFilteringSelection
• DataMarkingSelection
• DataTable
• AutoConfigure

Code Example

• Adding a page and a visualization to it
  This code example shows how to create a page and add a visualization.

Visuals

A visual is either a visualization or a text area. The type is determined by the TypeId property, which typically is one of the VisualTypeIdentifiers. By setting the TypeId property, the visual is converted to the new type.

Since the user can convert any visual at any time via the user interface, the TypeId must always be determined before calling As<T> to get the specific visualization (or text area) type.

Although the visualization methods and properties are sometimes declared on abstract base classes such as Visualization and TrellisVisualization, always use the concrete visualization types, such as BarChart, directly.

Visualizations in the API documentation

• BarChart
• BoxPlot
• CrossTable
• LineChart
• MapChart
• ParallelCoordinatePlot
• PieChart
• ScatterPlot
• SummaryTable
• Table
• TextArea

Related classes

• VisualizationData
• Axis
• ScaleAxis
• ColorAxis
• ShapeAxis
• GroupByAxis
• Legend

Panels

A panel is docked to the left, right or bottom of a page. Panels are versatile and can be used for many different purposes. The following Tag, Bookmark, Filter and Details-on-Demand panels are built-in

Panels in the API documentation

• TagPanel
• BookmarkPanel
• FilterPanel
• DetailsOnDemandPanel