Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SplitsComponentStateRef

The state object that describes a single segment's information to visualize.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • This constructor is an implementation detail. Do not use this.

    Parameters

    • ptr: number

    Returns SplitsComponentStateRef

Properties

ptr

ptr: number

Methods

columnSemanticColor

  • columnSemanticColor(index: number, columnIndex: number): string

  • The semantic coloring information the column's value carries of the segment and column with the specified index. The columns are specified from right to left. You may not provide an out of bounds index.

    Parameters

    • index: number
    • columnIndex: number

    Returns string

columnValue

  • columnValue(index: number, columnIndex: number): string

  • The column's value to show for the split and column with the specified index. The columns are specified from right to left. You may not provide an out of bounds index.

    Parameters

    • index: number
    • columnIndex: number

    Returns string

columnsLen

  • columnsLen(index: number): number

  • The amount of columns to visualize for the segment with the specified index. The columns are specified from right to left. You may not provide an out of bounds index. The amount of columns to visualize may differ from segment to segment.

    Parameters

    • index: number

    Returns number

finalSeparatorShown

  • finalSeparatorShown(): boolean

  • Describes whether a more pronounced separator should be shown in front of the last segment provided.

    Returns boolean

iconChangeCount

  • iconChangeCount(): number

  • Returns the amount of icon changes that happened in this state object.

    Returns number

iconChangeIconLen

  • iconChangeIconLen(iconChangeIndex: number): number

  • The length of the icon data of the segment of the icon change with the specified index.

    Parameters

    • iconChangeIndex: number

    Returns number

iconChangeIconPtr

  • iconChangeIconPtr(iconChangeIndex: number): number

  • The icon data of the segment of the icon change with the specified index. The buffer may be empty. This indicates that there is no icon. You may not provide an out of bounds index.

    Parameters

    • iconChangeIndex: number

    Returns number

iconChangeSegmentIndex

  • iconChangeSegmentIndex(iconChangeIndex: number): number

  • Accesses the index of the segment of the icon change with the specified index. This is based on the index in the run, not on the index of the SplitState in the State object. The corresponding index is the index field of the SplitState object. You may not provide an out of bounds index.

    Parameters

    • iconChangeIndex: number

    Returns number

isCurrentSplit

  • isCurrentSplit(index: number): boolean

  • Describes if the segment with the specified index is the segment the active attempt is currently on.

    Parameters

    • index: number

    Returns boolean

len

  • len(): number

  • Returns the amount of segments to visualize.

    Returns number

name

  • name(index: number): string

  • The name of the segment with the specified index. You may not provide an out of bounds index.

    Parameters

    • index: number

    Returns string

Generated using TypeDoc