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

Index

Variables

curveBasis

curveBasis: CurveFactory

A curve factory for cubic basis spline generators.

The curve generators produce a cubic basis spline using the specified control points. The first and last points are triplicated such that the spline starts at the first point and ends at the last point, and is tangent to the line between the first and second points, and to the line between the penultimate and last points.

curveBasisClosed

curveBasisClosed: CurveFactory

A curve factory for closed cubic basis spline generators.

The curve generators produce a closed cubic basis spline using the specified control points. When a line segment ends, the first three control points are repeated, producing a closed loop with C2 continuity.

curveBasisOpen

curveBasisOpen: CurveFactory

A curve factory for open cubic basis spline generators.

The curve generators produce a cubic basis spline using the specified control points. Unlike basis, the first and last points are not repeated, and thus the curve typically does not intersect these points.

curveBundle

curveBundle: CurveBundleFactory

A curve factory for straightened cubic basis spline generators.

The curve generators produce a straightened cubic basis spline using the specified control points, with the spline straightened according to the curve’s beta, which defaults to 0.85. This curve is typically used in hierarchical edge bundling to disambiguate connections, as proposed by Danny Holten in Hierarchical Edge Bundles: Visualization of Adjacency Relations in Hierarchical Data.

This curve does not implement curve.areaStart and curve.areaEnd; it is intended to work with d3.line, not d3.area.

curveCardinal

curveCardinal: CurveCardinalFactory

A curve factory for cubic cardinal spline generators.

The curve generators produce a cubic cardinal spline using the specified control points, with one-sided differences used for the first and last piece. The default tension is 0.

curveCardinalClosed

curveCardinalClosed: CurveCardinalFactory

A curve factory for closed cubic cardinal spline generators.

The curve generators produce closed cubic cardinal spline using the specified control points. When a line segment ends, the first three control points are repeated, producing a closed loop. The default tension is 0.

curveCardinalOpen

curveCardinalOpen: CurveCardinalFactory

A curve factory for open cubic cardinal spline generators.

The curve generators produce a cubic cardinal spline using the specified control points. Unlike curveCardinal, one-sided differences are not used for the first and last piece, and thus the curve starts at the second point and ends at the penultimate point. The default tension is 0.

curveCatmullRom

curveCatmullRom: CurveCatmullRomFactory

A curve factory for cubic Catmull–Rom spline generators.

The curve generators produce a cubic Catmull–Rom spline using the specified control points and the parameter alpha, which defaults to 0.5, as proposed by Yuksel et al. in On the Parameterization of Catmull–Rom Curves, with one-sided differences used for the first and last piece.

curveCatmullRomClosed

curveCatmullRomClosed: CurveCatmullRomFactory

A curve factory for cubic Catmull–Rom spline generators.

The curve generators produce a closed cubic Catmull–Rom spline using the specified control points and the parameter alpha, which defaults to 0.5, as proposed by Yuksel et al. When a line segment ends, the first three control points are repeated, producing a closed loop.

curveCatmullRomOpen

curveCatmullRomOpen: CurveCatmullRomFactory

A curve factory for cubic Catmull–Rom spline generators.

The curve generators produce a cubic Catmull–Rom spline using the specified control points and the parameter alpha, which defaults to 0.5, as proposed by Yuksel et al. Unlike curveCatmullRom, one-sided differences are not used for the first and last piece, and thus the curve starts at the second point and ends at the penultimate point.

curveLinear

curveLinear: CurveFactory

A curve factory for polyline generators.

The curve generators produce a polyline through the specified points.

curveLinearClosed

curveLinearClosed: CurveFactory

A curve factory for closed polyline generators.

The curve generators produce a closed polyline through the specified points by repeating the first point when the line segment ends.

curveMonotoneX

curveMonotoneX: CurveFactory

A curve factory for cubic spline generators preserving monotonicity in y.

