CrossTablePlot Class

TIBCO Spotfire 7.6 API Reference

Cross table plot class.

Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Framework.DocumentModelNode
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.VisualsVisualContent
        Spotfire.Dxp.Application.VisualsVisualization
          Spotfire.Dxp.Application.VisualsCrossTablePlot

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

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(24, 0)]
[ToolContextAttribute]
public sealed class CrossTablePlot : Visualization, 
	IColorValueFormatter_OBSOLETE, IFormattingHost, IExportableTabularVisualization, IColorRuleVisualization, IRuleHost, 
	IColoringHost, ITabularColoringPlot

The CrossTablePlot type exposes the following members.

Methods

	Name	Description
	ApplyUserPreferences	Applies user preferences to a newly created visual. (Inherited from VisualContent.)
	ApplyUserPreferencesCore	Override this method to apply 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.)
	CreateEventRelay(PropertyName, StatelessDependencyDeclarer)	Creates an event relay. An event relay is a property in the document model which propagates event. An event is raised for the event relay whenever when the trigger returned by the specified dependencyDeclarer fires. (Inherited from DocumentNode.)
	CreateEventRelay(PropertyName, StatelessDependencyDeclarer, EventRelayMode)	Creates an event relay. An event relay is a property in the document model which propagates event. An event is raised for the event relay whenever when the trigger returned by the specified dependencyDeclarer fires. (Inherited from DocumentNode.)
	CreateLayout	Creates a layout object that can be used to access the values in the table.
	CreatePropertyT(PropertyName, UndoableListT)	Creates an UndoableListT and assigns it to the specified field. The UndoableListT will have the specified propertyName. (Inherited from DocumentNode.)
	CreatePropertyT(PropertyName, UndoableSetT)	Creates an UndoableSetT and assigns it to the specified field. The UndoableSetT will have the specified propertyName. (Inherited from DocumentNode.)
	CreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode)	Creates an UndoableCrossReferencePropertyT and assigns it to the specified field. The UndoableCrossReferencePropertyT will have the specified propertyName and initialValue. (Inherited from DocumentNode.)
	CreatePropertyT(PropertyName, UndoablePropertyT, T)	Creates an UndoablePropertyT and assigns it to the specified field. The UndoablePropertyT will have the specified propertyName and initialValue. (Inherited from DocumentNode.)
	CreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue)	Creates an UndoableDictionaryTKey, TValue and assigns it to the specified field. The UndoableDictionaryTKey, TValue will have the specified propertyName. (Inherited from DocumentNode.)
	CreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode)	Creates an UndoableKeyedCollectionTKey, TNode and assigns it to the specified field. The UndoableKeyedCollectionTKey, TNode will have the specified propertyName. (Inherited from DocumentNode.)
	CreateReadOnlyPropertyT	Creates a read-only property of type T and assigns it to the specified field. (Inherited from DocumentNode.)
	CreateRuntimeConstantT	Creates a runtime constant. A runtime constant is a property in the document model whose value is computed once when first accessed. The value is then disposed along with the DocumentNode. (Inherited from DocumentNode.)
	CreateRuntimePropertyT(PropertyName, RuntimePropertyT, DependencyDeclarer, PropertyComputerT)	Obsolete. Creates a RuntimePropertyT. (Inherited from DocumentNode.)
	CreateRuntimePropertyT(PropertyName, RuntimePropertyT, StatelessDependencyDeclarer, StatelessPropertyComputerT)	Creates a RuntimePropertyT. (Inherited from DocumentNode.)
	DeclareInternalEventHandlers	Override this method to declare handlers of internal events. (Inherited from DocumentNode.)
	DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT)	Deserializes an UndoableCrossReferencePropertyT with value of type T stored in info with key propertyName. (Inherited from DocumentNode.)
	DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT)	Deserializes an UndoableListT with value of type T stored in info with key given by propertyName. (Inherited from DocumentNode.)
	DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT)	Deserializes an UndoablePropertyT with value of type T stored in info with key propertyName. (Inherited from DocumentNode.)
	DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT)	Deserializes an UndoableSetT with value of type T stored in info with key propertyName. (Inherited from DocumentNode.)
	DeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue)	Deserializes an UndoableDictionaryTKey, TValue stored in info with key given by propertyName. (Inherited from DocumentNode.)
	DeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode)	Deserializes an UndoableKeyedCollectionTKey, TNode stored in info with key given by propertyName. (Inherited from DocumentNode.)
	DeserializeReadOnlyPropertyT	Deserializes a read-only property of type T stored in info with key propertyName. (Inherited from DocumentNode.)
	DuplicateSubtreeT	Returns a copy of the sub tree spanned from this node that has the same outwards non-owning references. The returned copy will be in state New and is intended to be attached to the document immediately. (Inherited from DocumentNode.)
	ExportText	Exports the content of the cross table as tab separated text.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetPersistedTypeName	Can be used in the deserialization constructor to get the type name that the class corresponding to this class had when it was originally serialized. Will return null if the specified caller type has no correspondence in the serialized information (Inherited from DocumentNode.)
	GetPersistedVersion	Can be used in the deserialization constructor to get the persistence version that this class was marked with when it was originally serialized. Will return null if the specified caller type has no correspondence in the serialized information (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.)
	GetRenderTriggerCore	Override to create and return a render trigger. The render trigger is used to signal when the visualization is invalid and need to re-render. Note that it should not fire when highlight changes. The default implementation returns a NeverTrigger. (Inherited from VisualContent.)
	GetService	Override this method to provide services accessible from this node and its descendants. If you can not provide the requested service, you should call base.GetService which relays the request to the owner or to the AnalysisApplication if no owner is set. (Inherited from Node.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InternalTransaction	Starts an internal transaction on the document model by executing the specified executor delegate. (Inherited from DocumentNode.)
	IsConfigurationValid	Determines whether the current plot configuration is valid. (Inherited from Visualization.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnConfigure	Allows a node to configure itself to the surrounding document. (Inherited from DocumentNode.)
	OnConfigured	Allows a node to configure itself to the surrounding document. (Inherited from DocumentNode.)
	OnReconfigure	Allows a node to reconfigure itself to a new part of the surrounding document. (Inherited from DocumentNode.)
	OnReconfigured	Allows a node to reconfigure itself to a new part of the surrounding document. (Inherited from DocumentNode.)
	Render	Renders the visual to the specified graphics context. (Inherited from VisualContent.)
	SerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT)	Serializes an Undoable*Property with value of type T storing it in info with key property.Name. (Inherited from DocumentNode.)
	SerializePropertyT(SerializationInfo, StreamingContext, UndoableListT)	Serializes an UndoableList with values of type T storing it in info with key list.Name. (Inherited from DocumentNode.)
	SerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT)	Serializes an UndoableProperty with value of type T storing it in info with key property.Name. (Inherited from DocumentNode.)
	SerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT)	Serializes an UndoableSet storing it in info with key given by the property name of the set. (Inherited from DocumentNode.)
	SerializePropertyTKey, TValue(SerializationInfo, StreamingContext, UndoableDictionaryTKey, TValue)	Serializes an UndoableDictionary storing it in info with key given by the property name of the dictionary. (Inherited from DocumentNode.)
	SerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode)	Serializes an UndoableKeyedCollectionTKey, TNode storing it in info with key given by the property name of the keyedCollection. (Inherited from DocumentNode.)
	SerializeReadOnlyPropertyT	Serializes a read-only property of type T stored in info with key propertyName. (Inherited from DocumentNode.)
	TryGetFilterRules	Try to get the filter rules for the plot. (Inherited from Visualization.)
	ValidateAttached	Validates that the node is attached. (Inherited from DocumentNode.)

