@deephaven/jsapi-types
    Preparing search index...

    Interface FigureDataUpdatedEvent

    Event detail for a figure data update.

    Provides access to the updated data for one or more related series.

    interface FigureDataUpdatedEvent {
        get series(): Series[];
        getArray(
            series: Series,
            sourceType: number,
            mappingFunc?: (arg0: any) => any,
        ): any[];
    }
    Index
    • get series(): Series[]

      The series related to this update.

      Returns Series[]

    • Gets a contiguous JS array of values for the given series and data source type.

      If provided, mappingFunc is applied to each value. To re-use cached data across calls, use the same mappingFunc instance each time.

      Parameters

      • series: Series

        the series to read data for

      • sourceType: number

        the data source type, as defined by the series descriptor

      • OptionalmappingFunc: (arg0: any) => any

        an optional mapping function applied to each value; null returns the raw values

      Returns any[]

      a contiguous JS array of values