The curve generators produce a cubic spline that preserves monotonicity in y, assuming monotonicity in x, as proposed by Steffen in A simple method for monotonic interpolation in one dimension: “a smooth curve with continuous first-order derivatives that passes through any given set of data points without spurious oscillations. Local extrema can occur only at grid points where they are given by the data, but not in between two adjacent grid points.”

curveMonotoneY

curveMonotoneY: CurveFactory

A curve factory for cubic spline generators preserving monotonicity in x.

The curve generators produce a cubic spline that preserves monotonicity in x, assuming monotonicity in y, as proposed by Steffen in A simple method for monotonic interpolation in one dimension: “a smooth curve with continuous first-order derivatives that passes through any given set of data points without spurious oscillations. Local extrema can occur only at grid points where they are given by the data, but not in between two adjacent grid points.”

curveNatural

curveNatural: CurveFactory

A curve factory for natural cubic spline generators.

The curve generators produce a natural cubic spline with the second derivative of the spline set to zero at the endpoints.

curveStep

curveStep: CurveFactory

A curve factory for step function (midpoint) generators.

The curve generators produce a piecewise constant function (a step function) consisting of alternating horizontal and vertical lines. The y-value changes at the midpoint of each pair of adjacent x-values.

curveStepAfter

curveStepAfter: CurveFactory

A curve factory for step function (after) generators.

The curve generators produce a piecewise constant function (a step function) consisting of alternating horizontal and vertical lines. The y-value changes after the x-value.

curveStepBefore

curveStepBefore: CurveFactory

A curve factory for step function (before) generators.

The curve generators produce a piecewise constant function (a step function) consisting of alternating horizontal and vertical lines. The y-value changes before the x-value.

symbolCircle

symbolCircle: SymbolType

The circle symbol type.

symbolCross

symbolCross: SymbolType

The Greek cross symbol type, with arms of equal length.

symbolDiamond

symbolDiamond: SymbolType

The rhombus symbol type.

symbolSquare

symbolSquare: SymbolType

The square symbol type.

symbolStar

symbolStar: SymbolType

The pentagonal star (pentagram) symbol type.

symbolTriangle

symbolTriangle: SymbolType

he up-pointing triangle symbol type.

symbolWye

symbolWye: SymbolType

The Y-shape symbol type.

symbols

symbols: SymbolType[]

An array containing the set of all built-in symbol types: circle, cross, diamond, square, star, triangle, and wye. Useful for constructing the range of an ordinal scale should you wish to use a shape encoding for categorical data.

Functions

arc

  • Constructs a new arc generator with the default settings.

    Ensure that the accessors used with the arc generator correspond to the arguments passed into them, or set them to constants as appropriate.

    Returns Arc<any, DefaultArcObject>

  • Constructs a new arc generator with the default settings.

    Ensure that the accessors used with the arc generator correspond to the arguments passed into them, or set them to constants as appropriate.

    The generic corresponds to the datum type representing a arc.

    Type parameters

    • Datum

    Returns Arc<any, Datum>

  • Constructs a new arc generator with the default settings.

    Ensure that the accessors used with the arc generator correspond to the arguments passed into them, or set them to constants as appropriate.

    The first generic corresponds to the type of the "this" context within which the arc generator and its accessor functions will be invoked.

    The second generic corresponds to the datum type representing a arc.

    Type parameters

    • This

    • Datum

    Returns Arc<This, Datum>

area

  • area(): Area<[number, number]>
  • area<Datum>(): Area<Datum>
  • Constructs a new area generator with the default settings.

    Ensure that the accessors used with the area generator correspond to the arguments passed into them, or set them to constants as appropriate.

    Returns Area<[number, number]>

  • Constructs a new area generator with the default settings.

    Ensure that the accessors used with the area generator correspond to the arguments passed into them, or set them to constants as appropriate.

    The generic refers to the data type of an element in the input array passed into the area generator.

    Type parameters

    • Datum

    Returns Area<Datum>

