Class GraphicalTable

Represents a tabular visualization with miniature visualizations in its cells. The table supports a categorical row axis and the columns are specified by a sequence of miniature visualization, each with a row axis that is kept in sync with that of the GraphicalTable.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

AdditionalValueRowHeight ColumnHeaderLineCount Columns Context Data Description HeaderColumnWidth HorizontalLegend IndicateHiddenRows IsAttached Legend RowAxis ShowCellBorders ShowDescription ShowHeaderColumnHeader ShowHeaderRow ShowRowAxisSelector ShowTopNRows SortInfos SupportsTransparency TableHeaderFontMetadata TableSectionHeaderFontMetadata Title TopNRowCount Transactions Transparency TypeId UseSeparateColorForMarkedItems Visual ApplyUserPreferences AutoConfigure IsConfigurationValid RefreshOnDemandData TryGetFilterRules

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • 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

Equals

  • Equals(obj): boolean

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

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • 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

StaticEquals

  • Equals(objA, objB): boolean

  • 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

AdditionalValueRowHeight

  • get AdditionalValueRowHeight(): number

  • Gets or sets the additional height in pixels that will be added to the font height to determine the height of a value row.

    Returns number

    Since

    2.0

  • set AdditionalValueRowHeight(value): void

  • Parameters

    • value: number

    Returns void

ColumnHeaderLineCount

  • get ColumnHeaderLineCount(): number

  • Gets or sets the number of lines of text in the column header.

    Returns number

    Since

    2.0

  • set ColumnHeaderLineCount(value): void

  • Parameters

    • value: number

    Returns void

Columns

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

Data

Description

  • get Description(): string

  • Gets or sets the plot description.

    Returns string

    Since

    2.0

  • set Description(value): void

  • Parameters

    • value: string

    Returns void

HeaderColumnWidth

  • get HeaderColumnWidth(): number

  • Gets or sets the width in pixels used by the header column. This is the leftmost column displayed in the table.

    Returns number

    Since

    2.0

  • set HeaderColumnWidth(value): void

  • Parameters

    • value: number

    Returns void

HorizontalLegend

  • get HorizontalLegend(): HorizontalLegend

  • Gets the horizontal legend object for this plot.

    Returns HorizontalLegend

    Since

    2.0

IndicateHiddenRows

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

Legend

  • get Legend(): Legend

  • Gets the legend object for this plot.

    Returns Legend

    Since

    2.0

RowAxis

ShowCellBorders

  • get ShowCellBorders(): boolean

  • Gets or sets a value indicating whether the table cell borders are displayed or not.

    Returns boolean

    Since

    2.0

  • set ShowCellBorders(value): void

  • Parameters

    • value: boolean

    Returns void

ShowDescription

  • get ShowDescription(): boolean

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

    Returns boolean

    Since

    2.0

  • set ShowDescription(value): void

  • Parameters

    • value: boolean

    Returns void

ShowHeaderColumnHeader

  • get ShowHeaderColumnHeader(): boolean

  • Gets or sets a value indicating whether the header of the header column shall be shown. This is the text displayed in the upper left corner of the table.

    Returns boolean

    Since

    2.0

  • set ShowHeaderColumnHeader(value): void

  • Parameters

    • value: boolean

    Returns void

ShowHeaderRow

  • get ShowHeaderRow(): boolean

  • Gets or sets a value indicating whether the header row shall be shown. This is the topmost row in the table.

    Returns boolean

    Since

    2.0

  • set ShowHeaderRow(value): void

  • Parameters

    • value: boolean

    Returns void

ShowRowAxisSelector

  • get ShowRowAxisSelector(): boolean

  • Gets or sets a value indicating whether the row axis selector shall be shown.

    Returns boolean

    Since

    2.0

  • set ShowRowAxisSelector(value): void

  • Parameters

    • value: boolean

    Returns void

ShowTopNRows

SortInfos

SupportsTransparency

  • get SupportsTransparency(): boolean

  • Gets a value indicating whether transparency is supported.

    Returns boolean

    Since

    2.0

TableHeaderFontMetadata

  • get TableHeaderFontMetadata(): FontMetadata

  • Gets or sets the font used for all header cell texts.

    Returns FontMetadata

    Since

    2.0

  • set TableHeaderFontMetadata(value): void

  • Parameters

    Returns void

TableSectionHeaderFontMetadata

  • get TableSectionHeaderFontMetadata(): FontMetadata

  • Gets or sets the font used for all section header cell texts.

    Returns FontMetadata

    Since

    2.0

  • set TableSectionHeaderFontMetadata(value): void

  • Parameters

    Returns void

Title

  • get Title(): string

  • Gets or sets the Visual's title.

    Returns string

    Since

    2.0

  • set Title(value): void

  • Parameters

    • value: string

    Returns void

TopNRowCount

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

Transparency

  • get Transparency(): number

  • Gets or sets the transparency for the plot.

    Returns number

    Since

    2.0

  • set Transparency(value): void

  • Parameters

    • value: number

    Returns void

TypeId

UseSeparateColorForMarkedItems

  • get UseSeparateColorForMarkedItems(): boolean

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

    Returns boolean

    Since

    2.0

  • set UseSeparateColorForMarkedItems(value): void

  • Parameters

    • value: boolean

    Returns void

Visual

  • get Visual(): null | Visual

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

    Returns null | Visual

    Since

    2.0

ApplyUserPreferences

AutoConfigure

  • AutoConfigure(): void

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

    Returns void

    Since

    2.0

IsConfigurationValid

  • IsConfigurationValid(): boolean

  • Determines whether the current plot configuration is valid.

    Returns boolean

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

    Since

    2.0

RefreshOnDemandData

  • RefreshOnDemandData(): void

  • 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

    Since

    2.0

TryGetFilterRules

  • TryGetFilterRules(filterRules): boolean

  • Try to get the filter rules for the plot.

    Parameters

    Returns boolean

    false if this visualization does not support filter, rules, otherwise true.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability