Class TableLayout

Class describing the layout of the table in tabular visualizations.

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

ColumnCount FontMetadata FrozenColumnCount FrozenColumnsWidth FrozenRowCount FrozenRowsHeight Height RowCount ScrollPosition Width Dispose GetCellRange GetCells GetCellsBounds GetColumnOffset GetColumnWidth GetRowHeight GetRowOffset

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

ColumnCount

  • get ColumnCount(): number

  • Gets the number of columns.

    Returns number

    Since

    2.0

FontMetadata

FrozenColumnCount

  • get FrozenColumnCount(): number

  • Gets the number of frozen columns.

    Returns number

    Since

    2.0

FrozenColumnsWidth

  • get FrozenColumnsWidth(): number

  • The width of the frozen columns, including any row headers.

    Returns number

    Since

    2.0

FrozenRowCount

  • get FrozenRowCount(): number

  • Gets the number of frozen rows.

    Returns number

    Since

    2.0

FrozenRowsHeight

  • get FrozenRowsHeight(): number

  • The height of the frozen rows, including column headers.

    Returns number

    Since

    2.0

Height

  • get Height(): number

  • The total height of the layout.

    Returns number

    Since

    2.0

RowCount

  • get RowCount(): number

  • Gets the number of rows.

    Returns number

    Since

    2.0

ScrollPosition

  • get ScrollPosition(): Point

  • The current scroll position in the view. This point is expressed as an offset into the area of the non-frozen rows and columns. The value Point.Empty signals that no scrolling has taken place.

    Returns Point

    Since

    2.0

Width

  • get Width(): number

  • The total width of the layout.

    Returns number

    Since

    2.0

Dispose

  • Dispose(): void

  • Implements System.IDisposable.

    Returns void

    Since

    2.0

GetCellRange

  • GetCellRange(point): CellRange

  • Gets the cell at a given point.

    Parameters

    Returns CellRange

    A cell range. This cell range can be Spotfire.Dxp.Application.Visuals.CellRange.Empty if the point is outside of the bounds of the layout.

    Since

    2.0

  • GetCellRange(rectangle): CellRange

  • Gets the cell range for a given rectangle.

    Parameters

    Returns CellRange

    A cell range. If the rectangle doesn't have a width or height, an empty cell range is returned.

    Since

    2.0

GetCells

GetCellsBounds

  • GetCellsBounds(cellRange): Rectangle

  • Gets the bounding rectangle for a range of cells.

    Parameters

    Returns Rectangle

    The bounding rectangle.

    Since

    2.0

GetColumnOffset

  • GetColumnOffset(columnIndex): number

  • Gets the offset of a column.

    Parameters

    • columnIndex: number | Int32

      A column index.

    Returns number

    The offset to the column.

    Since

    2.0

GetColumnWidth

  • GetColumnWidth(columnIndex): number

  • Gets the width of column.

    Parameters

    • columnIndex: number | Int32

      A column index.

    Returns number

    The width of the column.

    Since

    2.0

GetRowHeight

  • GetRowHeight(rowIndex): number

  • Gets the height of a row.

    Parameters

    • rowIndex: number | Int32

      The row index.

    Returns number

    The height of the row.

    Since

    2.0

GetRowOffset

  • GetRowOffset(rowIndex): number

  • Gets the offset to a row.

    Parameters

    • rowIndex: number | Int32

      The row index.

    Returns number

    The offset to the row.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability