WebCola
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

Primitive

Primitive: number | string | boolean | Date

Administrivia: JavaScript primitive types and Date

ThresholdArrayGenerator

ThresholdArrayGenerator: function

Type definition for threshold generator which returns an array of recommended thresholds

Type declaration

    • (values: Value[], min?: Value, max?: Value): Value[]
    • Parameters

      • values: Value[]
      • Optional min: Value
      • Optional max: Value

      Returns Value[]

ThresholdCountGenerator

ThresholdCountGenerator: function

Type definition for threshold generator which returns the count of recommended thresholds

Type declaration

    • (values: number[], min?: number, max?: number): number
    • Parameters

      • values: number[]
      • Optional min: number
      • Optional max: number

      Returns number

Variables

bisect

bisect: bisectRight

Functions

ascending

  • Compares two primitive values for sorting (in ascending order).

    Parameters

    Returns number

bisectLeft

  • bisectLeft(array: number[], x: number, lo?: number, hi?: number): number
  • bisectLeft(array: string[], x: string, lo?: number, hi?: number): number
  • bisectLeft(array: Date[], x: Date, lo?: number, hi?: number): number
  • Parameters

    • array: number[]
    • x: number
    • Optional lo: number
    • Optional hi: number

    Returns number

  • Parameters

    • array: string[]
    • x: string
    • Optional lo: number
    • Optional hi: number

    Returns number

  • Parameters

    • array: Date[]
    • x: Date
    • Optional lo: number
    • Optional hi: number

    Returns number

bisectRight

  • bisectRight(array: number[], x: number, lo?: number, hi?: number): number
  • bisectRight(array: string[], x: string, lo?: number, hi?: number): number
  • bisectRight(array: Date[], x: Date, lo?: number, hi?: number): number
  • Parameters

    • array: number[]
    • x: number
    • Optional lo: number
    • Optional hi: number

    Returns number

  • Parameters

    • array: string[]
    • x: string
    • Optional lo: number
    • Optional hi: number

    Returns number

  • Parameters

    • array: Date[]
    • x: Date
    • Optional lo: number
    • Optional hi: number

    Returns number

bisector

  • bisector<T, U>(comparator: function): Bisector<T, U>
  • bisector<T, U>(accessor: function): Bisector<T, U>
  • Type parameters

    • T

    • U

    Parameters

    • comparator: function
        • (a: T, b: U): number
        • Parameters

          • a: T
          • b: U

          Returns number

    Returns Bisector<T, U>

  • Type parameters

    • T

    • U

    Parameters

    • accessor: function
        • (x: T): U
        • Parameters

          • x: T

          Returns U

    Returns Bisector<T, U>

descending

  • Compares two primitive values for sorting (in ascending order).

    Parameters

    Returns number

deviation

  • deviation<T>(array: Array<T | undefined | null>): number | undefined
  • deviation<T>(array: T[], accessor: function): number | undefined
  • Compute the standard deviation, defined as the square root of the bias-corrected variance, of the given array of numbers.

    Type parameters

    Parameters

    • array: Array<T | undefined | null>

    Returns number | undefined

  • Compute the standard deviation, defined as the square root of the bias-corrected variance, of the given array, using the given accessor to convert values to numbers.

    Type parameters

    • T

    Parameters

    • array: T[]
    • accessor: function
        • (datum: T, index: number, array: T[]): number | undefined | null
        • Parameters

          • datum: T
          • index: number
          • array: T[]

          Returns number | undefined | null

    Returns number | undefined

extent

  • extent(array: string[]): [string, string] | [undefined, undefined]
  • extent<T>(array: T[]): [T, T] | [undefined, undefined]
  • extent<T>(array: T[], accessor: function): [string, string] | [undefined, undefined]
  • extent<T, U>(array: T[], accessor: function): [U, U] | [undefined, undefined]
  • Return the min and max simultaneously.

    Parameters

    • array: string[]

    Returns [string, string] | [undefined, undefined]

  • Return the min and max simultaneously.

    Type parameters

    Parameters

    • array: T[]

    Returns [T, T] | [undefined, undefined]

  • Return the min and max simultaneously.

    Type parameters

    • T

    Parameters

    • array: T[]
    • accessor: function
        • (datum: T, index: number, array: T[]): string | undefined | null
        • Parameters

          • datum: T
          • index: number
          • array: T[]

          Returns string | undefined | null

    Returns [string, string] | [undefined, undefined]

  • Return the min and max simultaneously.

    Type parameters

    Parameters

    • array: T[]
    • accessor: function
        • (datum: T, index: number, array: T[]): U | undefined | null
        • Parameters

          • datum: T
          • index: number
          • array: T[]

          Returns U | undefined | null

    Returns [U, U] | [undefined, undefined]

histogram

  • Returns HistogramGenerator<number, number>

  • Type parameters

    • Datum

    • Value: number | Date

    Returns HistogramGenerator<Datum, Value>

max

  • max(array: string[]): string | undefined
  • max<T>(array: T[]): T | undefined
  • max<T>(array: T[], accessor: function): string | undefined
  • max<T, U>(array: T[], accessor: function): U | undefined
  • Return the maximum value in the array of strings using natural order.

    Parameters

    • array: string[]

    Returns string | undefined

  • Return the maximum value in the array of numbers using natural order.

    Type parameters

    Parameters

    • array: T[]

    Returns T | undefined

  • Return the maximum value in the array using natural order and a projection function to map values to strings.

    Type parameters

    • T

    Parameters

    • array: T[]
    • accessor: function
        • (datum: T, index: number, array: T[]): string | undefined | null
        • Parameters

          • datum: T
          • index: number
          • array: T[]

          Returns string | undefined | null

    Returns string | undefined

  • Return the maximum value in the array using natural order and a projection function to map values to easily-sorted values.

    Type parameters

    Parameters

    • array: T[]
    • accessor: function
        • (datum: T, index: number, array: T[]): U | undefined | null
        • Parameters

          • datum: T
          • index: number
          • array: T[]

          Returns U | undefined | null

    Returns U | undefined

mean

  • mean<T>(array: Array<T | undefined | null>): number | undefined
  • mean<T>(array: T[], accessor: function): number | undefined
  • Return the mean of an array of numbers

    Type parameters

    Parameters

    • array: Array<T | undefined | null>

    Returns number | undefined

  • Type parameters

    • T

    Parameters

    • array: T[]
    • accessor: function
        • (datum: T, index: number, array: T[]): number | undefined | null
        • Parameters

          • datum: T
          • index: number
          • array: T[]

          Returns number | undefined | null

    Returns number | undefined

median

  • median<T>(array: Array<T | undefined | null>): number | undefined
  • median<T>(array: T[], accessor: function): number | undefined
  • Return the median of an array of numbers

    Type parameters

    Parameters

    • array: Array<T | undefined | null>

    Returns number | undefined

  • Type parameters

    • T

    Parameters

    • array: T[]
    • accessor: function
        • (element: T, i: number, array: T[]): number | undefined | null
        • Parameters

          • element: T
          • i: number
          • array: T[]

          Returns number | undefined | null

    Returns number | undefined

merge

  • merge<T>(arrays: T[]): T[]
  • Merges the specified arrays into a single array.

    Type parameters

    • T

    Parameters

    • arrays: T[]

    Returns T[]

min

  • min(array: string[]): string | undefined
  • min<T>(array: T[]): T | undefined
  • min<T>(array: T[], accessor: function): string | undefined
  • min<T, U>(array: T[], accessor: function): U | undefined
  • Return the minimum value in the array using natural order.

    Parameters

    • array: string[]

    Returns string | undefined

  • Return the minimum value in the array using natural order.

    Type parameters

    Parameters

    • array: T[]

    Returns T | undefined

  • Return the minimum value in the array using natural order.

    Type parameters

    • T

    Parameters

    • array: T[]
    • accessor: function
        • (datum: T, index: number, array: T[]): string | undefined | null
        • Parameters

          • datum: T
          • index: number
          • array: T[]

          Returns string | undefined | null

    Returns string | undefined

  • Return the minimum value in the array using natural order.

    Type parameters

    Parameters

    • array: T[]
    • accessor: function
        • (datum: T, index: number, array: T[]): U | undefined | null
        • Parameters

          • datum: T
          • index: number
          • array: T[]

          Returns U | undefined | null

    Returns U | undefined

pairs

  • pairs<T>(array: T[]): Array<[T, T]>
  • For each adjacent pair of elements in the specified array, returns a new array of tuples of elements i and i - 1. Returns the empty array if the input array has fewer than two elements.

    Type parameters

    • T

    Parameters

    • array: T[]

    Returns Array<[T, T]>

permute

  • permute<T>(array: object, keys: number[]): T[]
  • permute<T>(object: object, keys: string[]): T[]
  • Given the specified array, return an array corresponding to the list of indices in 'keys'.

    Type parameters

    • T

    Parameters

    • array: object
      • [key: number]: T
    • keys: number[]

    Returns T[]

  • Given the specified object, return an array corresponding to the list of property names in 'keys'.

    Type parameters

    • T

    Parameters

    • object: object
      • [key: string]: T
    • keys: string[]

    Returns T[]