Top

Properties

	Name	Description
	CellHeight	Gets or sets the cell height.
	CellWidth	Gets or sets the cell width.
	ColorCategory	Gets or sets the category defining how color schemes can be applied. The category should be the name of one of the levels in either the row hierarchy or the column hierarchy. CategoryKey.Empty represents Column Names, presented as "(Cell Values)".
	Colorings	Gets the ColoringCollection for this plot. The ColoringCollection contains Coloring objects, and has methods to apply them to parts of the plot.
	ColumnAxis	Gets the column axis.
	ColumnHeaderHeights	Gets the height of the column headers. This is the headers on the top of the cross table.
	ColumnLabels	Gets the column axis labels object.
	ColumnSubtotals	Gets the column subtotals collection.
	ColumnSubtotalsLayout	Gets or sets a value indicating whether column subtotals should be displayed above or below the values.
	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 cross table data can be exported in the Web Player.
	Formatting	Gets the formatting for this cross table plot.
	IndicateHiddenColumns	Gets or sets a value indicating whether to show an extra empty column for hidden columns when using top N columns.
	IndicateHiddenRows	Gets or sets a value indicating whether to show an extra empty row for hidden rows when using top N rows.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	Legend	Gets the legend object for this plot. (Inherited from Visualization.)
	MeasureAxis	Gets the measure axis.
	RowAxis	Gets the row axis.
	RowHeaderWidths	Gets the width of the row headers. This is the headers to the left of the cross table.
	RowLabels	Gets the row axis labels object.
	ShowAxisSelectors	Gets or sets a value indicating whether to show axis selectors.
	ShowColumnGrandTotal	Gets or sets a value indicating whether to show column grand total.
	ShowColumnSubtotals	Obsolete. Gets or sets a value indicating whether to show column subtotals for all levels.
	ShowContinuousColor	Gets or sets a value indicating whether to use continuous coloring for numeric cells.
	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.
	ShowRowGrandTotal	Gets or sets a value indicating whether to show row grand total.
	ShowTopNColumns	Gets or sets a value indicating whether top N columns should be activated.
	ShowTopNRows	Gets or sets a value indicating whether top N rows should be activated.
	SortColumnsCategory	Gets or sets a category key for sorting the columns.
	SortColumnsOrder	Gets or sets the direction of sort when sorting columns.
	SortRowsCategory	Gets or sets a category key for sorting the rows.
	SortRowsOrder	Gets or sets the direction of sort when sorting rows.
	SupportsTransparency	Gets a value indicating whether transparency is supported. (Inherited from Visualization.)
	TableFont	Gets or sets the table font.
	TableHeaderFont	Gets or sets the table header font.
	TableTotalsFont	Gets or sets the font for subtotals and grand total in the table.
	Title	Gets or sets the Visual's title. (Inherited from VisualContent.)
	TopNColumnCount	Gets or sets top N column count.
	TopNRowCount	Gets or sets the top N row count.
	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

Explicit Interface Implementations

	Name	Description
	IServiceProviderGetService	Implements IServiceProvider. (Inherited from Node.)
	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.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)

Top

Remarks

The cross table visualizes one or more measures specified by the expression on its MeasureAxis. The RowAxis and ColumnAxis control how to split the data into rows and columns.

The cells in the table can be colored via the Colorings property, that can be used to specify coloring rules and how they should be applied.

In versions prior to 3.1, coloring is controlled via properties found under the MeasureAxis.

Version Information

Supported in: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also

Reference

Spotfire.Dxp.Application.Visuals Namespace

Supported in: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0See Also

Reference

Supported in: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also