@types/d3-selection
Version:
TypeScript definitions for d3-selection
878 lines (833 loc) • 62.6 kB
TypeScript
// Last module patch version validated against: 3.0.0
// --------------------------------------------------------------------------
// Shared Type Definitions and Interfaces
// --------------------------------------------------------------------------
/**
* BaseType serves as an alias for the 'minimal' data type which can be selected
* without 'd3-selection' trying to use properties internally which would otherwise not
* be supported.
*/
export type BaseType = Element | EnterElement | Document | Window | null;
/**
* KeyType serves as alias for valid types that d3 supports as key for data binding
*/
export type KeyType = string | number;
/**
* A helper interface which covers arguments like NodeListOf<T> or HTMLCollectionOf<T>
* argument types
*/
export interface ArrayLike<T> {
length: number;
item(index: number): T | null;
[index: number]: T;
}
/**
* An interface describing the element type of the Enter Selection group elements
* created when invoking selection.enter().
*/
export interface EnterElement {
ownerDocument: Document;
namespaceURI: string;
appendChild(newChild: Node): Node;
insertBefore(newChild: Node, refChild: Node): Node;
querySelector(selectors: string): Element;
querySelectorAll(selectors: string): NodeListOf<Element>;
}
/**
* Container element type usable for mouse/touch functions
*/
export type ContainerElement = HTMLElement | SVGSVGElement | SVGGElement;
/**
* A User interface event (e.g. mouse event, touch or MSGestureEvent) with captured clientX and clientY properties.
*/
export interface ClientPointEvent {
clientX: number;
clientY: number;
}
/**
* Interface for optional parameters map, when dispatching custom events
* on a selection
*/
export interface CustomEventParameters {
/**
* If true, the event is dispatched to ancestors in reverse tree order
*/
bubbles: boolean;
/**
* If true, event.preventDefault is allowed
*/
cancelable: boolean;
/**
* Any custom data associated with the event
*/
detail: any;
}
/**
* Callback type for selections and transitions
*/
export type ValueFn<T extends BaseType, Datum, Result> = (
this: T,
datum: Datum,
index: number,
groups: T[] | ArrayLike<T>,
) => Result;
/**
* TransitionLike is a helper interface to represent a quasi-Transition, without specifying the full Transition interface in this file.
* For example, wherever d3-zoom allows a Transition to be passed in as an argument, it internally immediately invokes its `selection()`
* method to retrieve the underlying Selection object before proceeding.
* d3-brush uses a subset of Transition methods internally.
* The use of this interface instead of the full imported Transition interface is [referred] to achieve
* two things:
* (1) the d3-transition module may not be required by a projects use case,
* (2) it avoids possible complications from 'module augmentation' from d3-transition to Selection.
*/
export interface TransitionLike<GElement extends BaseType, Datum> {
selection(): Selection<GElement, Datum, any, any>;
on(type: string, listener: null): TransitionLike<GElement, Datum>;
on(type: string, listener: ValueFn<GElement, Datum, void>): TransitionLike<GElement, Datum>;
tween(name: string, tweenFn: null): TransitionLike<GElement, Datum>;
tween(name: string, tweenFn: ValueFn<GElement, Datum, ((t: number) => void)>): TransitionLike<GElement, Datum>;
}
// --------------------------------------------------------------------------
// All Selection related interfaces and function
// --------------------------------------------------------------------------
/**
* Select the first element that matches the specified selector string. If no elements match the selector, returns an empty selection.
* If multiple elements match the selector, only the first matching element (in document order) will be selected.
*
* The first generic "GElement" refers to the type of element to be selected. The second generic "OldDatum" refers to the type of the
* datum, on the selected element. This is useful when re-selecting an element with a previously set, know datum type.
*
* @param selector CSS selector string
*/
// eslint-disable-next-line @definitelytyped/no-unnecessary-generics
export function select<GElement extends BaseType, OldDatum>(
selector: string,
): Selection<GElement, OldDatum, HTMLElement, any>;
/**
* Select the specified node element.
*
* The first generic "GElement" refers to the type of element to be selected. The second generic "OldDatum" refers to the type of the
* datum, on the selected element. This is useful when re-selecting an element with a previously set, know datum type.
*
* @param node An element to be selected
*/
// eslint-disable-next-line @definitelytyped/no-unnecessary-generics
export function select<GElement extends BaseType, OldDatum>(
node: GElement,
): Selection<GElement, OldDatum, null, undefined>;
/**
* Create an empty selection.
*/
export function selectAll(selector?: null): Selection<null, undefined, null, undefined>;
/**
* Select all elements that match the specified selector string. The elements will be selected in document order (top-to-bottom).
* If no elements in the document match the selector, returns an empty selection.
*
* The first generic "GElement" refers to the type of element to be selected. The second generic "OldDatum" refers to the type of the
* datum, of a selected element. This is useful when re-selecting elements with a previously set, know datum type.
*
* @param selector CSS selector string
*/
// eslint-disable-next-line @definitelytyped/no-unnecessary-generics
export function selectAll<GElement extends BaseType, OldDatum>(
selector: string,
): Selection<GElement, OldDatum, HTMLElement, any>;
/**
* Select the specified array, array-like, or iterable of nodes.
* This is useful if you already have a reference to nodes, such as `this.childNodes` within an event listener or a global such as `document.links`.
* The nodes may instead be an iterable, or a pseudo-array such as a NodeList.
*
* The first generic "GElement" refers to the type of element to be selected.
* The second generic "OldDatum" refers to the type of the datum, of a selected element.
*
* @param nodes An array, array-like, or iterable of nodes
*/
// eslint-disable-next-line @definitelytyped/no-unnecessary-generics
export function selectAll<GElement extends BaseType, OldDatum>(
nodes: GElement[] | ArrayLike<GElement> | Iterable<GElement>,
): Selection<GElement, OldDatum, null, undefined>;
/**
* A D3 Selection of elements.
*
* The first generic "GElement" refers to the type of the selected element(s).
* The second generic "Datum" refers to the type of the datum of a selected element(s).
* The third generic "PElement" refers to the type of the parent element(s) in the D3 selection.
* The fourth generic "PDatum" refers to the type of the datum of the parent element(s).
*/
export interface Selection<GElement extends BaseType, Datum, PElement extends BaseType, PDatum> {
// Sub-selection -------------------------
/**
* For each selected element, select the first descendant element that matches the specified selector string.
* If no element matches the specified selector for the current element, the element at the current index will
* be null in the returned selection. If multiple elements match the selector, only the first matching element
* in document order is selected. Selection.select does not affect grouping: it preserves the existing group
* structure and indexes, and propagates data (if any) to selected children.
*
* If the current element has associated data, this data is propagated to the
* corresponding selected element.
*
* The generic represents the type of the descendant element to be selected.
*
* @param selector CSS selector string
*/
// eslint-disable-next-line @definitelytyped/no-unnecessary-generics
select<DescElement extends BaseType>(selector: string): Selection<DescElement, Datum, PElement, PDatum>;
/**
* Create an empty sub-selection. Selection.select does not affect grouping: it preserves the existing group
* structure and indexes.
*/
// eslint-disable-next-line @definitelytyped/no-unnecessary-generics
select<DescElement extends BaseType>(selector: null): Selection<null, undefined, PElement, PDatum>;
/**
* For each selected element, select the descendant element returned by the selector function.
* If no element is returned by the selector function for the current element, the element at the
* current index will be null in the returned selection. Selection.select does not affect grouping:
* it preserves the existing group structure and indexes, and propagates data (if any) to selected children.
*
* If the current element has associated data, this data is propagated to the
* corresponding selected element.
*
* The generic represents the type of the descendant element to be selected.
*
* @param selector A selector function, which is evaluated for each selected element, in order, being passed the current datum (d),
* the current index (i), and the current group (nodes), with this as the current DOM element (nodes[i]).
* It must return an element, or null if there is no matching element.
*/
select<DescElement extends BaseType>(
selector: ValueFn<GElement, Datum, DescElement>,
): Selection<DescElement, Datum, PElement, PDatum>;
/**
* Create an empty sub-selection. Selection.selectAll does affect grouping: The elements in the returned
* selection are grouped by their corresponding parent node in this selection, the group at the current index will be empty.
*/
selectAll(selector?: null): Selection<null, undefined, GElement, Datum>;
/**
* For each selected element, selects the descendant elements that match the specified selector string. The elements in the returned
* selection are grouped by their corresponding parent node in this selection. If no element matches the specified selector
* for the current element, the group at the current index will be empty. Selection.selectAll does affect grouping: each selected descendant
* is grouped by the parent element in the originating selection.
*
* The selected elements do not inherit data from this selection; use selection.data to propagate data to children.
*
* The first generic "DescElement" refers to the type of descendant element to be selected. The second generic "OldDatum" refers to the type of the
* datum, of a selected element. This is useful when re-selecting elements with a previously set, know datum type.
*
* @param selector CSS selector string
*/
// eslint-disable-next-line @definitelytyped/no-unnecessary-generics
selectAll<DescElement extends BaseType, OldDatum>(
selector: string,
): Selection<DescElement, OldDatum, GElement, Datum>;
/**
* For each selected element, selects the descendant elements returned by the selector function. The elements in the returned
* selection are grouped by their corresponding parent node in this selection. If no element matches the specified selector
* for the current element, the group at the current index will be empty. Selection.selectAll does affect grouping: each selected descendant
* is grouped by the parent element in the originating selection.
*
* The selected elements do not inherit data from this selection; use selection.data to propagate data to children.
*
* The first generic "DescElement" refers to the type of descendant element to be selected. The second generic "OldDatum" refers to the type of the
* datum, of a selected element. This is useful when re-selecting elements with a previously set, know datum type.
*
* @param selector A selector function which is evaluated for each selected element, in order, being passed the current datum (d),
* the current index (i), and the current group (nodes), with this as the current DOM element (nodes[i]). It must return an array of elements
* (or an iterable, or a pseudo-array, such as a NodeList), or the empty array if there are no matching elements.
*/
// eslint-disable-next-line @definitelytyped/no-unnecessary-generics
selectAll<DescElement extends BaseType, OldDatum>(
selector: ValueFn<GElement, Datum, DescElement[] | ArrayLike<DescElement> | Iterable<DescElement>>,
): Selection<DescElement, OldDatum, GElement, Datum>;
/**
* Filters the selection, returning a new selection that contains only the elements for
* which the specified filter is true.
*
* The returned filtered selection preserves the parents of this selection, but like array.filter,
* it does not preserve indexes as some elements may be removed; use selection.select to preserve the index, if needed.
*
* @param selector A CSS selector string to match when filtering.
*/
filter(selector: string): Selection<GElement, Datum, PElement, PDatum>;
/**
* Filters the selection, returning a new selection that contains only the elements for
* which the specified filter is true.
*
* The returned filtered selection preserves the parents of this selection, but like array.filter,
* it does not preserve indexes as some elements may be removed; use selection.select to preserve the index, if needed.
*
* The generic refers to the type of element which will be selected after applying the filter, i.e. if the element types
* contained in a pre-filter selection are narrowed to a subset as part of the filtering.
*
* @param selector A CSS selector string to match when filtering.
*/
// eslint-disable-next-line @definitelytyped/no-unnecessary-generics
filter<FilteredElement extends BaseType>(selector: string): Selection<FilteredElement, Datum, PElement, PDatum>;
/**
* Filter the selection, returning a new selection that contains only the elements for
* which the specified filter is true.
*
* The returned filtered selection preserves the parents of this selection, but like array.filter,
* it does not preserve indexes as some elements may be removed; use selection.select to preserve the index, if needed.
*
* @param selector A value function which is evaluated for each selected element, in order, being passed the current datum (d),
* the current index (i), and the current group (nodes), with this as the current DOM element (nodes[i]). This function should return true
* for an element to be included, and false otherwise.
*/
filter(selector: ValueFn<GElement, Datum, boolean>): Selection<GElement, Datum, PElement, PDatum>;
/**
* Filter the selection, returning a new selection that contains only the elements for
* which the specified filter is true.
*
* The returned filtered selection preserves the parents of this selection, but like array.filter,
* it does not preserve indexes as some elements may be removed; use selection.select to preserve the index, if needed.
*
* @param selector A value function which is evaluated for each selected element, in order, being passed the current datum (d),
* the current index (i), and the current group (nodes), with this as the current DOM element (nodes[i]). This function should return true
* for an element to be included, and false otherwise.
*/
// eslint-disable-next-line @definitelytyped/no-unnecessary-generics
filter<FilteredElement extends BaseType>(
selector: ValueFn<GElement, Datum, boolean>,
): Selection<FilteredElement, Datum, PElement, PDatum>;
/**
* Returns a new selection merging this selection with the specified other selection or transition.
* The returned selection has the same number of groups and the same parents as this selection.
* Any missing (null) elements in this selection are filled with the corresponding element,
* if present (not null), from the specified selection. (If the other selection has additional groups or parents,
* they are ignored.)
*
* This method is commonly used to merge the enter and update selections after a data-join.
* After modifying the entering and updating elements separately, you can merge the two selections and
* perform operations on both without duplicate code.
*
* This method is not intended for concatenating arbitrary selections, however: if both this selection
* and the specified other selection have (non-null) elements at the same index, this selection’s element
* is returned in the merge and the other selection’s element is ignored.
*
* @param other Selection to be merged.
*/
merge(
other: Selection<GElement, Datum, PElement, PDatum> | TransitionLike<GElement, Datum>,
): Selection<GElement, Datum, PElement, PDatum>;
/**
* Returns a new selection with the (first) child of each element of the current selection matching the selector.
* Selects the first child that matches (if any).
*
* The generic represents the type of the descendant element to be selected.
*
* @param selector CSS selector string
*/
// eslint-disable-next-line @definitelytyped/no-unnecessary-generics
selectChild<DescElement extends BaseType>(selector?: string): Selection<DescElement, Datum, PElement, PDatum>;
/**
* Returns a new selection with the (first) child of each element of the current selection matching the selector.
*
* The first generic represents the type of the descendant element to be selected.
* The second generic represents the type of any of the child elements.
*
* @param selector A selector function, which is evaluated for each of the children nodes, in order, being passed the child (child), the child’s index (i), and the list of children (children);
* the method selects the first child for which the selector return truthy, if any.
*/
// eslint-disable-next-line @definitelytyped/no-unnecessary-generics
selectChild<ResultElement extends BaseType, ChildElement extends BaseType>(
selector: (child: ChildElement, i: number, children: ChildElement[]) => boolean,
): Selection<ResultElement, Datum, PElement, PDatum>;
/**
* Returns a new selection with the children of each element of the current selection matching the selector.
* Selects the children that match (if any)
*
* The first generic represents the type of the descendant element to be selected.
* The second generic refers to the type of the datum of the element to be selected.
*
* @param selector CSS selector string
*/
// eslint-disable-next-line @definitelytyped/no-unnecessary-generics
selectChildren<DescElement extends BaseType, OldDatum>(
selector?: string,
): Selection<DescElement, OldDatum, GElement, Datum>;
/**
* Returns a new selection with the children of each element of the current selection matching the selector.
*
* The first generic represents the type of the descendant element to be selected.
* The second generic refers to the type of the datum of the element to be selected.
* The third generic represents the type of any of the child elements.
*
* @param selector A selector function, which is evaluated for each of the children nodes, in order, being passed the child (child), the child’s index (i), and the list of children (children);
* the method selects the first child for which the selector return truthy, if any.
*/
// eslint-disable-next-line @definitelytyped/no-unnecessary-generics
selectChildren<ResultElement extends BaseType, ResultDatum, ChildElement extends BaseType>(
selector: (child: ChildElement, i: number, children: ChildElement[]) => boolean,
): Selection<ResultElement, ResultDatum, GElement, Datum>;
/**
* Returns the selection (for symmetry with transition.selection).
*/
selection(): this;
// Modifying -------------------------------
/**
* Return the current value of the specified attribute for the first (non-null) element in the selection.
* This is generally useful only if you know that the selection contains exactly one element.
*
* @param name Name of the attribute
*/
attr(name: string): string;
/**
* Sets the attribute with the specified name to the specified value on the selected elements and returns this selection.
* If the value is a constant, all elements are given the same attribute value;
* otherwise, if the value is a function, it is evaluated for each selected element, in order, being passed the current datum (d),
* the current index (i), and the current group (nodes), with this as the current DOM element (nodes[i]).
* The function’s return value is then used to set each element’s attribute.
* A null value will remove the specified attribute.
*/
attr(
name: string,
value:
| null
| string
| number
| boolean
| ReadonlyArray<string | number>
| ValueFn<GElement, Datum, null | string | number | boolean | ReadonlyArray<string | number>>,
): this;
/**
* Returns true if and only if the first (non-null) selected element has the specified classes.
* This is generally useful only if you know the selection contains exactly one element.
*
* @param names A string of space-separated class names.
*/
classed(names: string): boolean;
/**
* Assigns or unassigns the specified CSS class names on the selected elements by setting
* the class attribute or modifying the classList property and returns this selection.
* If the constant value is truthy, then all elements are assigned the specified classes; otherwise, the classes are unassigned.
*
* @param names A string of space-separated class names.
* @param value A boolean flag (true = assign / false = unassign)
*/
classed(names: string, value: boolean): this;
/**
* Assigns or unassigns the specified CSS class names on the selected elements by setting
* the class attribute or modifying the classList property and returns this selection.
* The assign/unassign status for the individual selected elements is determined by the boolean return
* value of the value function.
*
* @param names A string of space-separated class names.
* @param value A value function which is evaluated for each selected element, in order,
* being passed the current datum (d), the current index (i), and the current group (nodes), with this as the current DOM element (nodes[i]).
* The function’s return value is then used to assign or unassign classes on each element.
*/
classed(names: string, value: ValueFn<GElement, Datum, boolean>): this;
/**
* Returns the current value of the specified style property for the first (non-null) element in the selection.
* The current value is defined as the element’s inline value, if present, and otherwise its computed value.
* Accessing the current style value is generally useful only if you know the selection contains exactly one element.
*
* @param name Name of the style
*/
style(name: string): string;
/**
* Clear the style with the specified name for the selected elements and returns this selection.
*
* @param name Name of the style
* @param value null,to clear the style
*/
style(name: string, value: null): this;
/**
* Sets the value of the style with the specified name for the selected elements and returns this selection.
* All elements are given the same style value.
*
* @param name Name of the style
* @param value Constant value for the style
* @param priority An optional priority flag, either null or the string important (without the exclamation point)
*/
style(name: string, value: string | number | boolean, priority?: null | "important"): this;
/**
* Sets the value of the style with the specified name for the selected elements and returns this selection.
* The value for the individual selected elements is determined by the value function.
*
* @param name Name of the style
* @param value A value function which is evaluated for each selected element, in order, being passed the current datum (d),
* the current index (i), and the current group (nodes), with this as the current DOM element (nodes[i]). A null value will clear the style.
* @param priority An optional priority flag, either null or the string important (without the exclamation point)
*/
style(
name: string,
value: ValueFn<GElement, Datum, string | number | boolean | null>,
priority?: null | "important",
): this;
/**
* Return the current value of the specified property for the first (non-null) element in the selection.
* This is generally useful only if you know that the selection contains exactly one element.
*
* @param name Name of the property
*/
property(name: string): any;
/**
* Look up a local variable on the first node of this selection. Note that this is not equivalent to `local.get(selection.node())` in that it will not look up locals set on the parent node(s).
*
* @param name The `d3.local` variable to look up.
*/
property<T>(name: Local<T>): T | undefined;
/**
* Sets the property with the specified name to the specified value on selected elements.
* If the value is a constant, then all elements are given the same property value;
* otherwise, if the value is a function, it is evaluated for each selected element, in order, being passed the current datum (d),
* the current index (i), and the current group (nodes), with this as the current DOM element (nodes[i]).
* The function’s return value is then used to set each element’s property. A null value will delete the specified property.
*/
property(name: string, value: ValueFn<GElement, Datum, any> | null): this;
/**
* Sets the value of the property with the specified name for the selected elements and returns this selection.
* All elements are given the same property value.
*
* @param name Name of the property
* @param value Constant value for the property
*/
property(name: string, value: any): this;
/**
* Store a value in a `d3.local` variable.
* This is equivalent to `selection.each(function (d, i, g) { name.set(this, value.call(this, d, i, g)); })` but more concise.
*
* @param name A `d3.local` variable
* @param value A callback that returns the value to store
*/
property<T>(name: Local<T>, value: ValueFn<GElement, Datum, T>): this;
/**
* Store a value in a `d3.local` variable for each node in the selection.
* This is equivalent to `selection.each(function () { name.set(this, value); })` but more concise.
*
* @param name A `d3.local` variable
* @param value A callback that returns the value to store
*/
property<T>(name: Local<T>, value: T): this;
/**
* Returns the text content for the first (non-null) element in the selection.
* This is generally useful only if you know the selection contains exactly one element.
*/
text(): string;
/**
* Sets the text content to the specified value on all selected elements, replacing any existing child elements.
* If the value is a constant, then all elements are given the same text content;
* otherwise, if the value is a function, it is evaluated for each selected element, in order, being passed the current datum (d),
* the current index (i), and the current group (nodes), with this as the current DOM element (nodes[i]).
* The function’s return value is then used to set each element’s text content.
* A null value will clear the content.
*/
text(value: null | string | number | boolean | ValueFn<GElement, Datum, string | number | boolean | null>): this;
/**
* Returns a string representation of the inner HTML for the first (non-null) element in the selection.
* This is generally useful only if you know the selection contains exactly one element.
*/
html(): string;
/**
* Sets the inner HTML to the specified value on all selected elements, replacing any existing child elements.
* If the value is a constant, then all elements are given the same inner HTML;
* otherwise, if the value is a function, it is evaluated for each selected element, in order, being passed the current datum (d),
* the current index (i), and the current group (nodes), with this as the current DOM element (nodes[i]).
* The function’s return value is then used to set each element’s inner HTML.
* A null value will clear the content.
*/
html(value: null | string | ValueFn<GElement, Datum, string | null>): this;
/**
* Appends a new element of this type (tag name) as the last child of each selected element,
* or before the next following sibling in the update selection if this is an enter selection.
* The latter behavior for enter selections allows you to insert elements into the DOM in an order consistent with the new bound data;
* however, note that selection.order may still be required if updating elements change order
* (i.e., if the order of new data is inconsistent with old data).
*
* This method returns a new selection containing the appended elements.
* Each new element inherits the data of the current elements, if any.
*
* @param type A string representing the tag name.
*/
append<K extends keyof ElementTagNameMap>(type: K): Selection<ElementTagNameMap[K], Datum, PElement, PDatum>;
/**
* Appends a new element of this type (tag name) as the last child of each selected element,
* or before the next following sibling in the update selection if this is an enter selection.
* The latter behavior for enter selections allows you to insert elements into the DOM in an order consistent with the new bound data;
* however, note that selection.order may still be required if updating elements change order
* (i.e., if the order of new data is inconsistent with old data).
*
* This method returns a new selection containing the appended elements.
* Each new element inherits the data of the current elements, if any.
*
* The generic refers to the type of the child element to be appended.
*
* @param type A string representing the tag name. The specified name may have a namespace prefix, such as svg:text
* to specify a text attribute in the SVG namespace. If no namespace is specified, the namespace will be inherited
* from the parent element; or, if the name is one of the known prefixes, the corresponding namespace will be used
* (for example, svg implies svg:svg)
*/
// eslint-disable-next-line @definitelytyped/no-unnecessary-generics
append<ChildElement extends BaseType>(type: string): Selection<ChildElement, Datum, PElement, PDatum>;
/**
* Appends a new element of the type provided by the element creator function as the last child of each selected element,
* or before the next following sibling in the update selection if this is an enter selection.
* The latter behavior for enter selections allows you to insert elements into the DOM in an order consistent with the new bound data;
* however, note that selection.order may still be required if updating elements change order
* (i.e., if the order of new data is inconsistent with old data).
*
* This method returns a new selection containing the appended elements.
* Each new element inherits the data of the current elements, if any.
*
* The generic refers to the type of the child element to be appended.
*
* @param type A creator function which is evaluated for each selected element, in order, being passed the current datum (d),
* the current index (i), and the current group (nodes), with this as the current DOM element (nodes[i]). This function should return
* an element to be appended. (The function typically creates a new element, but it may instead return an existing element.)
*/
append<ChildElement extends BaseType>(
type: ValueFn<GElement, Datum, ChildElement>,
): Selection<ChildElement, Datum, PElement, PDatum>;
/**
* Inserts a new element of the specified type (tag name) before the first element matching the specified
* before selector for each selected element. For example, a before selector :first-child will prepend nodes before the first child.
* If before is not specified, it defaults to null. (To append elements in an order consistent with bound data, use selection.append.)
*
* This method returns a new selection containing the appended elements.
* Each new element inherits the data of the current elements, if any.
*
* The generic refers to the type of the child element to be appended.
*
* @param type A string representing the tag name for the element type to be inserted.
* @param before One of:
* * A CSS selector string for the element before which the insertion should occur.
* * A child selector function which is evaluated for each selected element, in order, being passed the current datum (d),
* the current index (i), and the current group (nodes), with this as the current DOM element (nodes[i]). This function should return the child element
* before which the element should be inserted.
*/
insert<K extends keyof ElementTagNameMap>(
type: K,
before?: string | ValueFn<GElement, Datum, BaseType>,
): Selection<ElementTagNameMap[K], Datum, PElement, PDatum>;
/**
* Inserts a new element of the specified type (tag name) before the first element matching the specified
* before selector for each selected element. For example, a before selector :first-child will prepend nodes before the first child.
* If before is not specified, it defaults to null. (To append elements in an order consistent with bound data, use selection.append.)
*
* This method returns a new selection containing the appended elements.
* Each new element inherits the data of the current elements, if any.
*
* The generic refers to the type of the child element to be appended.
*
* @param type One of:
* * A string representing the tag name for the element type to be inserted. The specified name may have a namespace prefix,
* such as svg:text to specify a text attribute in the SVG namespace. If no namespace is specified, the namespace will be inherited
* from the parent element; or, if the name is one of the known prefixes, the corresponding namespace will be used
* (for example, svg implies svg:svg)
* * A creator function which is evaluated for each selected element, in order, being passed the current datum (d),
* the current index (i), and the current group (nodes), with this as the current DOM element (nodes[i]). This function should return
* an element to be inserted. (The function typically creates a new element, but it may instead return an existing element.)
* @param before One of:
* * A CSS selector string for the element before which the insertion should occur.
* * A child selector function which is evaluated for each selected element, in order, being passed the current datum (d),
* the current index (i), and the current group (nodes), with this as the current DOM element (nodes[i]). This function should return the child element
* before which the element should be inserted.
*/
insert<ChildElement extends BaseType>(
type: string | ValueFn<GElement, Datum, ChildElement>,
before?: string | ValueFn<GElement, Datum, BaseType>,
): Selection<ChildElement, Datum, PElement, PDatum>;
/**
* Removes the selected elements from the document.
* Returns this selection (the removed elements) which are now detached from the DOM.
*/
remove(): this;
/**
* Inserts clones of the selected elements immediately following the selected elements and returns a selection of the newly
* added clones. If deep is true, the descendant nodes of the selected elements will be cloned as well. Otherwise, only the elements
* themselves will be cloned.
*
* @param deep Perform deep cloning if this flag is set to true.
*/
clone(deep?: boolean): Selection<GElement, Datum, PElement, PDatum>;
/**
* Return a new selection that contains a copy of each group in this selection sorted according
* to the compare function. After sorting, re-inserts elements to match the resulting order (per selection.order).
*
* Note that sorting is not guaranteed to be stable; however, it is guaranteed to have the same
* behavior as your browser’s built-in sort method on arrays.
*
* @param comparator An optional comparator function, which defaults to "ascending". The function is passed
* two elements’ data a and b to compare. It should return either a negative, positive, or zero value.
* If negative, then a should be before b; if positive, then a should be after b; otherwise, a and b are
* considered equal and the order is arbitrary.
*/
sort(comparator?: (a: Datum, b: Datum) => number): this;
/**
* Re-insert elements into the document such that the document order of each group matches the selection order.
* This is equivalent to calling selection.sort if the data is already sorted, but much faster.
*/
order(): this;
/**
* Re-insert each selected element, in order, as the last child of its parent.
*/
raise(): this;
/**
* Re-insert each selected element, in order, as the first child of its parent.
*/
lower(): this;
// Data Join ---------------------------------
/**
* Returns the array of data for the selected elements.
*/
data(): Datum[];
/**
* Joins the specified array of data with the selected elements, returning a new selection that represents
* the update selection: the elements successfully bound to data. Also defines the enter and exit selections on
* the returned selection, which can be used to add or remove elements to correspond to the new data.
*
* The data is specified for each group in the selection. If the selection has multiple groups
* (such as d3.selectAll followed by selection.selectAll), then data should typically be specified as a function.
*
* If a key function is not specified, then the first datum in data is assigned to the first selected element,
* the second datum to the second selected element, and so on.
* A key function may be specified to control which datum is assigned to which element, replacing the default join-by-index,
* by computing a string identifier for each datum and element.
*
* The update and enter selections are returned in data order, while the exit selection preserves the selection
* order prior to the join. If a key function is specified, the order of elements in the selection may not match
* their order in the document; use selection.order or selection.sort as needed.
*
* This method cannot be used to clear bound data; use selection.datum instead.
*
* For details see: {@link https://github.com/d3/d3-selection#joining-data }
*
* The generic refers to the type of the new datum to be used for the selected elements.
*
* @param data The specified data is an array or iterable of arbitrary values (e.g., numbers or objects)
* or a value function which will be evaluated for each group in order, being passed the group’s parent datum
* (d, which may be undefined), the group index (i), and the selection’s parent nodes (nodes),
* with this as the group’s parent element. The function returns an array or iterable of values for each group.
* @param key An optional key function which is evaluated for each selected element, in order, being passed the
* current datum (d), the current index (i), and the current group (nodes), with this as the current DOM element (nodes[i]); the returned string is the element’s key.
* The key function is then also evaluated for each new datum in data, being passed the current datum (d),
* the current index (i), and the group’s new data, with this as the group’s parent DOM element (nodes[i]); the returned string is the datum’s key.
* The datum for a given key is assigned to the element with the matching key. If multiple elements have the same key,
* the duplicate elements are put into the exit selection; if multiple data have the same key, the duplicate data are put into the enter selection.
*/
data<NewDatum>(
data: NewDatum[] | Iterable<NewDatum> | ValueFn<PElement, PDatum, NewDatum[] | Iterable<NewDatum>>,
key?: ValueFn<GElement | PElement, Datum | NewDatum, KeyType>,
): Selection<GElement, NewDatum, PElement, PDatum>;
/**
* Appends, removes and reorders elements as necessary to match the data that was previously bound by `selection.data`, returning the merged enter and update selection.
* This method is a convenient alternative to the more explicit `selection.enter`, `selection.exit`, `selection.append` and `selection.remove`.
*
* The "matching" logic is determined by the key function passed to `selection.data`.
*/
// eslint-disable-next-line @definitelytyped/no-unnecessary-generics
join<K extends keyof ElementTagNameMap, OldDatum = Datum>(
enter: K,
update?: (
elem: Selection<GElement, Datum, PElement, PDatum>,
) => Selection<GElement, Datum, PElement, PDatum> | TransitionLike<GElement, Datum> | undefined,
exit?: (elem: Selection<GElement, OldDatum, PElement, PDatum>) => void,
): Selection<GElement | ElementTagNameMap[K], Datum, PElement, PDatum>;
/**
* Appends, removes and reorders elements as necessary to match the data that was previously bound by `selection.data`, returning the merged enter and update selection.
* This method is a convenient alternative to the more explicit `selection.enter`, `selection.exit`, `selection.append` and `selection.remove`.
*
* The "matching" logic is determined by the key function passed to `selection.data`.
*/
// eslint-disable-next-line @definitelytyped/no-unnecessary-generics
join<ChildElement extends BaseType, OldDatum = Datum>(
enter:
| string
| ((
elem: Selection<EnterElement, Datum, PElement, PDatum>,
) => Selection<ChildElement, Datum, PElement, PDatum> | TransitionLike<GElement, Datum>),
update?: (
elem: Selection<GElement, Datum, PElement, PDatum>,
) => Selection<GElement, Datum, PElement, PDatum> | TransitionLike<GElement, Datum> | undefined,
exit?: (elem: Selection<GElement, OldDatum, PElement, PDatum>) => void,
): Selection<ChildElement | GElement, Datum, PElement, PDatum>;
/**
* Return the enter selection: placeholder nodes for each datum that had no corresponding DOM element
* in the selection. (The enter selection is empty for selections not returned by selection.data.)
*/
enter(): Selection<EnterElement, Datum, PElement, PDatum>;
/**
* Returns the exit selection: existing DOM elements in the selection for which no new datum was found.
* (The exit selection is empty for selections not returned by selection.data.)
*
* IMPORTANT: The generic refers to the type of the old datum associated with the exit selection elements.
* Ensure you set the generic to the correct type, if you need to access the data on the exit selection in
* follow-up steps, e.g. to set styles as part of an exit transition before removing them.
*/
// eslint-disable-next-line @definitelytyped/no-unnecessary-generics
exit<OldDatum>(): Selection<GElement, OldDatum, PElement, PDatum>;
/**
* Returns the bound datum for the first (non-null) element in the selection.
* This is generally useful only if you know the selection contains exactly one element.
*/
datum(): Datum;
/**
* Delete the bound data for each element in the selection.
*/
datum(value: null): Selection<GElement, undefined, PElement, PDatum>;
/**
* Sets the element’s bound data using the specified value function on all selected elements.
* Unlike selection.data, this method does not compute a join and does not affect
* indexes or the enter and exit selections.
*
* The generic refers to the type of the new datum to be used for the selected elements.
*
* @param value A value function which is evaluated for each selected element, in order,
* being passed the current datum (d), the current index (i), and the current group (nodes),
* with this as the current DOM element (nodes[i]). The function is then used to set each element’s new data.
* A null value will delete the bound data.
*/
datum<NewDatum>(value: ValueFn<GElement, Datum, NewDatum>): Selection<GElement, NewDatum, PElement, PDatum>;
/**
* Sets the element’s bound data to the specified value on all selected elements.
* Unlike selection.data, this method does not compute a join and does not affect
* indexes or the enter and exit selections.
*
* The generic refers to the type of the new datum to be used for the selected elements.
*
* @param value A value object to be used as the datum for each element.
*/
datum<NewDatum>(value: NewDatum): Selection<GElement, NewDatum, PElement, PDatum>;
// Event Handling -------------------
/**
* Return the currently-assigned listener for the specified event typename on the first (non-null) selected element,
* if any, If multiple typenames are specified, the first matching listener is returned.
*
* @param typenames The typenames is a string event type, such as click, mouseover, or submit; any DOM event type supported by your browser may be used.
* The type may be optionally followed by a period (.) and a name; the optional name allows multiple callbacks to be registered
* to receive events of the same type, such as click.foo and click.bar. To specify multiple typenames, separate typenames with spaces,
* such as "input change"" or "click.foo click.bar".
*/
on(typenames: string): ((this: GElement, event: any, d: Datum) => void) | undefined;
/**
* Remove a listener for the specified event type names. To remove all listeners for a given name,
* pass null as the listener and ".foo" as the typename, where foo is the name; to remove all listeners with no name, specify "." as the typename.
*
* @param typenames The typenames is a string event type, such as click, mouseover, or submit; any DOM event type supported by your browser may be used.
* The type may be optionally followed by a period (.) and a name; the optional name allows multiple callbacks to be registered
* to receive events of the same type, such as click.foo and click.bar. To specify multiple typenames, separate typenames with spaces,
* such as "input change"" or "click.foo click.bar".
* @param listener null to indicate removal of listener
*/
on(typenames: string, listener: null): this;
/**
* Add an event listener for the specified event type names. If an event listener was previously registered for the same typename
* on a selected element, the old listener is removed before the new listener is added.
*
* When a specified event is dispatched on a selected node, the specified listener will be evaluated for each selected element.
*
* @param typenames The typenames is a string event type, such as click, mouseover, or submit; any DOM event type supported by your browser may be used.
* The type may be optionally followed by a period (.) and a name; the optional name allows multiple callbacks to be registered
* to receive events of the same type, such as click.foo and click.bar. To specify multiple typenames, separate typenames with spaces,
* such as "input change"" or "click.foo click.bar".
* @param listener A listener function which will be evaluated for each selected element,
* being passed the current event (event) and the current datum (d), with this as the current DOM element (event.currentTarget).
* Listeners always see the latest datum for their element.
* Note: while you can use event.pageX and event.pageY directly,
* it is often convenient to transform the event position to the local coordinate system of that element that received the event using d3.pointer.
* @param options An optional options object may specify characteristics about the event listener, such as wehether it is captures or passive; see element.addEventListener.
*/
on(typenames: string, listener: (this: GElement, event: any, d: Datum) => void, options?: any): this;
/**
* Dispatches a custom event of the specified type to each se