Class LiveAggregation<S, Out>

constructor

• new LiveAggregation<
      S extends SeriesSchema,
      Out extends SeriesSchema = SeriesSchema,
  >(
      source: LiveSource<S>,
      sequence: Sequence,
      mapping: AggregateMap<S>,
      options?: LiveAggregationOptions,
  ): LiveAggregation<S, Out>

  Type Parameters

  • S extends SeriesSchema
  • Out extends SeriesSchema = SeriesSchema

  Parameters

  • source: LiveSource<S>
  • sequence: Sequence
  • mapping: AggregateMap<S>
  • Optionaloptions: LiveAggregationOptions

  Returns LiveAggregation<S, Out>

Readonlyname

Readonlyschema

closedCount

• get closedCount(): number

  Returns number

hasOpenBucket

• get hasOpenBucket(): boolean

  Returns boolean

length

• get length(): number

  Returns number

at

• at(index: number): EventForSchema<Out> | undefined

  Parameters

  • index: number

  Returns EventForSchema<Out> | undefined

closed

• closed(): TimeSeries<Out>

  Returns TimeSeries<Out>

cumulative

• cumulative<const Targets extends string>(
      spec: {
          [K in string]:
              | "sum"
              | "count"
              | "min"
              | "max"
              | ((acc: number, value: number) => number)
      },
  ): LiveView<
      readonly [
          Out[0],
          ReplaceSmoothedColumn<ValueColumnsForSchema<Out>, Targets>,
      ],
  >

  Type Parameters

  • const Targets extends string

  Parameters

  • spec: {
        [K in string]:
            | "sum"
            | "count"
            | "min"
            | "max"
            | ((acc: number, value: number) => number)
    }

  Returns LiveView<
      readonly [
          Out[0],
          ReplaceSmoothedColumn<ValueColumnsForSchema<Out>, Targets>,
      ],
  >

diff

• diff<const Target extends string>(
      columns: Target | readonly Target[],
      options?: { drop?: boolean },
  ): LiveView<
      readonly [
          Out[0],
          ReplaceSmoothedColumn<ValueColumnsForSchema<Out>, Target>,
      ],
  >

  Type Parameters

  • const Target extends string

  Parameters

  • columns: Target | readonly Target[]
  • Optionaloptions: { drop?: boolean }

  Returns LiveView<
      readonly [
          Out[0],
          ReplaceSmoothedColumn<ValueColumnsForSchema<Out>, Target>,
      ],
  >

dispose

• dispose(): void

  Returns void

fill

• fill(
      strategy: LiveFillStrategy | LiveFillMapping<Out>,
      options?: { limit?: number },
  ): LiveView<Out>

  Parameters

  • strategy: LiveFillStrategy | LiveFillMapping<Out>
  • Optionaloptions: { limit?: number }

  Returns LiveView<Out>

filter

• filter(predicate: (event: EventForSchema<Out>) => boolean): LiveView<Out>

  Parameters

  • predicate: (event: EventForSchema<Out>) => boolean

  Returns LiveView<Out>

map

• map(fn: (event: EventForSchema<Out>) => EventForSchema<Out>): LiveView<Out>

  Parameters

  • fn: (event: EventForSchema<Out>) => EventForSchema<Out>

  Returns LiveView<Out>

on

• on(type: "event", fn: CloseListener): () => void

  Parameters

  • type: "event"
  • fn: CloseListener

  Returns () => void

• on(type: "bucket", fn: BucketListener): this

  Parameters

  • type: "bucket"
  • fn: BucketListener

  Returns this

• on(type: "close", fn: CloseListener): this

  Parameters

  • type: "close"
  • fn: CloseListener

  Returns this

• on(type: "update", fn: UpdateListener): this

  Parameters

  • type: "update"
  • fn: UpdateListener

  Returns this

pctChange

• pctChange<const Target extends string>(
      columns: Target | readonly Target[],
      options?: { drop?: boolean },
  ): LiveView<
      readonly [
          Out[0],
          ReplaceSmoothedColumn<ValueColumnsForSchema<Out>, Target>,
      ],
  >

  Type Parameters

  • const Target extends string

  Parameters

  • columns: Target | readonly Target[]
  • Optionaloptions: { drop?: boolean }

  Returns LiveView<
      readonly [
          Out[0],
          ReplaceSmoothedColumn<ValueColumnsForSchema<Out>, Target>,
      ],
  >

rate

• rate<const Target extends string>(
      columns: Target | readonly Target[],
      options?: { drop?: boolean },
  ): LiveView<
      readonly [
          Out[0],
          ReplaceSmoothedColumn<ValueColumnsForSchema<Out>, Target>,
      ],
  >

  Type Parameters

  • const Target extends string

  Parameters

  • columns: Target | readonly Target[]
  • Optionaloptions: { drop?: boolean }

  Returns LiveView<
      readonly [
          Out[0],
          ReplaceSmoothedColumn<ValueColumnsForSchema<Out>, Target>,
      ],
  >

rolling

• rolling(
      windowSize: RollingWindow,
      mapping: AggregateMap<Out>,
  ): LiveRollingAggregation<Out>

  Parameters

  • windowSize: RollingWindow
  • mapping: AggregateMap<Out>

  Returns LiveRollingAggregation<Out>

select

• select<const Keys extends readonly (keyof EventDataForSchema<Out>)[]>(
      ...keys: Keys,
  ): LiveView<
      readonly [
          Out[0],
          PickSelectedColumns<ValueColumnsForSchema<Out>, Keys[number]>,
      ],
  >

  Type Parameters

  • const Keys extends readonly (keyof EventDataForSchema<Out>)[]

  Parameters

  • ...keys: Keys

  Returns LiveView<
      readonly [
          Out[0],
          PickSelectedColumns<ValueColumnsForSchema<Out>, Keys[number]>,
      ],
  >

snapshot

• snapshot(): TimeSeries<Out>

  Returns TimeSeries<Out>

window

• window(size: RollingWindow): LiveView<Out>

  Parameters

  • size: RollingWindow

  Returns LiveView<Out>