Interface ContourDensity<Datum>

A contour generator for density estimates.

The generic refers to the data type of an element in the data array used with the density contour generator. If omitted, the default setting assumes that, the elements of the data array used with the density contour generator are two-element arrays. The first element corresponds to the x-dimension, the second to the y-dimension.

interface ContourDensity {
    bandwidth(): number;
    bandwidth(bandwidth): ContourDensity<Datum>;
    cellSize(): number;
    cellSize(cellSize): ContourDensity<Datum>;
    size(): [number, number];
    size(size): ContourDensity<Datum>;
    thresholds(): ThresholdCountGenerator<number> | ThresholdNumberArrayGenerator<number>;
    thresholds(thresholds): ContourDensity<Datum>;
    weight(): ((d) => number);
    weight(weight): ContourDensity<Datum>;
    x(): ((d) => number);
    x(x): ContourDensity<Datum>;
    y(): ((d) => number);
    y(y): ContourDensity<Datum>;
    (data): ContourMultiPolygon[];
}

Type Parameters

  • Datum = [number, number]

  • Estimates the density contours for the given array of data, returning an array of GeoJSON MultiPolygon geometry objects. Each geometry object represents the area where the estimated number of points per square pixel is greater than or equal to the corresponding threshold value; the threshold value for each geometry object is exposed as geometry.value. The returned geometry objects are typically passed to d3.geoPath to display, using null or d3.geoIdentity as the associated projection. See also d3.contours.

    The x- and y-coordinate for each data point are computed using density.x and density.y. The generated contours are only accurate within the estimator’s defined size.

    Parameters

    • data: Datum[]

      Array of input data.

    Returns ContourMultiPolygon[]

Methods

  • Returns the current bandwidth, which defaults to 20.4939….

    Returns number

  • Sets the bandwidth (the standard deviation) of the Gaussian kernel and returns the density contour estimator.

    Parameters

    • bandwidth: number

      Bandwidth (the standard deviation) of the Gaussian kernel. The specified bandwidth is currently rounded to the nearest supported value by this implementation, and must be nonnegative.

    Returns ContourDensity<Datum>

  • Returns the current cell size, which defaults to 4.

    Returns number

  • Sets the size of individual cells in the underlying bin grid to the specified positive integer and returns the density contour estimator.

    The cell size is rounded down to the nearest power of two. Smaller cells produce more detailed contour polygons, but are more expensive to compute.

    Parameters

    • cellSize: number

      Cell size, a positive integer.

    Returns ContourDensity<Datum>

  • Returns the current size, which defaults to [960, 500].

    Returns [number, number]

  • Sets the size of the density estimator to the specified bounds and returns the density contour estimator.

    Parameters

    • size: [number, number]

      The size is specified as an array [width, height], where width is the maximum x-value and height is the maximum y-value.

    Returns ContourDensity<Datum>

  • Returns the current threshold generator, which by default generates about twenty nicely-rounded density thresholds.

    Returns ThresholdCountGenerator<number> | ThresholdNumberArrayGenerator<number>

  • Sets the threshold generator to the specified function or array and returns this contour generator. Thresholds are defined as an array of values [x0, x1, …]. The first generated density contour corresponds to the area where the estimated density is greater than or equal to x0; the second contour corresponds to the area where the estimated density is greater than or equal to x1, and so on. Thus, there is exactly one generated MultiPolygon geometry object for each specified threshold value; the threshold value is exposed as geometry.value. The first value x0 should typically be greater than zero. If a count is specified instead of an array of thresholds, then approximately count uniformly-spaced nicely-rounded thresholds will be generated; see d3.ticks.

    Parameters

    Returns ContourDensity<Datum>

  • Returns the current point weight accessor.

    Returns ((d) => number)

      • (d): number
      • Returns the current point weight accessor.

        Parameters

        • d: Datum

        Returns number

  • Sets the point weight accessor and returns the density contour estimator.

    Parameters

    • weight: ((d) => number)

      A point weight accessor function.

        • (d): number
        • Parameters

          • d: Datum

          Returns number

    Returns ContourDensity<Datum>

  • Returns the current x-coordinate accessor. The default x-coordinate accessor is a functions which accepts as input a two-element array of numbers and returns the element at index 0.

    Returns ((d) => number)

      • (d): number
      • Returns the current x-coordinate accessor. The default x-coordinate accessor is a functions which accepts as input a two-element array of numbers and returns the element at index 0.

        Parameters

        • d: Datum

        Returns number

  • Sets the x-coordinate accessor and returns the density contour estimator.

    Parameters

    • x: ((d) => number)

      An x-coordinate accessor function, which accepts as input an element of the input data array and returns the x-coordinate.

        • (d): number
        • Parameters

          • d: Datum

          Returns number

    Returns ContourDensity<Datum>

  • Returns the current y-coordinate accessor. The default y-coordinate accessor is a functions which accepts as input a two-element array of numbers and returns the element at index 1.

    Returns ((d) => number)

      • (d): number
      • Returns the current y-coordinate accessor. The default y-coordinate accessor is a functions which accepts as input a two-element array of numbers and returns the element at index 1.

        Parameters

        • d: Datum

        Returns number

  • Sets the y-coordinate accessor and returns the density contour estimator.

    Parameters

    • y: ((d) => number)

      An y-coordinate accessor function, which accepts as input an element of the input data array and returns the y-coordinate.

        • (d): number
        • Parameters

          • d: Datum

          Returns number

    Returns ContourDensity<Datum>