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

Type parameters

  • Datum

  • Value: number | Date

Hierarchy

  • HistogramGenerator

Callable

  • __call(data: Datum[]): Array<Bin<Datum, Value>>
  • Parameters

    • data: Datum[]

    Returns Array<Bin<Datum, Value>>

Index

Methods

domain

  • domain(): function
  • domain(domain: [Value, Value])
  • domain(domainAccessor: function)
  • Returns function

      • (values: Value[]): [Value, Value]
      • Parameters

        • values: Value[]

        Returns [Value, Value]

  • Parameters

    • domain: [Value, Value]
  • Parameters

    • domainAccessor: function
        • (values: Value[]): [Value, Value]
        • Parameters

          • values: Value[]

          Returns [Value, Value]

thresholds

  • Returns ThresholdCountGenerator | ThresholdArrayGenerator

  • Divide the domain uniformly into approximately count bins. IMPORTANT: This threshold setting approach only works, when the materialized values are numbers!

    Parameters

    • count: number

      The desired number of uniform bins.

  • Set a threshold accessor function, which returns the desired number of bins. Divides the domain uniformly into approximately count bins. IMPORTANT: This threshold setting approach only works, when the materialized values are numbers!

    Parameters

    • count: ThresholdCountGenerator

      A function which accepts as arguments the array of materialized values, and optionally the domain minimum and maximum. The function calcutates and returns the suggested number of bins.

  • Set the array of values to be used as thresholds in determining the bins.

    Parameters

    • thresholds: Value[]

      Array of threshold values used for binning. The elements must be of the same type as the materialized values of the histogram.

  • Set a threshold accessor function, which returns the array of values to be used as thresholds in determining the bins.

    Parameters

    • thresholds: ThresholdArrayGenerator

      A function which accepts as arguments the array of materialized values, and optionally the domain minimum and maximum. The function calcutates and returns the array of values to be used as thresholds in determining the bins.

value

  • value(): function
  • value(valueAccessor: function)
  • Returns function

      • (d: Datum, i: number, data: Datum[]): Value
      • Parameters

        • d: Datum
        • i: number
        • data: Datum[]

        Returns Value

  • Parameters

    • valueAccessor: function
        • (d: Datum, i: number, data: Datum[]): Value
        • Parameters

          • d: Datum
          • i: number
          • data: Datum[]

          Returns Value

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