Type alias PolarHeatmapSeriesFormatter

Type declaration

• • <T>(tableContentBuilder: T, series: PolarHeatmapSeries, dataPoint: {
        amplitude: number;
        angleDeg: number;
        iAnnulus: number;
        iSector: number;
        intensity: number;
    }, formatAmplitude: ((amplitude: number) => string)): T

  • Interface for a function which builds ResultTable content when pointing at a PolarHeatmapSeries.

     // Example
     PolarHeatmapSeries.setCursorResultTableFormatter((builder, series, dataPoint, formatAmplitude) => builder
         .addRow(series.getName())
         .addRow('Angle:', '', `${dataPoint.angleDeg.toFixed(0)}`)
         .addRow('Intensity:', '', `${dataPoint.intensity.toFixed(1)}`)
     )
    

    Returns

    TableContentBuilder that was supplied

    Type Parameters

    • T extends TableContentBuilder

    Parameters

    • tableContentBuilder: T

      Builder that is used to build contents of ResultTable. Use addRow() method for adding content.

    • series: PolarHeatmapSeries

      PolarSeries

    • dataPoint: {
          amplitude: number;
          angleDeg: number;
          iAnnulus: number;
          iSector: number;
          intensity: number;
      }

      Pointed data point.

      • amplitude: number

      • angleDeg: number

      • iAnnulus: number

      • iSector: number

      • intensity: number

    • formatAmplitude: ((amplitude: number) => string)

      Formatting function for similar formatting as Charts Amplitude Axis.

      • • (amplitude: number): string

        • Parameters

          • amplitude: number

          Returns string

    Returns T