SummaryTable Class

Spotfire 14.7 API Reference

Summary table class.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.VisualsVisualContent
        Spotfire.Dxp.Application.VisualsVisualization
          Spotfire.Dxp.Application.Visuals.TablesTableBase
            Spotfire.Dxp.Application.VisualsSummaryTable

Namespace: Spotfire.Dxp.Application.Visuals
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 69.0.21424.2902 (69.0.21424.2902)

Syntax

Copy

[SerializableAttribute]
[ToolContextAttribute]
[PersistenceVersionAttribute(36, 0)]
public sealed class SummaryTable : TableBase

The SummaryTable type exposes the following members.

Properties

	Name	Description
	Aggregations	Gets the collection of aggregation methods used in the Summary Table, for example "Sum, Avg, Max".
	AutoAddNewColumns	Gets or sets a value controlling if columns added to the data table rendered by this SummaryTable should automatically be shown.
	CategoryAxis	Gets the row axis.
	Columns	Gets the collection of table columns.
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Data	Gets the plot data. (Inherited from Visualization.)
	Description	Gets or sets the plot description. (Inherited from Visualization.)
	ExportDataEnabled	Gets or sets a value indicating whether or not to export summary table data in the Web Player.
	FirstColumnWidth	Gets or sets the width of first column, the header.
	FirstRowHeight	Gets or sets the height of column headers.
	HorizontalLegend	Gets the horizontal legend object for this plot. (Inherited from Visualization.)
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	Legend	Gets the legend object for this plot. (Inherited from Visualization.)
	ShowDescription	Gets or sets a flag indicating whether to show the description or not. (Inherited from Visualization.)
	ShowGridlines	Gets or sets a value indicating whether to show gridlines.
	SortColumns	Gets the collection of columns to sort by.
	SupportsTransparency	Gets a value indicating whether transparency is supported. (Inherited from Visualization.)
	TableFont	Obsolete. Gets or sets the table font.
	TableFontMetadata	Gets or sets the table font.
	TableHeaderFont	Obsolete. Gets or sets the table header font.
	TableHeaderFontMetadata	Gets or sets the table header font.
	Title	Gets or sets the Visual's title. (Inherited from VisualContent.)
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)
	Transparency	Gets or sets the transparency for the plot. (Inherited from Visualization.)
	TypeId	Gets the type identifier for the visual. (Inherited from VisualContent.)
	UseSeparateColorForMarkedItems	Gets or sets a value indicating whether to use a separate color for marked items. (Inherited from Visualization.)
	Visual	Gets the visual instance, or null if this instance is not owned by a visual. (Inherited from VisualContent.)

Top

Methods

	Name	Description
	ApplyUserPreferences	Applies user preferences to a newly created visual. (Inherited from VisualContent.)
	AutoConfigure	Configures a newly created visual with reasonable default values given the current data set. (Inherited from VisualContent.)
	CreateLayout	Creates a layout object that can be used to access the values in the table.
	ExportText	Exports the content of the summary table as tab separated text.
	ForEachNodeInSubTreeTNode	Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node. (Inherited from DocumentNode.)
	GetRenderTrigger	Gets a trigger signaling that the visualization has changed and needs to be re-rendered. Note that it does not trigger when highlight changes. (Inherited from VisualContent.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsConfigurationValid	Determines whether the current plot configuration is valid. (Inherited from Visualization.)
	RefreshOnDemandData	Refreshes data in data tables that depends on other data and is not automatically updated. This includes on-demand data with manual refresh, data functions with update behavior Manual and calculations with update behavior Invalidate. Only data tables used by this visualization will be included. (Inherited from Visualization.)
	Render	Obsolete. Renders the visual to the specified graphics context. (Inherited from VisualContent.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetFilterRules	Try to get the filter rules for the plot. (Inherited from Visualization.)

Top

Explicit Interface Implementations

	Name	Description
	INodeContextGetAncestorT	Implements GetAncestorT. (Inherited from DocumentNode.)
	INodeContextGetServiceT	Implements GetServiceT. (Inherited from DocumentNode.)
	INodeContextIsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactionsBeginAggregatedTransaction	Implements BeginAggregatedTransaction. (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Top

Version Information

Supported in: 14.7, 14.6, 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8

Reference

Spotfire.Dxp.Application.Visuals Namespace