Interface ScaleIdentity<Unknown>

Identity scales are a special case of linear scales where the domain and range are identical; the scale and its invert method are thus the identity function. These scales are occasionally useful when working with pixel coordinates, say in conjunction with an axis.

The generic corresponds to the data type of the unknown value.

interface ScaleIdentity {
    copy(): ScaleIdentity<Unknown>;
    domain(): number[];
    domain(domain): ScaleIdentity<Unknown>;
    invert(value): number;
    nice(count?): ScaleIdentity<Unknown>;
    range(): number[];
    range(range): ScaleIdentity<Unknown>;
    tickFormat(count?, specifier?): ((d) => string);
    ticks(count?): number[];
    unknown(): UnknownReturnType<Unknown, undefined>;
    unknown<NewUnknown>(value): ScaleIdentity<NewUnknown>;
    (value): number | Unknown;
}

Type Parameters

  • Unknown = never

  • Given a value from the domain, returns the corresponding value from the range, subject to interpolation, if any.

    If the given value is outside the domain, and clamping is not enabled, the mapping may be extrapolated such that the returned value is outside the range.

    Note: The interpolation function applied by the scale may change the output type from the range type as part of the interpolation.

    Parameters

    Returns number | Unknown

Methods

  • Returns an exact copy of this scale. Changes to this scale will not affect the returned scale, and vice versa.

    Returns ScaleIdentity<Unknown>

  • Returns a copy of the scale’s current domain.

    Returns number[]

  • Sets the scale’s domain to the specified array of numbers. The array must contain two or more elements. If the elements in the given array are not numbers, they will be coerced to numbers

    Although continuous scales typically have two values each in their domain and range, specifying more than two values produces a piecewise scale.

    Internally, a piecewise scale performs a binary search for the range interpolator corresponding to the given domain value. Thus, the domain must be in ascending or descending order. If the domain and range have different lengths N and M, only the first min(N,M) elements in each are observed.

    Parameters

    • domain: Iterable<NumberValue>

      Array of numeric domain values.

    Returns ScaleIdentity<Unknown>

  • Given a value from the range, returns the corresponding value from the domain. Inversion is useful for interaction, say to determine the data value corresponding to the position of the mouse.

    If the given value is outside the range, and clamping is not enabled, the mapping may be extrapolated such that the returned value is outside the domain.

    IMPORTANT: This method is only supported if the range is numeric. If the range is not numeric, returns NaN.

    For a valid value y in the range, continuous(continuous.invert(y)) approximately equals y; similarly, for a valid value x in the domain, continuous.invert(continuous(x)) approximately equals x. The scale and its inverse may not be exact due to the limitations of floating point precision.

    Parameters

    Returns number

  • Extends the domain so that it starts and ends on nice round values. This method typically modifies the scale’s domain, and may only extend the bounds to the nearest round value. An optional tick count argument allows greater control over the step size used to extend the bounds, guaranteeing that the returned ticks will exactly cover the domain. Nicing is useful if the domain is computed from data, say using extent, and may be irregular. For example, for a domain of [0.201479…, 0.996679…], a nice domain might be [0.2, 1.0]. If the domain has more than two values, nicing the domain only affects the first and last value.

    Nicing a scale only modifies the current domain; it does not automatically nice domains that are subsequently set using continuous.domain. You must re-nice the scale after setting the new domain, if desired.

    Parameters

    • Optional count: number

      An optional number of ticks expected to be used.

    Returns ScaleIdentity<Unknown>

  • Returns a copy of the scale’s current range.

    Returns number[]

  • Sets the scale’s range to the specified array of values.

    The array must contain two or more elements. Unlike the domain, elements in the given array need not be numbers; any value that is supported by the underlying interpolator will work, though note that numeric ranges are required for invert.

    Parameters

    Returns ScaleIdentity<Unknown>

  • Returns a number format function suitable for displaying a tick value, automatically computing the appropriate precision based on the fixed interval between tick values. The specified count should have the same value as the count that is used to generate the tick values.

    Parameters

    • Optional count: number

      Approximate number of ticks to be used when calculating precision for the number format function.

    • Optional specifier: string

      An optional valid format specifier string which allows a custom format where the precision of the format is automatically set by the scale as appropriate for the tick interval. If specifier uses the format type "s", the scale will return a SI-prefix format based on the largest value in the domain. If the specifier already specifies a precision, this method is equivalent to locale.format.

    Returns ((d) => string)

      • (d): string
      • Returns a number format function suitable for displaying a tick value, automatically computing the appropriate precision based on the fixed interval between tick values. The specified count should have the same value as the count that is used to generate the tick values.

        Parameters

        Returns string

  • Returns approximately count representative values from the scale’s domain.

    If count is not specified, it defaults to 10.

    The returned tick values are uniformly spaced, have human-readable values (such as multiples of powers of 10), and are guaranteed to be within the extent of the domain. Ticks are often used to display reference lines, or tick marks, in conjunction with the visualized data. The specified count is only a hint; the scale may return more or fewer values depending on the domain. See also d3-array’s ticks.

    Parameters

    • Optional count: number

      Optional approximate number of ticks to be returned. If count is not specified, it defaults to 10.

    Returns number[]

  • Returns the current unknown value, which defaults to undefined.

    Returns UnknownReturnType<Unknown, undefined>

  • Sets the output value of the scale for undefined (or NaN) input values and returns this scale.

    Type Parameters

    • NewUnknown

    Parameters

    • value: NewUnknown

      The output value of the scale for undefined (or NaN) input values.

    Returns ScaleIdentity<NewUnknown>