CrossTablePlot Class

Spotfire 14.2 API Reference
Cross table plot 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.VisualsCrossTablePlot

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

C#
[SerializableAttribute]
[PersistenceVersionAttribute(36, 0)]
[ToolContextAttribute]
public sealed class CrossTablePlot : TableBase

The CrossTablePlot type exposes the following members.

Properties

  NameDescription
Public propertyCellHeight
Gets or sets the cell height.
Public propertyCellWidth
Gets or sets the cell width.
Public propertyColorCategory
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)".
Public propertyColorings
Gets the ColoringCollection for this plot. The ColoringCollection contains Coloring objects, and has methods to apply them to parts of the plot.
Public propertyColumnAxis
Gets the column axis.
Public propertyColumnHeaderHeights
Gets the height of the column headers. This is the headers on the top of the cross table.
Public propertyColumnLabels
Gets the column axis labels object.
Public propertyColumnSubtotals
Gets the column subtotals collection.
Public propertyColumnSubtotalsLayout
Gets or sets a value indicating whether column subtotals should be displayed above or below the values.
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyData
Gets the plot data.
(Inherited from Visualization.)
Public propertyDescription
Gets or sets the plot description.
(Inherited from Visualization.)
Public propertyEmptyCellText
Gets or sets the text to display when there is no data.
Public propertyExportDataEnabled
Gets or sets a value indicating whether cross table data can be exported in the Web Player.
Public propertyFormatting
Gets the formatting for this cross table plot.
Public propertyHorizontalLegend
Gets the horizontal legend object for this plot.
(Inherited from Visualization.)
Public propertyIndicateHiddenColumns
Gets or sets a value indicating whether to show an extra empty column for hidden columns when using top N columns.
Public propertyIndicateHiddenRows
Gets or sets a value indicating whether to show an extra empty row for hidden rows when using top N rows.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyLegend
Gets the legend object for this plot.
(Inherited from Visualization.)
Public propertyMeasureAxis
Gets the measure axis.
Public propertyRowAxis
Gets the row axis.
Public propertyRowHeaderScroll
Gets or sets the row header horizontal scroll behavior.
Public propertyRowHeaderWidths
Gets the width of the row headers. This is the headers to the left of the cross table.
Public propertyRowLabels
Gets the row axis labels object.
Public propertyShowAxisSelectors
Gets or sets a value indicating whether to show axis selectors.
Public propertyShowColumnGrandTotal
Gets or sets a value indicating whether to show column grand total.
Public propertyShowColumnSubtotals Obsolete.
Gets or sets a value indicating whether to show column subtotals for all levels.
Public propertyShowContinuousColor
Gets or sets a value indicating whether to use continuous coloring for numeric cells.
Public propertyShowDescription
Gets or sets a flag indicating whether to show the description or not.
(Inherited from Visualization.)
Public propertyShowGridlines
Gets or sets a value indicating whether to show gridlines.
Public propertyShowRowGrandTotal
Gets or sets a value indicating whether to show row grand total.
Public propertyShowTopNColumns
Gets or sets a value indicating whether top N columns should be activated.
Public propertyShowTopNRows
Gets or sets a value indicating whether top N rows should be activated.
Public propertySortColumnsCategory
Gets or sets a category key for sorting the columns.
Public propertySortColumnsOrder
Gets or sets the direction of sort when sorting columns.
Public propertySortRowsCategory
Gets or sets a category key for sorting the rows.
Public propertySortRowsMode
Gets or sets the sort mode used when sorting rows.
Public propertySortRowsOrder
Gets or sets the direction of sort when sorting rows.
Public propertySupportsTransparency
Gets a value indicating whether transparency is supported.
(Inherited from Visualization.)
Public propertyTableFont Obsolete.
Gets or sets the table font.
Public propertyTableFontMetadata
Gets or sets the table font.
Public propertyTableHeaderFont Obsolete.
Gets or sets the table header font.
Public propertyTableHeaderFontMetadata
Gets or sets the table header font.
Public propertyTableTotalsFont Obsolete.
Gets or sets the font for subtotals and grand total in the table.
Public propertyTableTotalsFontMetadata
Gets or sets the font for subtotals and grand total in the table.
Public propertyTitle
Gets or sets the Visual's title.
(Inherited from VisualContent.)
Public propertyTopNColumnCount
Gets or sets top N column count.
Public propertyTopNRowCount
Gets or sets the top N row count.
Public propertyTotals
Gets the totals definition.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyTransparency
Gets or sets the transparency for the plot.
(Inherited from Visualization.)
Public propertyTypeId
Gets the type identifier for the visual.
(Inherited from VisualContent.)
Public propertyUseSeparateColorForMarkedItems
Gets or sets a value indicating whether to use a separate color for marked items.
(Inherited from Visualization.)
Public propertyVisual
Gets the visual instance, or null if this instance is not owned by a visual.
(Inherited from VisualContent.)
Top
Methods

  NameDescription
Public methodApplyUserPreferences
Applies user preferences to a newly created visual.
(Inherited from VisualContent.)
Public methodAutoConfigure
Configures a newly created visual with reasonable default values given the current data set.
(Inherited from VisualContent.)
Public methodCreateLayout
Creates a layout object that can be used to access the values in the table.
Public methodCode exampleExportText
Exports the content of the cross table as tab separated text.
Public methodGetRenderTrigger
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.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsConfigurationValid
Determines whether the current plot configuration is valid.
(Inherited from Visualization.)
Public methodRefreshOnDemandData
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.)
Public methodCode exampleRender Obsolete.
Renders the visual to the specified graphics context.
(Inherited from VisualContent.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryGetFilterRules
Try to get the filter rules for the plot.
(Inherited from Visualization.)
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodINodeContextGetAncestorT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction2
Implements ExecuteTransaction(Executor) for the Action Mods API.
(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: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference