Class TablePlot

TablePlot class.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

AutoAddNewColumns CellBorderStyle Colorings Context Data Description ExportDataEnabled FrozenCount HeaderHeight HorizontalLegend IsAttached Legend RowHeight ShowDescription SortInfos SupportsTransparency TableColumns TableFontMetadata TableHeaderFontMetadata Title Transactions Transparency TypeId UseSeparateColorForMarkedItems VirtualColumnProducers Visual WrapCellText WrapHeaderText ApplyUserPreferences AutoConfigure CreateLayout ExportData ExportText 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

AutoAddNewColumns

  • get AutoAddNewColumns(): boolean

  • Gets or sets a value controlling if columns added to the data table rendered by this TablePlot should automatically be shown.

    Returns boolean

    Since

    2.0

  • set AutoAddNewColumns(value): void

  • Parameters

    • value: boolean

    Returns void

CellBorderStyle

Colorings

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

ExportDataEnabled

  • get ExportDataEnabled(): boolean

  • Gets or sets a value indicating whether or not to export table data in web player.

    Returns boolean

    Since

    2.0

  • set ExportDataEnabled(value): void

  • Parameters

    • value: boolean

    Returns void

FrozenCount

  • get FrozenCount(): number

  • Gets or sets the number of frozen columns.

    Returns number

    Since

    2.0

  • set FrozenCount(value): void

  • Parameters

    • value: number

    Returns void

HeaderHeight

  • get HeaderHeight(): number

  • Gets or sets the height of the header in number of standard row heights.

    Returns number

    Since

    2.0

  • set HeaderHeight(value): void

  • Parameters

    • value: number

    Returns void

HorizontalLegend

  • get HorizontalLegend(): HorizontalLegend

  • Gets the horizontal legend object for this plot.

    Returns HorizontalLegend

    Since

    2.0

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

RowHeight

  • get RowHeight(): number

  • Gets or sets the height of a row in number of standard row heights.

    Returns number

    Since

    2.0

  • set RowHeight(value): void

  • Parameters

    • value: number

    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

SortInfos

SupportsTransparency

  • get SupportsTransparency(): boolean

  • Gets a value indicating whether transparency is supported.

    Returns boolean

    Since

    2.0

TableColumns

TableFontMetadata

  • get TableFontMetadata(): FontMetadata

  • Gets or sets the table font.

    Returns FontMetadata

    Since

    2.0

  • set TableFontMetadata(value): void

  • Parameters

    Returns void

TableHeaderFontMetadata

  • get TableHeaderFontMetadata(): FontMetadata

  • Gets or sets the table header font.

    Returns FontMetadata

    Since

    2.0

  • set TableHeaderFontMetadata(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

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

VirtualColumnProducers

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

WrapCellText

  • get WrapCellText(): boolean

  • Gets or sets a value indicating whether to wrap a cells text or not.

    Returns boolean

    Since

    2.0

  • set WrapCellText(value): void

  • Parameters

    • value: boolean

    Returns void

WrapHeaderText

  • get WrapHeaderText(): boolean

  • Gets or sets a value indicating whether or not to wrap header text.

    Returns boolean

    Since

    2.0

  • set WrapHeaderText(value): void

  • Parameters

    • value: boolean

    Returns void

ApplyUserPreferences

AutoConfigure

  • AutoConfigure(): void

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

    Returns void

    Since

    2.0

CreateLayout

ExportData

  • ExportData(typeIdentifier, stream): void

  • Exports the visualization data.

    Parameters

    Returns void

    Since

    2.0

ExportText

  • ExportText(writer): void

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

    Parameters

    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