line

  • line(): Line<[number, number]>
  • line<Datum>(): Line<Datum>
  • Constructs a new line generator with the default settings.

    Ensure that the accessors used with the line generator correspond to the arguments passed into them, or set them to constants as appropriate.

    Returns Line<[number, number]>

  • Constructs a new line generator with the default settings.

    Ensure that the accessors used with the line generator correspond to the arguments passed into them, or set them to constants as appropriate.

    The generic refers to the data type of an element in the input array passed into the line generator.

    Type parameters

    • Datum

    Returns Line<Datum>

pie

  • pie(): Pie<any, number | object>
  • pie<Datum>(): Pie<any, Datum>
  • pie<This, Datum>(): Pie<This, Datum>
  • Constructs a new pie generator with the default settings.

    Ensure that the accessors used with the pie generator correspond to the arguments passed into them, or set them to constants as appropriate.

    Returns Pie<any, number | object>

  • Constructs a new pie generator with the default settings.

    Ensure that the accessors used with the pie generator correspond to the arguments passed into them, or set them to constants as appropriate.

    The generic refers to the data type of an element in the input array passed into the Pie generator.

    Type parameters

    • Datum

    Returns Pie<any, Datum>

  • Constructs a new pie generator with the default settings.

    Ensure that the accessors used with the pie generator correspond to the arguments passed into them, or set them to constants as appropriate.

    The first generic corresponds to the type of the "this" context within which the pie generator and its accessor functions will be invoked.

    The second generic refers to the data type of an element in the input array passed into the Pie generator.

    Type parameters

    • This

    • Datum

    Returns Pie<This, Datum>

radialArea

  • Constructs a new radial area generator with the default settings.

    Ensure that the accessors used with the area generator correspond to the arguments passed into them, or set them to constants as appropriate.

    Returns RadialArea<[number, number]>

  • Constructs a new radial area generator with the default settings.

    Ensure that the accessors used with the area generator correspond to the arguments passed into them, or set them to constants as appropriate.

    The generic refers to the data type of an element in the input array passed into the radial area generator.

    Type parameters

    • Datum

    Returns RadialArea<Datum>

radialLine

  • Constructs a new radial line generator with the default settings.

    Ensure that the accessors used with the radial line generator correspond to the arguments passed into them, or set them to constants as appropriate.

    Returns RadialLine<[number, number]>

  • Constructs a new radial line generator with the default settings.

    Ensure that the accessors used with the radial line generator correspond to the arguments passed into them, or set them to constants as appropriate.

    The generic refers to the data type of an element in the input array passed into the radial line generator.

    Type parameters

    • Datum

    Returns RadialLine<Datum>

stack

  • stack(): Stack<any, object, string>
  • stack<Datum>(): Stack<any, Datum, string>
  • stack<Datum, Key>(): Stack<any, Datum, Key>
  • stack<This, Datum, Key>(): Stack<This, Datum, Key>
  • Constructs a new stack generator with the default settings.

    Ensure that the accessors used with the stack generator correspond to the arguments passed into them.

    Returns Stack<any, object, string>

  • Constructs a new stack generator with the default settings.

    Ensure that the accessors used with the stack generator correspond to the arguments passed into them.

    The generic corresponds to the data type of an element in the data array passed into the stack generator.

    Type parameters

    • Datum

    Returns Stack<any, Datum, string>

  • Constructs a new stack generator with the default settings.

    Ensure that the accessors used with the stack generator correspond to the arguments passed into them.

    The first generic corresponds to the data type of an element in the data array passed into the stack generator.

    The second generic corresponds to the data type of key used to identify a series.

    Type parameters

    • Datum

    • Key

    Returns Stack<any, Datum, Key>

  • Constructs a new stack generator with the default settings.

    Ensure that the accessors used with the stack generator correspond to the arguments passed into them.

    The first generic corresponds to the "this" context in which the stack generator and its accessor functions are invoked.

    The second generic corresponds to the data type of an element in the data array passed into the stack generator.

    The third generic corresponds to the data type of key used to identify a series.

    Type parameters

    • This

    • Datum

    • Key

    Returns Stack<This, Datum, Key>

