Class RankingBuilder

builder for a ranking

Constructors

Methods

  • specify another grouping sorting criteria

    Parameters

    • column: string

      the column name optionally with encoded sorting separated by colon, e.g. a:desc

    • asc: boolean | "desc" | "asc" = true

      ascending or descending order

    Returns RankingBuilder

  • add an imposed column (numerical column colored by categorical column) to this ranking

    Parameters

    • label: string

      optional label

    • numberColumn: string

      numerical column reference

    • colorColumn: string

      categorical column reference

    Returns RankingBuilder

  • add a nested / group composite column

    Parameters

    • label: string

      optional label

    • column: string

      first element of the group enforcing not empty ones

    • Rest ...columns: string[]

      additional columns

    Returns RankingBuilder

  • add reducing column (min, max, median, mean, ...)

    Parameters

    • label: string

      optional label

    • operation: EAdvancedSortMethod

      operation to apply (min, max, median, mean, ...)

    • numberColumn1: string

      first numerical column

    • numberColumn2: string

      second numerical column

    • Rest ...numberColumns: string[]

      additional numerical columns

    Returns RankingBuilder

  • add a scripted / formula column

    Parameters

    • label: string

      optional label

    • code: string

      the JS code see ScriptColumn for details

    • Rest ...numberColumns: string[]

      additional script columns

    Returns RankingBuilder

  • specify another sorting criteria

    Parameters

    • column: string

      the column name optionally with encoded sorting separated by colon, e.g. a:desc

    • asc: boolean | "desc" | "asc" = true

      ascending or descending order

    Returns RankingBuilder

  • add a weighted sum / stack column

    Parameters

    • label: string

      optional label

    • numberColumn1: string

      the first numerical column

    • weight1: number

      its weight (0..1)

    • numberColumn2: string

      the second numerical column

    • weight2: number

      its weight (0..1)

    • Rest ...numberColumnAndWeights: (string | number)[]

      alternating column weight references

    Returns RankingBuilder