Options
All
  • Public
  • Public/Protected
  • All
Menu

SeriesInfo is a data-structure which provides enriched information about a hit-test operation. It's derived by calling {@link BaseRenderableSeries.hitTestProvider.hitTest} (returns HitTestInfo) and then enriched by calling BaseRenderableSeries.getSeriesInfo. There is a class hierachy for SeriesInfo which is a different class depending on series type, e.g. line, mountain, scatter series has XySeriesInfo, heatmap series as HeatmapSeriesInfo etc.

Hierarchy

Index

Constructors

constructor

Properties

dataSeriesIndex

dataSeriesIndex: number

dataSeriesType

dataSeriesType: EDataSeriesType

Gets the EDataSeriesType of the DataSeries which is the result of the hit-test operation

distance

distance: number

fill

fill: string

hitTestInfo

hitTestInfo: HitTestInfo

hitTestPointValues

hitTestPointValues: Point

isHit

isHit: boolean

isWithinDataBounds

isWithinDataBounds: boolean

When true the hit-test operation was within the first and the last DataSeries X-values

point2metadata

point2metadata: unknown

point2xCoordinate

point2xCoordinate: number

point2xValue

point2xValue: number

point2yCoordinate

point2yCoordinate: number

point2yValue

point2yValue: number

pointMetadata

pointMetadata: unknown

Readonly renderableSeries

renderableSeries: IRenderableSeries

Gets the associated RenderableSeries that this SeriesInfo was generated by

seriesName

seriesName: string

Gets the name of the DataSeries which is the result of the hit-test operation

stroke

stroke: string

xCoordinate

xCoordinate: number

xValue

xValue: number

yCoordinate

yCoordinate: number

yValue

yValue: number

Accessors

formattedXValue

  • get formattedXValue(): string
  • Returns string

formattedYValue

  • get formattedYValue(): string
  • Returns string

isVisible

  • get isVisible(): boolean
  • Returns boolean

Methods

Protected concatTwoValuesWithLabels

  • concatTwoValuesWithLabels(xValue: string, yValue: string, xLabel: string, yLabel: string): string
  • Parameters

    • xValue: string
    • yValue: string
    • xLabel: string
    • yLabel: string

    Returns string

Protected concatValueWithLabel

  • concatValueWithLabel(value: string, label: string): string
  • Parameters

    • value: string
    • label: string

    Returns string

equals

  • Parameters

    Returns boolean

getValuesWithLabels

  • getValuesWithLabels(title: string | undefined, xLabel: string, yLabel: string, isXYGrouped: boolean): string[]
  • Parameters

    • title: string | undefined
    • xLabel: string
    • yLabel: string
    • isXYGrouped: boolean

    Returns string[]

getXCursorFormattedValue

  • getXCursorFormattedValue(value: number): string
  • Parameters

    • value: number

    Returns string

getYCursorFormattedValue

  • getYCursorFormattedValue(value: number): string
  • Parameters

    • value: number

    Returns string

Generated using TypeDoc