quantile

  • quantile<T>(array: Array<T | undefined | null>, p: number): number | undefined
  • quantile<T>(array: T[], p: number, accessor: function): number | undefined
  • Returns the p-quantile of an array of numbers

    Type parameters

    Parameters

    • array: Array<T | undefined | null>
    • p: number

    Returns number | undefined

  • Type parameters

    • T

    Parameters

    • array: T[]
    • p: number
    • accessor: function
        • (element: T, i: number, array: T[]): number | undefined | null
        • Parameters

          • element: T
          • i: number
          • array: T[]

          Returns number | undefined | null

    Returns number | undefined

range

  • range(stop: number): number[]
  • range(start: number, stop: number, step?: number): number[]
  • Generates a 0-based numeric sequence. The output range does not include 'stop'.

    Parameters

    • stop: number

    Returns number[]

  • Generates a numeric sequence starting from the given start and stop values. 'step' defaults to 1. The output range does not include 'stop'.

    Parameters

    • start: number
    • stop: number
    • Optional step: number

    Returns number[]

scan

  • scan(array: number[], comparator?: function): number | undefined
  • scan<T>(array: T[], comparator: function): number | undefined
  • Parameters

    • array: number[]
    • Optional comparator: function
        • (a: number, b: number): number
        • Parameters

          • a: number
          • b: number

          Returns number

    Returns number | undefined

  • Type parameters

    • T

    Parameters

    • array: T[]
    • comparator: function
        • (a: T, b: T): number
        • Parameters

          • a: T
          • b: T

          Returns number

    Returns number | undefined

shuffle

  • shuffle<T>(array: T[], lo?: number, hi?: number): T[]
  • Randomizes the order of the specified array using the Fisher–Yates shuffle.

    Type parameters

    • T

    Parameters

    • array: T[]
    • Optional lo: number
    • Optional hi: number

    Returns T[]

sum

  • sum<T>(array: Array<T | undefined | null>): number
  • sum<T>(array: T[], accessor: function): number
  • Compute the sum of an array of numbers.

    Type parameters

    Parameters

    • array: Array<T | undefined | null>

    Returns number

  • Compute the sum of an array, using the given accessor to convert values to numbers.

    Type parameters

    • T

    Parameters

    • array: T[]
    • accessor: function
        • (datum: T, index: number, array: T[]): number | undefined | null
        • Parameters

          • datum: T
          • index: number
          • array: T[]

          Returns number | undefined | null

    Returns number

thresholdFreedmanDiaconis

  • thresholdFreedmanDiaconis(values: number[], min: number, max: number): number
  • Parameters

    • values: number[]
    • min: number
    • max: number

    Returns number

thresholdScott

  • thresholdScott(values: number[], min: number, max: number): number
  • Parameters

    • values: number[]
    • min: number
    • max: number

    Returns number

thresholdSturges

  • thresholdSturges(values: number[]): number
  • Parameters

    • values: number[]

    Returns number

tickStep

  • tickStep(start: number, stop: number, count: number): number[]
  • Generate an array of with the differences between adjecent ticks, had the same arguments been passed to ticks(start, stop, count)

    Parameters

    • start: number
    • stop: number
    • count: number

    Returns number[]

ticks

  • ticks(start: number, stop: number, count: number): number[]
  • Generate an array of approximately count + 1 uniformly-spaced, nicely-rounded values between start and stop (inclusive).

    Parameters

    • start: number
    • stop: number
    • count: number

    Returns number[]

transpose

  • transpose<T>(matrix: T[]): T[]
  • Transpose a matrix provided in Array of Arrays format.

    Type parameters

    • T

    Parameters

    • matrix: T[]

    Returns T[]

variance

  • variance<T>(array: Array<T | undefined | null>): number | undefined
  • variance<T>(array: T[], accessor: function): number | undefined
  • Compute an unbiased estimator of the population variance of the given array of numbers.

    Type parameters

    Parameters

    • array: Array<T | undefined | null>

    Returns number | undefined

  • Compute an unbiased estimator of the population variance of the given array, using the given accessor to convert values to numbers.

    Type parameters

    • T

    Parameters

    • array: T[]
    • accessor: function
        • (datum: T, index: number, array: T[]): number | undefined | null
        • Parameters

          • datum: T
          • index: number
          • array: T[]

          Returns number | undefined | null

    Returns number | undefined

zip

  • zip<T>(...arrays: T[]): T[]
  • Returns an array of arrays, where the ith array contains the ith element from each of the argument arrays. The returned array is truncated in length to the shortest array in arrays. If arrays contains only a single array, the returned array contains one-element arrays. With no arguments, the returned array is empty.

    Type parameters

    • T

    Parameters

    • Rest ...arrays: T[]

    Returns T[]

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc