Options
All
  • Public
  • Public/Protected
  • All
Menu

Pivot

Index

Interfaces

Type aliases

Functions

Type aliases

Criteria

Criteria<TRow>: Criterion<TRow>[]

The set of critera to used for a point on a dimension.

Type parameters

Cube

Cube<TRow>: Table<TRow>[][]

A cube of data.

Type parameters

Dimension

Dimension<TRow>: Criteria<TRow>[]

An dimension to pivot a table by.

Type parameters

Func1

Func1<TArg1, TResult>: (arg: TArg1) => TResult

A function taking one argument and returning a result.

Type parameters

  • TArg1

  • TResult

Type declaration

    • (arg: TArg1): TResult

    • Parameters

      • arg: TArg1

      Returns TResult

Func2

Func2<TArg1, TArg2, TResult>: (arg1: TArg1, arg2: TArg2) => TResult

A function taking two arguments and returning a result.

Type parameters

  • TArg1

  • TArg2

  • TResult

Type declaration

    • (arg1: TArg1, arg2: TArg2): TResult

    • Parameters

      • arg1: TArg1
      • arg2: TArg2

      Returns TResult

Key

Key: Exclude<keyof Value, symbol>

The type of keys used to reference values in data structures.

Predicate

Predicate<TArg>: Func1<TArg, boolean>

A function taking one argument and returning a boolean result.

Type parameters

  • TArg

Row

Row: Record<Key, Value>

A set of attributes in a row of a table, each addressable via a key.

Table

Table<TRow>: TRow[]

A table of data.

Type parameters

Value

Value: any

The type of values used in source data structures.

Functions

average

  • average<TRow>(selector: Func1<TRow, number>): Func1<Table<TRow>, number | null>

  • A generator, to create a function to pass into query that averages numerical values derived from rows in a cube .

    Type parameters

    Parameters

    • selector: Func1<TRow, number>

      A callback function to derive a numerical value for each row.

    Returns Func1<Table<TRow>, number | null>

count

  • count<TRow>(table: Table<TRow>): number | null

  • Counts the number of items in a table.

    Type parameters

    Parameters

    • table: Table<TRow>

      The source table.

    Returns number | null

cube

  • Pivots a table by two axes

    Type parameters

    Parameters

    • table: Table<TRow>

      The source data, an array of rows.

    • axes: Axes<TRow>

      The dimensions to use for the x and y axes.

    Returns Cube<TRow>

deriveDimension

  • Creates a derived dimension based on the contents of column in a table.

    Type parameters

    Parameters

    • table: Table<TRow>

      The source table, an array of objects.

    • key: Key

      The name to give this dimension.

    • options: Options<TRow> = {}

      An optional structure, containing two configuration parameters: get, a callback function used to convert values in the source table to those in the dimension when pivoting; sort, a method used to sort the values in the axis.

    Returns Dimension<TRow>

dimension

  • Creates a dimension from an array of values.

    Type parameters

    Parameters

    • values: Value[]

      The source values.

    • key: Key

      The name to give this dimension.

    • get: Func1<TRow, Value> = ...

      An optional callback function used to convert values in the source table to those in the dimension when pivoting.

    Returns Dimension<TRow>

filter

  • Filters data within a cube.

    Type parameters

    Parameters

    • cube: Cube<TRow>

      The source cube.

    • predicate: Predicate<TRow>

      A predicate to filter the cube by.

    Returns Cube<TRow>

join

  • Create a composite dimension from others. This creates a cartesian product of the source dimensions criteria.

    Type parameters

    Parameters

    • Rest ...dimensions: Dimension<TRow>[]

      An array of dimensions to combine into one.

    Returns Dimension<TRow>

map

  • map<TRow, TResult>(cube: Cube<TRow>, selector: Func1<Table<TRow>, TResult>): TResult[][]

  • Queries data from a cube.

    Type parameters

    • TRow: Row

    • TResult

    Parameters

    • cube: Cube<TRow>

      The source cube.

    • selector: Func1<Table<TRow>, TResult>

      A callback function to create a result from each cell of the cube.

    Returns TResult[][]

select

  • select<TRow, TResult>(selector: Func1<TRow, TResult>): Func1<Table<TRow>, TResult[]>

  • A generator, used to transform the source data in a cube to another representation.

    Type parameters

    • TRow: Row

    • TResult

    Parameters

    • selector: Func1<TRow, TResult>

      A function to transform a source record into the desired result.

    Returns Func1<Table<TRow>, TResult[]>

sum

  • sum<TRow>(selector: Func1<TRow, number>): Func1<Table<TRow>, number | null>

  • A generator, to create a function to pass into query that sums numerical values derived from rows in a cube.

    Type parameters

    Parameters

    • selector: Func1<TRow, number>

      A callback function to derive a numerical value for each row.

    Returns Func1<Table<TRow>, number | null>

Generated using TypeDoc