Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface INumericStats<T>

Type Parameters

  • T

Hierarchy

Index

Properties

Methods

Properties

Readonly count

count: number

number of items in the array

Readonly depth

depth: number

in case of nested arrays what is the max nested depth

Readonly flatCount

flatCount: number

number of items in the array

Readonly flatItems

flatItems: readonly T[]

the items in this stats

Readonly flatMissing

flatMissing: number

number of missing items in the array

Readonly hist

hist: readonly Readonly<IBin<T>>[]

histogram

Readonly items

items: readonly (T | Set<T> | (readonly T[]))[]

the items in this stats

Readonly max

max: T

maximum value in the array

Readonly maxBin

maxBin: IBin<T>

maximal items in a bin

Readonly median

median: T

median value in the array

Readonly min

min: T

minimal value in the array

Readonly missing

missing: number

number of missing items in the array

Methods

[toPrimitive]

  • [toPrimitive](hint: "default"): string
  • [toPrimitive](hint: "string"): string
  • [toPrimitive](hint: "number"): number
  • [toPrimitive](hint: string): string | number

  • Converts a Stats object to a string.

    Parameters

    • hint: "default"

    Returns string

  • Converts a Stats object to a string.

    Parameters

    • hint: "string"

    Returns string

  • Converts a Stats object to a number.

    Parameters

    • hint: "number"

    Returns number

  • Converts a Stats object to a string or number.

    throws

    {TypeError} If 'hint' was given something other than "number", "string", or "default".

    Parameters

    • hint: string

      The strings "number", "string", or "default" to specify what primitive to return.

    Returns string | number

    A number if 'hint' was "number", a string if 'hint' was "string" or "default".

color

  • color(v: T): string

  • converts a given (normalized) value to a color

    Parameters

    • v: T

    Returns string

format

  • format(v: T): string

  • converts the given value to a label

    Parameters

    • v: T

    Returns string

invert

  • invert(v: number): T

  • invert operation given a number between 0 and 1 convert it back

    Parameters

    • v: number

    Returns T

scale

  • scale(v: T): number

  • converts the given value to a value between 0 and 1

    Parameters

    • v: T

    Returns number

Generated using TypeDoc