stackOffsetExpand

  • stackOffsetExpand(series: Series<any, any>, order: number[]): void
  • Applies a zero baseline and normalizes the values for each point such that the topline is always one.

    Parameters

    • series: Series<any, any>

      A series generated by a stack generator

    • order: number[]

      An array of numeric indexes representing the stack order.

    Returns void

stackOffsetNone

  • stackOffsetNone(series: Series<any, any>, order: number[]): void
  • Applies a zero baseline.

    Parameters

    • series: Series<any, any>

      A series generated by a stack generator

    • order: number[]

      An array of numeric indexes representing the stack order.

    Returns void

stackOffsetSilhouette

  • stackOffsetSilhouette(series: Series<any, any>, order: number[]): void
  • Shifts the baseline down such that the center of the streamgraph is always at zero.

    Parameters

    • series: Series<any, any>

      A series generated by a stack generator

    • order: number[]

      An array of numeric indexes representing the stack order.

    Returns void

stackOffsetWiggle

  • stackOffsetWiggle(series: Series<any, any>, order: number[]): void
  • Shifts the baseline so as to minimize the weighted wiggle of layers. This offset is recommended for streamgraphs in conjunction with the inside-out order. See Stacked Graphs—Geometry & Aesthetics by Bryon & Wattenberg for more information.

    Parameters

    • series: Series<any, any>

      A series generated by a stack generator

    • order: number[]

      An array of numeric indexes representing the stack order.

    Returns void

stackOrderAscending

  • stackOrderAscending(series: Series<any, any>): number[]
  • Returns a series order such that the smallest series (according to the sum of values) is at the bottom.

    Parameters

    • series: Series<any, any>

      A series generated by a stack generator

    Returns number[]

stackOrderDescending

  • stackOrderDescending(series: Series<any, any>): number[]
  • Returns a series order such that the largest series (according to the sum of values) is at the bottom.

    Parameters

    • series: Series<any, any>

      A series generated by a stack generator

    Returns number[]

stackOrderInsideOut

  • stackOrderInsideOut(series: Series<any, any>): number[]
  • Returns a series order such that the larger series (according to the sum of values) are on the inside and the smaller series are on the outside. This order is recommended for streamgraphs in conjunction with the wiggle offset. See Stacked Graphs—Geometry & Aesthetics by Bryon & Wattenberg for more information.

    Parameters

    • series: Series<any, any>

      A series generated by a stack generator

    Returns number[]

stackOrderNone

  • stackOrderNone(series: Series<any, any>): number[]
  • Returns the given series order [0, 1, … n - 1] where n is the number of elements in series. Thus, the stack order is given by the key accessor.

    Parameters

    • series: Series<any, any>

      A series generated by a stack generator

    Returns number[]

stackOrderReverse

  • stackOrderReverse(series: Series<any, any>): number[]
  • Returns the reverse of the given series order [n - 1, n - 2, … 0] where n is the number of elements in series. Thus, the stack order is given by the reverse of the key accessor.

    Parameters

    • series: Series<any, any>

      A series generated by a stack generator

    Returns number[]

symbol

  • symbol(): Symbol<any, any>
  • symbol<Datum>(): Symbol<any, Datum>
  • symbol<This, Datum>(): Symbol<This, Datum>
  • Constructs a new symbol generator with the default settings.

    Returns Symbol<any, any>

  • Constructs a new symbol generator with the default settings.

    The generic corrsponds to the data type of the datum underlying the symbol.

    Type parameters

    • Datum

    Returns Symbol<any, Datum>

  • Constructs a new symbol generator with the default settings.

    The first generic corresponds to the "this" context within which the symbol generator is invoked. The second generic corrsponds to the data type of the datum underlying the symbol.

    Type parameters

    • This

    • Datum

    Returns Symbol<This, Datum>

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