Interface ResultTable<BackgroundType>

Public interface for ResultTable. Part of Cursor that displays information about current data-point.

Type Parameters

Hierarchy

Properties

getOrigin getTextFillStyle setContent setOrigin setTextFillStyle

Methods

getBackground getEffect getMargin getTextFont getTextRotation setBackground setEffect setMargin setTextFont setTextRotation

Properties

getOrigin

getOrigin: (() => Point)

Type declaration

    • (): Point

    • Get origin position of v

      Returns

      (-1 to 1 which specifies position of origin, 0 is center of the object)

      Returns Point

getTextFillStyle

getTextFillStyle: (() => FillStyle)

Type declaration

    • (): FillStyle

    • Get text fillStyle of ResultTable

      Returns

      FillStyle object

      Returns FillStyle

setContent

setContent: ((data: ResultTableContent) => ResultTable<BackgroundType>)

Type declaration

setOrigin

setOrigin: ((origin: Point) => ResultTable<BackgroundType>)

Type declaration

    • (origin: Point): ResultTable<BackgroundType>

    • Set origin position of ResultTable

      Returns

      Object itself for fluent interface

      Parameters

      • origin: Point

        (-1 to 1 which specifies position of origin, 0 is center of the object)

      Returns ResultTable<BackgroundType>

setTextFillStyle

setTextFillStyle: ((fillStyle: FillStyle | ImmutableMutator<FillStyle, FillStyle>) => ResultTable<BackgroundType>)

Type declaration

Methods

getBackground

  • Get background object of ResultTable

    Returns

    Background object

    Returns BackgroundType

getEffect

  • Get theme effect enabled on component or disabled.

    A theme can specify an Effect to add extra visual oomph to chart applications, like Glow effects around data or other components. Whether this effect is drawn above a particular component can be configured using the setEffect method.

     // Example, disable theme effect from a particular component.
     Component.setEffect(false)

    For the most part, theme effects are enabled by default on most components.

    Theme effect is configured with effect property.

    Returns

    Boolean that describes whether drawing the theme effect is enabled around the component or not.

    Returns boolean

getMargin

getTextFont

getTextRotation

  • Get rotation of ResultTable text.

    Returns

    Rotation in degrees

    Returns number

setBackground

  • Mutator function for Background of ResultTable.

    Returns

    Object itself for fluent interface

    Parameters

    • mutator: Mutator<BackgroundType>

      Mutator function

    Returns ResultTable<BackgroundType>

setEffect

  • Set theme effect enabled on component or disabled.

    A theme can specify an Effect to add extra visual oomph to chart applications, like Glow effects around data or other components. Whether this effect is drawn above a particular component can be configured using the setEffect method.

     // Example, disable theme effect from a particular component.
     Component.setEffect(false)

    For the most part, theme effects are enabled by default on most components.

    Theme effect is configured with effect property.

    Returns

    Object itself.

    Parameters

    • enabled: boolean

      Theme effect enabled

    Returns ResultTable<BackgroundType>

setMargin

  • Set margin around object in pixels.

    Returns

    Object itself

    Parameters

    • margin: number | Partial<MMargin>

      Number with pixel margins for all sides or datastructure with individual pixel margins for each side. Any side can be omitted, only passed values will be overridden.

    Returns ResultTable<BackgroundType>

setTextFont

setTextRotation

  • Set rotation of ResultTable label.

    Returns

    Object itself

    Parameters

    • value: number

      Rotation in degrees

    Returns ResultTable<BackgroundType>

Settings

Member Visibility

Theme