Action
    Preparing search index...

    Class CrossTablePlot

    Cross table plot class.

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

    The cells in the table can be colored via the Spotfire.Dxp.Application.Visuals.CrossTablePlot.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 Spotfire.Dxp.Application.Visuals.CrossTablePlot.MeasureAxis.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    CellHeight CellWidth ColorCategory Colorings ColumnAxis ColumnHeaderHeights ColumnLabels ColumnSubtotals ColumnSubtotalsLayout Context Data Description EmptyCellText ExportDataEnabled Formatting HorizontalLegend IndicateHiddenColumns IndicateHiddenRows IsAttached Legend MeasureAxis RowAxis RowHeaderScroll RowHeaderWidths RowLabels ShowAxisSelectors ShowColumnGrandTotal ShowContinuousColor ShowDescription ShowGridlines ShowRowGrandTotal ShowTopNColumns ShowTopNRows SortColumnsCategory SortColumnsOrder SortRowsCategory SortRowsMode SortRowsOrder SupportsTransparency TableFontMetadata TableHeaderFontMetadata TableTotalsFontMetadata Title TopNColumnCount TopNRowCount Totals Transactions Transparency TypeId UseSeparateColorForMarkedItems Visual ApplyUserPreferences AutoConfigure CreateLayout ExportText IsConfigurationValid RefreshOnDemandData TryGetFilterRules

    Methods

    • Casts this object to the specified type. Throws error on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns T1

    • Determines whether the specified object is equal to the current object.

      Parameters

      • obj: any

        The object to compare with the current object.

      Returns boolean

      true if the specified object is equal to the current object; otherwise, false.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • Casts this object to the specified type. Returns null on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns null | T1

    • Determines whether the specified object instances are considered equal.

      Parameters

      • objA: any

        The first object to compare.

      • objB: any

        The second object to compare.

      Returns boolean

      true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

    Default capability

    • get CellHeight(): number

      Gets or sets the cell height.

      Returns number

      2.0

    • set CellHeight(value: number): void

      Parameters

      • value: number

      Returns void

    • get CellWidth(): number

      Gets or sets the cell width.

      Returns number

      2.0

    • set CellWidth(value: number): void

      Parameters

      • value: number

      Returns void

    • get ColorCategory(): CategoryKey

      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)".

      Returns CategoryKey

      2.0

    • set ColorCategory(value: CategoryKey): void

      Parameters

      Returns void

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get Description(): string

      Gets or sets the plot description.

      Returns string

      2.0

    • set Description(value: string): void

      Parameters

      • value: string

      Returns void

    • get EmptyCellText(): string

      Gets or sets the text to display when there is no data.

      Returns string

      2.0

    • set EmptyCellText(value: string): void

      Parameters

      • value: string

      Returns void

    • get ExportDataEnabled(): boolean

      Gets or sets a value indicating whether cross table data can be exported in the Web Player.

      Returns boolean

      2.0

    • set ExportDataEnabled(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Formatting(): Formatting

      Gets the formatting for this cross table plot.

      Returns Formatting

      2.0

    • get HorizontalLegend(): HorizontalLegend

      Gets the horizontal legend object for this plot.

      Returns HorizontalLegend

      2.0

    • get IndicateHiddenColumns(): boolean

      Gets or sets a value indicating whether to show an extra empty column for hidden columns when using top N columns.

      Returns boolean

      2.0

    • set IndicateHiddenColumns(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get IndicateHiddenRows(): boolean

      Gets or sets a value indicating whether to show an extra empty row for hidden rows when using top N rows.

      Returns boolean

      2.0

    • set IndicateHiddenRows(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get ShowAxisSelectors(): boolean

      Gets or sets a value indicating whether to show axis selectors.

      Returns boolean

      2.0

    • set ShowAxisSelectors(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get ShowColumnGrandTotal(): boolean

      Gets or sets a value indicating whether to show column grand total.

      Returns boolean

      2.0

    • set ShowColumnGrandTotal(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get ShowContinuousColor(): boolean

      Gets or sets a value indicating whether to use continuous coloring for numeric cells.

      Returns boolean

      In versions prior to 3.1 this property can be used to toggle the coloring on and off. From version 3.1 this property will configure the color rules found in the Colorings.DefaultNumericReference property to include or exclude a Spotfire.Dxp.Application.Visuals.ConditionalColoring.ContinuousColorRule.

      2.0

    • set ShowContinuousColor(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get ShowDescription(): boolean

      Gets or sets a flag indicating whether to show the description or not.

      Returns boolean

      2.0

    • set ShowDescription(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get ShowGridlines(): boolean

      Gets or sets a value indicating whether to show gridlines.

      Returns boolean

      2.0

    • set ShowGridlines(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get ShowRowGrandTotal(): boolean

      Gets or sets a value indicating whether to show row grand total.

      Returns boolean

      2.0

    • set ShowRowGrandTotal(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get ShowTopNColumns(): boolean

      Gets or sets a value indicating whether top N columns should be activated.

      Returns boolean

      2.0

    • set ShowTopNColumns(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get ShowTopNRows(): boolean

      Gets or sets a value indicating whether top N rows should be activated.

      Returns boolean

      2.0

    • set ShowTopNRows(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get SortColumnsOrder(): SortOrder

      Gets or sets the direction of sort when sorting columns.

      Returns SortOrder

      2.0

    • set SortColumnsOrder(value: SortOrder): void

      Parameters

      Returns void

    • get SortRowsMode(): SortMode

      Gets or sets the sort mode used when sorting rows.

      Returns SortMode

      2.0

    • set SortRowsMode(value: SortMode): void

      Parameters

      Returns void

    • get SortRowsOrder(): SortOrder

      Gets or sets the direction of sort when sorting rows.

      Returns SortOrder

      2.0

    • set SortRowsOrder(value: SortOrder): void

      Parameters

      Returns void

    • get SupportsTransparency(): boolean

      Gets a value indicating whether transparency is supported.

      Returns boolean

      2.0

    • get TopNColumnCount(): number

      Gets or sets top N column count.

      Returns number

      2.0

    • set TopNColumnCount(value: number): void

      Parameters

      • value: number

      Returns void

    • get TopNRowCount(): number

      Gets or sets the top N row count.

      Returns number

      2.0

    • set TopNRowCount(value: number): void

      Parameters

      • value: number

      Returns void

    • get Transactions(): ITransactions

      Gets a collection of methods for executing transactions on the document.

      Returns ITransactions

      2.0

    • get Transparency(): number

      Gets or sets the transparency for the plot.

      Returns number

      2.0

    • set Transparency(value: number): void

      Parameters

      • value: number

      Returns void

    • get UseSeparateColorForMarkedItems(): boolean

      Gets or sets a value indicating whether to use a separate color for marked items.

      Returns boolean

      2.0

    • set UseSeparateColorForMarkedItems(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Visual(): null | Visual

      Gets the visual instance, or null if this instance is not owned by a visual.

      Returns null | Visual

      2.0

    • Configures a newly created visual with reasonable default values given the current data set.

      Returns void

      This method is called when a visual is created by the user, but the exact configuration produced is undefined and can change between versions. This method should only be used if you want to mimic the user's action in the application, and it should only be called once. It implicity calls Spotfire.Dxp.Application.Visuals.VisualContent.ApplyUserPreferences.
      Code samples on how to create and configure a visualization are available in Spotfire Technology Network. Additional action needed for the Map Chart: in order to load the default layers (i.e. base map layer) you need to explicitly call Spotfire.Dxp.Application.Visuals.Maps.MapChart.AutoConfigureLayers.

      2.0

    • Exports the content of the cross table as tab separated text.

      Parameters

      Returns void

      Each cell value is formatted as displayed on screen, and the cells values are tab separated. Each row is terminated by a carriage return, line feed sequence (\r\n).

      Cell text that contain quotes, tabs or newlines are escaped. An escaped text value is surrounded by quotes and each quote inside the text is duplicated. Any carriage return (\r) or carriage return, line feed sequence (\r\n) inside the text is replaced with a line feed (\n).

      For example, 22" would become "22""" and Hello\r\nWorld. would become "Hello\nWorld."

      2.0

    • Determines whether the current plot configuration is valid.

      Returns boolean

      true if the current plot configuration is valid; otherwise, false.

      2.0

    • 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.

      Returns void

      This will only refresh the data tables where the Spotfire.Dxp.Data.DataTable.NeedsRefresh property is true.

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability
    CellHeightCellWidthColorCategoryColoringsColumnAxisColumnHeaderHeightsColumnLabelsColumnSubtotalsColumnSubtotalsLayoutContextDataDescriptionEmptyCellTextExportDataEnabledFormattingHorizontalLegendIndicateHiddenColumnsIndicateHiddenRowsIsAttachedLegendMeasureAxisRowAxisRowHeaderScrollRowHeaderWidthsRowLabelsShowAxisSelectorsShowColumnGrandTotalShowContinuousColorShowDescriptionShowGridlinesShowRowGrandTotalShowTopNColumnsShowTopNRowsSortColumnsCategorySortColumnsOrderSortRowsCategorySortRowsModeSortRowsOrderSupportsTransparencyTableFontMetadataTableHeaderFontMetadataTableTotalsFontMetadataTitleTopNColumnCountTopNRowCountTotalsTransactionsTransparencyTypeIdUseSeparateColorForMarkedItemsVisualApplyUserPreferencesAutoConfigureCreateLayoutExportTextIsConfigurationValidRefreshOnDemandDataTryGetFilterRules