# @d3plus/core

[![NPM version](https://img.shields.io/npm/v/@d3plus/core.svg)](https://www.npmjs.com/package/@d3plus/core)
[![codecov](https://codecov.io/gh/d3plus/d3plus/graph/badge.svg?flag=core)](https://codecov.io/gh/d3plus/d3plus/flags)

Data visualization made easy. A javascript library that extends the popular D3.js to enable fast and beautiful visualizations.

## Installing

If using npm, `npm install @d3plus/core`. Otherwise, you can download the [latest release from GitHub](https://github.com/d3plus/d3plus/releases/latest) or load from a [CDN](https://cdn.jsdelivr.net/npm/@d3plus/core).

```js
import {*} from "@d3plus/core";
```

In a vanilla environment, a `d3plus` global is exported from the pre-bundled version:

```html
<script src="https://cdn.jsdelivr.net/npm/@d3plus/core"></script>
<script>
  console.log(d3plus);
</script>
```

## Examples

Live examples can be found on [d3plus.org](https://d3plus.org/), which includes a collection of example visualizations using [@d3plus/react](https://github.com/d3plus/d3plus/tree/main/packages/react).

## API Reference

| Classes | Description |
| --- | --- |
| [`Area`](#area) | Creates SVG areas based on an array of data. |
| [`AreaPlot`](#areaplot) | Creates an area plot based on an array of data. |
| [`Axis`](#axis) | Creates an SVG scale based on an array of data. |
| [`AxisBottom`](#axisbottom) | Shorthand method for creating an axis where the ticks are drawn below the horizontal domain path. Extends all functional |
| [`AxisLeft`](#axisleft) | Shorthand method for creating an axis where the ticks are drawn to the left of the vertical domain path. Extends all fun |
| [`AxisRight`](#axisright) | Shorthand method for creating an axis where the ticks are drawn to the right of the vertical domain path. Extends all fu |
| [`AxisTop`](#axistop) | Shorthand method for creating an axis where the ticks are drawn above the vertical domain path. Extends all functionalit |
| [`Bar`](#bar) | Creates SVG areas based on an array of data. |
| [`BarChart`](#barchart) | Creates a bar chart based on an array of data. |
| [`BaseClass`](#baseclass) | Provides shared configuration, event handling, and locale management inherited by all d3plus classes. |
| [`Box`](#box) | Creates SVG box based on an array of data. |
| [`BoxWhisker`](#boxwhisker) | Creates a simple box and whisker based on an array of data. |
| [`BumpChart`](#bumpchart) | Creates a bump chart based on an array of data. |
| [`Circle`](#circle) | Creates SVG circles based on an array of data. |
| [`ColorScale`](#colorscale) | Creates an SVG color scale based on an array of data. |
| [`Donut`](#donut) | Extends the Pie visualization to create a donut chart. |
| [`Geomap`](#geomap) | Creates a geographical map with zooming, panning, image tiles, and the ability to layer choropleth paths and coordinate  |
| [`Image`](#image) | Creates SVG images based on an array of data. |
| [`Legend`](#legend) | Creates an SVG legend based on an array of data. |
| [`Line`](#line) | Creates SVG lines based on an array of data. |
| [`LinePlot`](#lineplot) | Creates a line plot based on an array of data. |
| [`Matrix`](#matrix) | Creates a simple rows/columns Matrix view of any dataset. See [this example](https://d3plus.org/examples/d3plus-matrix/g |
| [`Network`](#network) | Creates a network visualization based on a defined set of nodes and edges. [Click here](http://d3plus.org/examples/d3plu |
| [`Pack`](#pack) | Uses the [d3 pack layout](https://github.com/d3/d3-hierarchy#pack) to creates Circle Packing chart based on an array of  |
| [`Path`](#path) | Creates SVG Paths based on an array of data. |
| [`Pie`](#pie) | Uses the [d3 pie layout](https://github.com/d3/d3-shape#pies) to creates SVG arcs based on an array of data. |
| [`Plot`](#plot) | Creates an x/y plot based on an array of data. |
| [`Priestley`](#priestley) | Creates a priestley timeline based on an array of data. |
| [`Radar`](#radar) | Creates a radar visualization based on an array of data. |
| [`RadialMatrix`](#radialmatrix) | Creates a radial layout of a rows/columns Matrix of any dataset. See [this example](https://d3plus.org/examples/d3plus-m |
| [`Rect`](#rect) | Creates SVG rectangles based on an array of data. See [this example](https://d3plus.org/examples/d3plus-shape/getting-st |
| [`Rings`](#rings) | Creates a ring visualization based on a defined set of nodes and edges. [Click here](http://d3plus.org/examples/d3plus-n |
| [`Sankey`](#sankey) | Creates a sankey visualization based on a defined set of nodes and links. [Click here](http://d3plus.org/examples/d3plus |
| [`Shape`](#shape) | An abstracted class for generating shapes. |
| [`StackedArea`](#stackedarea) | Creates a stacked area plot based on an array of data. |
| [`TextBox`](#textbox) | Creates a wrapped text box for each point in an array of data. See [this example](https://d3plus.org/examples/d3plus-tex |
| [`Timeline`](#timeline) | Creates an interactive timeline brush component for selecting time periods within a visualization. |
| [`Tooltip`](#tooltip) | Creates HTML tooltips in the body of a webpage. |
| [`Tree`](#tree) | Uses d3's [tree layout](https://github.com/d3/d3-hierarchy#tree) to create a tidy tree chart based on an array of data. |
| [`Treemap`](#treemap) | Uses the [d3 treemap layout](https://github.com/mbostock/d3/wiki/Treemap-Layout) to creates SVG rectangles based on an a |
| [`Viz`](#viz) | Creates an x/y plot based on an array of data. See [this example](https://d3plus.org/examples/d3plus-treemap/getting-sta |
| [`Whisker`](#whisker) | Creates SVG whisker based on an array of data. |

| Functions | Description |
| --- | --- |
| [`accessor`](#accessor) | Wraps an object key in a simple accessor function. |
| [`configPrep`](#configprep) | Preps a config object for d3plus data, and optionally bubbles up a specific nested type. When using this function, you m |
| [`constant`](#constant) | Wraps non-function variables in a simple return function. |

| Variables | Description |
| --- | --- |
| [`RESET`](#reset) | String constant used to reset an individual config property. |

| Interfaces | Description |
| --- | --- |
| [`AxisConfig`](#axisconfig) |  |
| [`D3plusConfig`](#d3plusconfig) |  |
| [`TooltipConfig`](#tooltipconfig) |  |

## Classes

<a id="area"></a>

### Area

Defined in: [shapes/Area.ts:17](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L17)

Creates SVG areas based on an array of data.

#### Extends

- [`Shape`](#shape-23)

#### Methods

<a id="active"></a>

##### active()

###### Call Signature

> **active**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

Defined in: [shapes/Shape.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1019)

The active callback function for highlighting shapes.

###### Returns

((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

###### Inherited from

[`Shape`](#shape-23).[`active`](#active-25)

###### Call Signature

> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1020](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1020)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`active`](#active-25)

<a id="activeopacity"></a>

##### activeOpacity()

###### Call Signature

> **activeOpacity**(): `number`

Defined in: [shapes/Shape.ts:1037](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1037)

When shapes are active, this is the opacity of any shape that is not active.

###### Returns

`number`

###### Inherited from

[`Shape`](#shape-23).[`activeOpacity`](#activeopacity-6)

###### Call Signature

> **activeOpacity**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1038](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1038)

When shapes are active, this is the opacity of any shape that is not active.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`activeOpacity`](#activeopacity-6)

<a id="activestyle"></a>

##### activeStyle()

###### Call Signature

> **activeStyle**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1048](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1048)

The style to apply to active shapes.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`activeStyle`](#activestyle-6)

###### Call Signature

> **activeStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1049](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1049)

The style to apply to active shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`activeStyle`](#activestyle-6)

<a id="arialabel"></a>

##### ariaLabel()

###### Call Signature

> **ariaLabel**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1059](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1059)

The aria-label attribute for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`ariaLabel`](#arialabel-6)

###### Call Signature

> **ariaLabel**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1060](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1060)

The aria-label attribute for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`ariaLabel`](#arialabel-6)

<a id="backgroundimage"></a>

##### backgroundImage()

###### Call Signature

> **backgroundImage**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1070](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1070)

The background-image accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`backgroundImage`](#backgroundimage-6)

###### Call Signature

> **backgroundImage**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1071](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1071)

The background-image accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`backgroundImage`](#backgroundimage-6)

<a id="config"></a>

##### config()

###### Call Signature

> **config**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L91)

Methods that correspond to the key/value pairs and returns this class.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`Shape`](#shape-23).[`config`](#config-15)

###### Call Signature

> **config**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L92)

Methods that correspond to the key/value pairs and returns this class.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`config`](#config-15)

<a id="curve"></a>

##### curve()

###### Call Signature

> **curve**(): `AccessorFn`

Defined in: [shapes/Area.ts:282](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L282)

The d3 curve function used to interpolate the area.

###### Returns

`AccessorFn`

###### Call Signature

> **curve**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Area.ts:283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L283)

The d3 curve function used to interpolate the area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

<a id="data"></a>

##### data()

###### Call Signature

> **data**(): `DataPoint`[]

Defined in: [shapes/Shape.ts:1082](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1082)

The data array used to create shapes. A shape will be drawn for each object in the array.

###### Returns

`DataPoint`[]

###### Inherited from

[`Shape`](#shape-23).[`data`](#data-32)

###### Call Signature

> **data**(`_`: `DataPoint`[]): `this`

Defined in: [shapes/Shape.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1083)

The data array used to create shapes. A shape will be drawn for each object in the array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `DataPoint`[] |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`data`](#data-32)

<a id="defined"></a>

##### defined()

###### Call Signature

> **defined**(): (`d`: `DataPoint`) => `boolean`

Defined in: [shapes/Area.ts:293](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L293)

An accessor function that determines whether a data point is defined (not a gap in the area).

###### Returns

(`d`: `DataPoint`) => `boolean`

###### Call Signature

> **defined**(`_`: (`d`: `DataPoint`) => `boolean`): `this`

Defined in: [shapes/Area.ts:294](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L294)

An accessor function that determines whether a data point is defined (not a gap in the area).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `DataPoint`) => `boolean` |

###### Returns

`this`

<a id="discrete"></a>

##### discrete()

###### Call Signature

> **discrete**(): `string` \| `undefined`

Defined in: [shapes/Shape.ts:1091](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1091)

Determines if either the X or Y position is discrete along a Line, which helps in determining the nearest data point on a line for a hit area event.

###### Returns

`string` \| `undefined`

###### Inherited from

[`Shape`](#shape-23).[`discrete`](#discrete-23)

###### Call Signature

> **discrete**(`_`: `string`): `this`

Defined in: [shapes/Shape.ts:1092](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1092)

Determines if either the X or Y position is discrete along a Line, which helps in determining the nearest data point on a line for a hit area event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`discrete`](#discrete-23)

<a id="duration"></a>

##### duration()

###### Call Signature

> **duration**(): `number`

Defined in: [shapes/Shape.ts:1100](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1100)

The animation duration in milliseconds.

###### Returns

`number`

###### Inherited from

[`Shape`](#shape-23).[`duration`](#duration-31)

###### Call Signature

> **duration**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1101](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1101)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`duration`](#duration-31)

<a id="fill"></a>

##### fill()

###### Call Signature

> **fill**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1109](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1109)

The fill color accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`fill`](#fill-6)

###### Call Signature

> **fill**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1110](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1110)

The fill color accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`fill`](#fill-6)

<a id="fillopacity"></a>

##### fillOpacity()

###### Call Signature

> **fillOpacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1120](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1120)

Defines the "fill-opacity" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`fillOpacity`](#fillopacity-6)

###### Call Signature

> **fillOpacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1121](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1121)

Defines the "fill-opacity" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`fillOpacity`](#fillopacity-6)

<a id="hitarea"></a>

##### hitArea()

###### Call Signature

> **hitArea**(): ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) \| `null`

Defined in: [shapes/Shape.ts:1180](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1180)

The mouse hit area accessor function.

###### Returns

((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) \| `null`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`hitArea`](#hitarea-6)

###### Call Signature

> **hitArea**(`_`: `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>)): `this`

Defined in: [shapes/Shape.ts:1187](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1187)

The mouse hit area accessor function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) |

###### Returns

`this`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`hitArea`](#hitarea-6)

<a id="hover"></a>

##### hover()

###### Call Signature

> **hover**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

Defined in: [shapes/Shape.ts:1131](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1131)

The hover callback function for highlighting shapes on mouseover.

###### Returns

((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

###### Inherited from

[`Shape`](#shape-23).[`hover`](#hover-25)

###### Call Signature

> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1132](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1132)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`hover`](#hover-25)

<a id="hoveropacity"></a>

##### hoverOpacity()

###### Call Signature

> **hoverOpacity**(): `number`

Defined in: [shapes/Shape.ts:1160](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1160)

The opacity of non-hovered shapes when any shape is hovered.

###### Returns

`number`

###### Inherited from

[`Shape`](#shape-23).[`hoverOpacity`](#hoveropacity-6)

###### Call Signature

> **hoverOpacity**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1161](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1161)

The opacity of non-hovered shapes when any shape is hovered.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`hoverOpacity`](#hoveropacity-6)

<a id="hoverstyle"></a>

##### hoverStyle()

###### Call Signature

> **hoverStyle**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1149](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1149)

The style to apply to hovered shapes.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`hoverStyle`](#hoverstyle-6)

###### Call Signature

> **hoverStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1150)

The style to apply to hovered shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`hoverStyle`](#hoverstyle-6)

<a id="id"></a>

##### id()

###### Call Signature

> **id**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1220](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1220)

The unique id accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`id`](#id-8)

###### Call Signature

> **id**(`_`: `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1221](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1221)

The unique id accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`id`](#id-8)

<a id="label"></a>

##### label()

###### Call Signature

> **label**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1229](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1229)

The text label accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`label`](#label-24)

###### Call Signature

> **label**(`_`: `string` \| `string`[] \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1230](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1230)

The text label accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `string`[] \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`label`](#label-24)

<a id="labelbounds"></a>

##### labelBounds()

###### Call Signature

> **labelBounds**(): ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null`

Defined in: [shapes/Shape.ts:1251](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1251)

The label bounds accessor function.

###### Returns

((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`labelBounds`](#labelbounds-6)

###### Call Signature

> **labelBounds**(`_`: `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`)): `this`

Defined in: [shapes/Shape.ts:1258](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1258)

The label bounds accessor function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) |

###### Returns

`this`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`labelBounds`](#labelbounds-6)

<a id="labelconfig"></a>

##### labelConfig()

###### Call Signature

> **labelConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1291](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1291)

A pass-through to the config method of the TextBox class used to create a shape's labels.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`labelConfig`](#labelconfig-7)

###### Call Signature

> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1292](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1292)

A pass-through to the config method of the TextBox class used to create a shape's labels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`labelConfig`](#labelconfig-7)

<a id="locale"></a>

##### locale()

###### Call Signature

> **locale**(): `string`

Defined in: [utils/BaseClass.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L156)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Returns

`string`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Shape`](#shape-23).[`locale`](#locale-15)

###### Call Signature

> **locale**(`_`: `string` \| `object`): `this`

Defined in: [utils/BaseClass.ts:157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L157)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `object` |

###### Returns

`this`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Shape`](#shape-23).[`locale`](#locale-15)

<a id="on"></a>

##### on()

###### Call Signature

> **on**(): `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

Defined in: [utils/BaseClass.ts:176](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L176)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Returns

`Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

###### Call Signature

> **on**(`_`: `string`): ((...`args`: `unknown`[]) => `unknown`) \| `undefined`

Defined in: [utils/BaseClass.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L177)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

((...`args`: `unknown`[]) => `unknown`) \| `undefined`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

###### Call Signature

> **on**(`_`: `string`, `f`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [utils/BaseClass.ts:178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L178)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |
| `f` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

###### Call Signature

> **on**(`_`: `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:179](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L179)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

<a id="opacity"></a>

##### opacity()

###### Call Signature

> **opacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1302](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1302)

The opacity accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`opacity`](#opacity-7)

###### Call Signature

> **opacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1303](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1303)

The opacity accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`opacity`](#opacity-7)

<a id="parent"></a>

##### parent()

###### Call Signature

> **parent**(): `Record`\<`string`, `unknown`\>

Defined in: [utils/BaseClass.ts:200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L200)

Parent config used by the wrapper.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`parent`](#parent-15)

###### Call Signature

> **parent**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L201)

Parent config used by the wrapper.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`parent`](#parent-15)

<a id="pointerevents"></a>

##### pointerEvents()

###### Call Signature

> **pointerEvents**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1313](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1313)

The pointer-events CSS property for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`pointerEvents`](#pointerevents-7)

###### Call Signature

> **pointerEvents**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1314](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1314)

The pointer-events CSS property for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`pointerEvents`](#pointerevents-7)

<a id="render"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [shapes/Area.ts:171](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L171)

Draws the area polygons.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Overrides

[`Shape`](#shape-23).[`render`](#render-32)

<a id="role"></a>

##### role()

###### Call Signature

> **role**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1325](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1325)

The role attribute.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`role`](#role-6)

###### Call Signature

> **role**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1326](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1326)

The role attribute.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`role`](#role-6)

<a id="rotate"></a>

##### rotate()

###### Call Signature

> **rotate**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1336](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1336)

The rotation angle in degrees for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`rotate`](#rotate-6)

###### Call Signature

> **rotate**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1337](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1337)

The rotation angle in degrees for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`rotate`](#rotate-6)

<a id="rx"></a>

##### rx()

###### Call Signature

> **rx**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1347](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1347)

Defines the "rx" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`rx`](#rx-6)

###### Call Signature

> **rx**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1348](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1348)

Defines the "rx" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`rx`](#rx-6)

<a id="ry"></a>

##### ry()

###### Call Signature

> **ry**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1358](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1358)

Defines the "rx" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`ry`](#ry-6)

###### Call Signature

> **ry**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1359](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1359)

Defines the "rx" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`ry`](#ry-6)

<a id="scale"></a>

##### scale()

###### Call Signature

> **scale**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1369](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1369)

The scale transform accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`scale`](#scale-12)

###### Call Signature

> **scale**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1370](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1370)

The scale transform accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`scale`](#scale-12)

<a id="select"></a>

##### select()

###### Call Signature

> **select**(): `Selection`

Defined in: [shapes/Shape.ts:1380](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1380)

The SVG container element as a d3 selector or DOM element.

###### Returns

`Selection`

###### Inherited from

[`Shape`](#shape-23).[`select`](#select-32)

###### Call Signature

> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`

Defined in: [shapes/Shape.ts:1381](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1381)

The SVG container element as a d3 selector or DOM element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `HTMLElement` \| `SVGElement` \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`select`](#select-32)

<a id="shapeconfig"></a>

##### shapeConfig()

###### Call Signature

> **shapeConfig**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L225)

Configuration object with key/value pairs applied as method calls on each shape.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`Shape`](#shape-23).[`shapeConfig`](#shapeconfig-33)

###### Call Signature

> **shapeConfig**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:226](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L226)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`shapeConfig`](#shapeconfig-33)

<a id="shaperendering"></a>

##### shapeRendering()

###### Call Signature

> **shapeRendering**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1396](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1396)

The shape-rendering.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`shapeRendering`](#shaperendering-6)

###### Call Signature

> **shapeRendering**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1397)

The shape-rendering.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`shapeRendering`](#shaperendering-6)

<a id="sort"></a>

##### sort()

###### Call Signature

> **sort**(): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`

Defined in: [shapes/Shape.ts:1408](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1408)

A comparator function used to sort shapes for layering order.

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`

###### Inherited from

[`Shape`](#shape-23).[`sort`](#sort-9)

###### Call Signature

> **sort**(`_`: ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1409](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1409)

A comparator function used to sort shapes for layering order.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`sort`](#sort-9)

<a id="stroke"></a>

##### stroke()

###### Call Signature

> **stroke**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1419](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1419)

The stroke color accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`stroke`](#stroke-6)

###### Call Signature

> **stroke**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1420](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1420)

The stroke color accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`stroke`](#stroke-6)

<a id="strokedasharray"></a>

##### strokeDasharray()

###### Call Signature

> **strokeDasharray**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1430](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1430)

Defines the "stroke-dasharray" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeDasharray`](#strokedasharray-6)

###### Call Signature

> **strokeDasharray**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1431](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1431)

Defines the "stroke-dasharray" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeDasharray`](#strokedasharray-6)

<a id="strokelinecap"></a>

##### strokeLinecap()

###### Call Signature

> **strokeLinecap**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1442](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1442)

Defines the "stroke-linecap" attribute for the shapes. Accepted values are `"butt"`, `"round"`, and `"square"`.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeLinecap`](#strokelinecap-6)

###### Call Signature

> **strokeLinecap**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1443](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1443)

Defines the "stroke-linecap" attribute for the shapes. Accepted values are `"butt"`, `"round"`, and `"square"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeLinecap`](#strokelinecap-6)

<a id="strokeopacity"></a>

##### strokeOpacity()

###### Call Signature

> **strokeOpacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1454](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1454)

Defines the "stroke-opacity" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeOpacity`](#strokeopacity-6)

###### Call Signature

> **strokeOpacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1455](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1455)

Defines the "stroke-opacity" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeOpacity`](#strokeopacity-6)

<a id="strokewidth"></a>

##### strokeWidth()

###### Call Signature

> **strokeWidth**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1466](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1466)

The stroke-width.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeWidth`](#strokewidth-6)

###### Call Signature

> **strokeWidth**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1467](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1467)

The stroke-width.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeWidth`](#strokewidth-6)

<a id="textanchor"></a>

##### textAnchor()

###### Call Signature

> **textAnchor**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1477](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1477)

The text-anchor.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`textAnchor`](#textanchor-6)

###### Call Signature

> **textAnchor**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1478](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1478)

The text-anchor.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`textAnchor`](#textanchor-6)

<a id="texture"></a>

##### texture()

###### Call Signature

> **texture**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1488](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1488)

Defines the texture used inside of each shape. This uses the [textures.js](https://riccardoscalco.it/textures/) package, and expects either a simple string (`"lines"` or `"circles"`) or a more complex Object containing the various properties of the texture (ie. `{texture: "lines", orientation: "3/8", stroke: "darkorange"}`). If multiple textures are necessary, provide an accsesor Function that returns the correct String/Object for each given data point and index.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`texture`](#texture-6)

###### Call Signature

> **texture**(`_`: `string` \| `Record`\<`string`, `unknown`\> \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1489](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1489)

Defines the texture used inside of each shape. This uses the [textures.js](https://riccardoscalco.it/textures/) package, and expects either a simple string (`"lines"` or `"circles"`) or a more complex Object containing the various properties of the texture (ie. `{texture: "lines", orientation: "3/8", stroke: "darkorange"}`). If multiple textures are necessary, provide an accsesor Function that returns the correct String/Object for each given data point and index.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `Record`\<`string`, `unknown`\> \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`texture`](#texture-6)

<a id="texturedefault"></a>

##### textureDefault()

###### Call Signature

> **textureDefault**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1503)

A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`textureDefault`](#texturedefault-6)

###### Call Signature

> **textureDefault**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1504](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1504)

A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`textureDefault`](#texturedefault-6)

<a id="translate"></a>

##### translate()

###### Call Signature

> **translate**(): (`d`: `string`, `locale?`: `string`) => `string`

Defined in: [utils/BaseClass.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L214)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Returns

(`d`: `string`, `locale?`: `string`) => `string`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Shape`](#shape-23).[`translate`](#translate-15)

###### Call Signature

> **translate**(`_`: (`d`: `string`, `locale?`: `string`) => `string`): `this`

Defined in: [utils/BaseClass.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L215)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `string`, `locale?`: `string`) => `string` |

###### Returns

`this`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Shape`](#shape-23).[`translate`](#translate-15)

<a id="vectoreffect"></a>

##### vectorEffect()

###### Call Signature

> **vectorEffect**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1514](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1514)

The vector-effect.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`vectorEffect`](#vectoreffect-6)

###### Call Signature

> **vectorEffect**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1515](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1515)

The vector-effect.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`vectorEffect`](#vectoreffect-6)

<a id="verticalalign"></a>

##### verticalAlign()

###### Call Signature

> **verticalAlign**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1525](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1525)

The vertical alignment.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`verticalAlign`](#verticalalign-7)

###### Call Signature

> **verticalAlign**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1526](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1526)

The vertical alignment.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`verticalAlign`](#verticalalign-7)

<a id="x"></a>

##### x()

###### Call Signature

> **x**(): `AccessorFn`

Defined in: [shapes/Area.ts:302](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L302)

The x position accessor. Also sets x0 to the same value.

###### Returns

`AccessorFn`

###### Overrides

[`Shape`](#shape-23).[`x`](#x-15)

###### Call Signature

> **x**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Area.ts:303](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L303)

The x position accessor. Also sets x0 to the same value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Overrides

[`Shape`](#shape-23).[`x`](#x-15)

<a id="x0"></a>

##### x0()

###### Call Signature

> **x0**(): `AccessorFn`

Defined in: [shapes/Area.ts:314](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L314)

The x0 (left edge) position accessor for the area.

###### Returns

`AccessorFn`

###### Call Signature

> **x0**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Area.ts:315](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L315)

The x0 (left edge) position accessor for the area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

<a id="x1"></a>

##### x1()

###### Call Signature

> **x1**(): `AccessorFn` \| `null`

Defined in: [shapes/Area.ts:327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L327)

The x1 (right edge) position accessor for the area.

###### Returns

`AccessorFn` \| `null`

###### Call Signature

> **x1**(`_`: `number` \| `AccessorFn` \| `null`): `this`

Defined in: [shapes/Area.ts:328](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L328)

The x1 (right edge) position accessor for the area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` \| `null` |

###### Returns

`this`

<a id="y"></a>

##### y()

###### Call Signature

> **y**(): `AccessorFn`

Defined in: [shapes/Area.ts:344](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L344)

The y position accessor. Also sets y0 to the same value.

###### Returns

`AccessorFn`

###### Overrides

[`Shape`](#shape-23).[`y`](#y-15)

###### Call Signature

> **y**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Area.ts:345](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L345)

The y position accessor. Also sets y0 to the same value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Overrides

[`Shape`](#shape-23).[`y`](#y-15)

<a id="y0"></a>

##### y0()

###### Call Signature

> **y0**(): `AccessorFn`

Defined in: [shapes/Area.ts:356](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L356)

The y0 (top edge) position accessor for the area.

###### Returns

`AccessorFn`

###### Call Signature

> **y0**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Area.ts:357](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L357)

The y0 (top edge) position accessor for the area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

<a id="y1"></a>

##### y1()

###### Call Signature

> **y1**(): `AccessorFn` \| `null`

Defined in: [shapes/Area.ts:369](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L369)

The y1 (bottom edge) position accessor for the area.

###### Returns

`AccessorFn` \| `null`

###### Call Signature

> **y1**(`_`: `number` \| `AccessorFn` \| `null`): `this`

Defined in: [shapes/Area.ts:370](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L370)

The y1 (bottom edge) position accessor for the area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` \| `null` |

###### Returns

`this`

#### Properties

| Property | Type | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="property-_active"></a> `_active` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | - | [`Shape`](#shape-23).[`_active`](#property-_active-6) | [shapes/Shape.ts:116](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L116) |
| <a id="property-_activegroup"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-23).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:112](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L112) |
| <a id="property-_activeopacity"></a> `_activeOpacity` | `number` | - | [`Shape`](#shape-23).[`_activeOpacity`](#property-_activeopacity-6) | [shapes/Shape.ts:57](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L57) |
| <a id="property-_activestyle"></a> `_activeStyle` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_activeStyle`](#property-_activestyle-6) | [shapes/Shape.ts:58](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L58) |
| <a id="property-_arialabel"></a> `_ariaLabel` | `AccessorFn` | - | [`Shape`](#shape-23).[`_ariaLabel`](#property-_arialabel-6) | [shapes/Shape.ts:59](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L59) |
| <a id="property-_backgroundimage"></a> `_backgroundImage` | `AccessorFn` | - | [`Shape`](#shape-23).[`_backgroundImage`](#property-_backgroundimage-6) | [shapes/Shape.ts:60](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L60) |
| <a id="property-_backgroundimageclass"></a> `_backgroundImageClass` | [`Image`](#image) | - | [`Shape`](#shape-23).[`_backgroundImageClass`](#property-_backgroundimageclass-6) | [shapes/Shape.ts:61](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L61) |
| <a id="property-_configdefault"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | - | [`Shape`](#shape-23).[`_configDefault`](#property-_configdefault-15) | [utils/BaseClass.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L69) |
| <a id="property-_curve"></a> `_curve` | `AccessorFn` | [`Shape`](#shape-23).[`_curve`](#property-_curve-6) | - | [shapes/Area.ts:18](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L18) |
| <a id="property-_data"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-23).[`_data`](#property-_data-15) | [shapes/Shape.ts:62](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L62) |
| <a id="property-_defined"></a> `_defined` | (`d`: `DataPoint`) => `boolean` | [`Shape`](#shape-23).[`_defined`](#property-_defined-6) | - | [shapes/Area.ts:19](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L19) |
| <a id="property-_discrete"></a> `_discrete` | `string` \| *required* | - | [`Shape`](#shape-23).[`_discrete`](#property-_discrete-6) | [shapes/Shape.ts:118](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L118) |
| <a id="property-_duration"></a> `_duration` | `number` | - | [`Shape`](#shape-23).[`_duration`](#property-_duration-15) | [shapes/Shape.ts:63](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L63) |
| <a id="property-_enter"></a> `_enter` | `Selection` | - | [`Shape`](#shape-23).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:109](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L109) |
| <a id="property-_exit"></a> `_exit` | `Selection` | - | [`Shape`](#shape-23).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:110](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L110) |
| <a id="property-_fill"></a> `_fill` | `AccessorFn` | - | [`Shape`](#shape-23).[`_fill`](#property-_fill-6) | [shapes/Shape.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L64) |
| <a id="property-_fillopacity"></a> `_fillOpacity` | `AccessorFn` | - | [`Shape`](#shape-23).[`_fillOpacity`](#property-_fillopacity-6) | [shapes/Shape.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L65) |
| <a id="property-_group"></a> `_group` | `Selection` | - | [`Shape`](#shape-23).[`_group`](#property-_group-13) | [shapes/Shape.ts:107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L107) |
| <a id="property-_hitarea"></a> `_hitArea` | ((`d`: `DataPoint`, `i`: `number`, `aes`: `ShapeAes`) => `Record`\<`string`, `unknown`\>) \| `null` | - | [`Shape`](#shape-23).[`_hitArea`](#property-_hitarea-6) | [shapes/Shape.ts:113](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L113) |
| <a id="property-_hover"></a> `_hover` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | - | [`Shape`](#shape-23).[`_hover`](#property-_hover-6) | [shapes/Shape.ts:117](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L117) |
| <a id="property-_hovergroup"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-23).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:111](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L111) |
| <a id="property-_hoveropacity"></a> `_hoverOpacity` | `number` | - | [`Shape`](#shape-23).[`_hoverOpacity`](#property-_hoveropacity-6) | [shapes/Shape.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L66) |
| <a id="property-_hoverstyle"></a> `_hoverStyle` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_hoverStyle`](#property-_hoverstyle-6) | [shapes/Shape.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L67) |
| <a id="property-_id"></a> `_id` | `AccessorFn` | - | [`Shape`](#shape-23).[`_id`](#property-_id-8) | [shapes/Shape.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L68) |
| <a id="property-_label"></a> `_label` | `AccessorFn` | - | [`Shape`](#shape-23).[`_label`](#property-_label-7) | [shapes/Shape.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L69) |
| <a id="property-_labelbounds"></a> `_labelBounds` | ((`d`: `DataPoint`, `i`: `number`, `aes`: `ShapeAes`) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null` | [`Shape`](#shape-23).[`_labelBounds`](#property-_labelbounds-6) | - | [shapes/Area.ts:20](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L20) |
| <a id="property-_labelclass"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-23).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L70) |
| <a id="property-_labelconfig"></a> `_labelConfig` | `Record`\<`string`, `unknown`\> | [`Shape`](#shape-23).[`_labelConfig`](#property-_labelconfig-7) | - | [shapes/Area.ts:27](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L27) |
| <a id="property-_locale"></a> `_locale` | `string` | - | [`Shape`](#shape-23).[`_locale`](#property-_locale-15) | [utils/BaseClass.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L64) |
| <a id="property-_name"></a> `_name` | `string` | [`Shape`](#shape-23).[`_name`](#property-_name-6) | - | [shapes/Area.ts:28](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L28) |
| <a id="property-_on"></a> `_on` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | - | [`Shape`](#shape-23).[`_on`](#property-_on-15) | [utils/BaseClass.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L65) |
| <a id="property-_opacity"></a> `_opacity` | `AccessorFn` | - | [`Shape`](#shape-23).[`_opacity`](#property-_opacity-7) | [shapes/Shape.ts:80](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L80) |
| <a id="property-_parent"></a> `_parent` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_parent`](#property-_parent-15) | [utils/BaseClass.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L66) |
| <a id="property-_path"></a> `_path` | `Record`\<`string`, `unknown`\> | [`Shape`](#shape-23).[`_path`](#property-_path-6) | - | [shapes/Area.ts:35](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L35) |
| <a id="property-_pointerevents"></a> `_pointerEvents` | `AccessorFn` | - | [`Shape`](#shape-23).[`_pointerEvents`](#property-_pointerevents-7) | [shapes/Shape.ts:81](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L81) |
| <a id="property-_role"></a> `_role` | `AccessorFn` | - | [`Shape`](#shape-23).[`_role`](#property-_role-6) | [shapes/Shape.ts:82](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L82) |
| <a id="property-_rotate"></a> `_rotate` | `AccessorFn` | - | [`Shape`](#shape-23).[`_rotate`](#property-_rotate-6) | [shapes/Shape.ts:83](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L83) |
| <a id="property-_rx"></a> `_rx` | `AccessorFn` | - | [`Shape`](#shape-23).[`_rx`](#property-_rx-6) | [shapes/Shape.ts:84](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L84) |
| <a id="property-_ry"></a> `_ry` | `AccessorFn` | - | [`Shape`](#shape-23).[`_ry`](#property-_ry-6) | [shapes/Shape.ts:85](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L85) |
| <a id="property-_scale"></a> `_scale` | `AccessorFn` | - | [`Shape`](#shape-23).[`_scale`](#property-_scale-12) | [shapes/Shape.ts:86](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L86) |
| <a id="property-_select"></a> `_select` | `Selection` | - | [`Shape`](#shape-23).[`_select`](#property-_select-15) | [shapes/Shape.ts:102](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L102) |
| <a id="property-_shapeconfig"></a> `_shapeConfig?` | [`D3plusConfig`](#d3plusconfig) | - | [`Shape`](#shape-23).[`_shapeConfig`](#property-_shapeconfig-15) | [utils/BaseClass.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L70) |
| <a id="property-_shaperendering"></a> `_shapeRendering` | `AccessorFn` | - | [`Shape`](#shape-23).[`_shapeRendering`](#property-_shaperendering-6) | [shapes/Shape.ts:87](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L87) |
| <a id="property-_sort"></a> `_sort` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | - | [`Shape`](#shape-23).[`_sort`](#property-_sort-6) | [shapes/Shape.ts:106](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L106) |
| <a id="property-_stroke"></a> `_stroke` | `AccessorFn` | - | [`Shape`](#shape-23).[`_stroke`](#property-_stroke-6) | [shapes/Shape.ts:88](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L88) |
| <a id="property-_strokedasharray"></a> `_strokeDasharray` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeDasharray`](#property-_strokedasharray-6) | [shapes/Shape.ts:89](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L89) |
| <a id="property-_strokelinecap"></a> `_strokeLinecap` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeLinecap`](#property-_strokelinecap-6) | [shapes/Shape.ts:90](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L90) |
| <a id="property-_strokeopacity"></a> `_strokeOpacity` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeOpacity`](#property-_strokeopacity-6) | [shapes/Shape.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L91) |
| <a id="property-_strokewidth"></a> `_strokeWidth` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeWidth`](#property-_strokewidth-6) | [shapes/Shape.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L92) |
| <a id="property-_tagname"></a> `_tagName` | `string` | - | [`Shape`](#shape-23).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:93](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L93) |
| <a id="property-_textanchor"></a> `_textAnchor` | `AccessorFn` | - | [`Shape`](#shape-23).[`_textAnchor`](#property-_textanchor-6) | [shapes/Shape.ts:94](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L94) |
| <a id="property-_texture"></a> `_texture` | `AccessorFn` | - | [`Shape`](#shape-23).[`_texture`](#property-_texture-6) | [shapes/Shape.ts:95](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L95) |
| <a id="property-_texturedefault"></a> `_textureDefault` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_textureDefault`](#property-_texturedefault-6) | [shapes/Shape.ts:96](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L96) |
| <a id="property-_texturedefs"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-23).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:97](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L97) |
| <a id="property-_transition"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-23).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:103](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L103) |
| <a id="property-_translate"></a> `_translate` | (`d`: `string`, `locale?`: `string`) => `string` | - | [`Shape`](#shape-23).[`_translate`](#property-_translate-15) | [utils/BaseClass.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L67) |
| <a id="property-_update"></a> `_update` | `Selection` | - | [`Shape`](#shape-23).[`_update`](#property-_update-6) | [shapes/Shape.ts:108](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L108) |
| <a id="property-_uuid"></a> `_uuid` | `string` | - | [`Shape`](#shape-23).[`_uuid`](#property-_uuid-15) | [utils/BaseClass.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L68) |
| <a id="property-_vectoreffect"></a> `_vectorEffect` | `AccessorFn` | - | [`Shape`](#shape-23).[`_vectorEffect`](#property-_vectoreffect-6) | [shapes/Shape.ts:98](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L98) |
| <a id="property-_verticalalign"></a> `_verticalAlign` | `AccessorFn` | - | [`Shape`](#shape-23).[`_verticalAlign`](#property-_verticalalign-7) | [shapes/Shape.ts:99](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L99) |
| <a id="property-_x"></a> `_x` | `AccessorFn` | [`Shape`](#shape-23).[`_x`](#property-_x-8) | - | [shapes/Area.ts:29](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L29) |
| <a id="property-_x0"></a> `_x0` | `AccessorFn` | - | - | [shapes/Area.ts:30](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L30) |
| <a id="property-_x1"></a> `_x1` | `AccessorFn` \| `null` | - | - | [shapes/Area.ts:31](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L31) |
| <a id="property-_y"></a> `_y` | `AccessorFn` | [`Shape`](#shape-23).[`_y`](#property-_y-8) | - | [shapes/Area.ts:32](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L32) |
| <a id="property-_y0"></a> `_y0` | `AccessorFn` | - | - | [shapes/Area.ts:33](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L33) |
| <a id="property-_y1"></a> `_y1` | `AccessorFn` \| `null` | - | - | [shapes/Area.ts:34](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Area.ts#L34) |

***

<a id="areaplot"></a>

### AreaPlot

Defined in: [charts/AreaPlot.ts:13](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/AreaPlot.ts#L13)

Creates an area plot based on an array of data.

#### Example

```ts
new d3plus.Plot()
.baseline(0)
.discrete("x")
.shape("Area")
```

#### Extends

- [`Plot`](#plot)

#### Extended by

- [`StackedArea`](#stackedarea)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-1"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

###### Inherited from

[`Plot`](#plot).[`active`](#active-18)

<a id="aggs"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Plot`](#plot).[`aggs`](#aggs-11)

<a id="annotations"></a>

##### annotations()

> **annotations**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2004](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2004)

Allows drawing custom shapes to be used as annotations in the provided x/y plot. This method accepts custom config objects for the [Shape](http://d3plus.org/docs/#Shape) class, either a single config object or an array of config objects. Each config object requires an additional parameter, the "shape", which denotes which [Shape](http://d3plus.org/docs/#Shape) sub-class to use ([Rect](http://d3plus.org/docs/#Rect), [Line](http://d3plus.org/docs/#Line), etc).

Additionally, each config object can also contain an optional "layer" key, which defines whether the annotations will be displayed in "front" or in "back" of the primary visualization shapes. This value defaults to "back" if not present.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`annotations`](#annotations-5)

<a id="ariahidden"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`ariaHidden`](#ariahidden-11)

<a id="attribution"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`attribution`](#attribution-11)

<a id="attributionstyle"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Plot`](#plot).[`attributionStyle`](#attributionstyle-11)

<a id="axispersist"></a>

##### axisPersist()

> **axisPersist**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2013](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2013)

Determines whether the x and y axes should have their scales persist while users filter the data, the timeline being the prime example (set this to `true` to make the axes stay consistent when the timeline changes).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`axisPersist`](#axispersist-5)

<a id="backconfig"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Plot`](#plot).[`backConfig`](#backconfig-11)

<a id="backgroundconfig"></a>

##### backgroundConfig()

> **backgroundConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2022](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2022)

A d3plus-shape configuration Object used for styling the background rectangle of the inner x/y plot (behind all of the shapes and gridlines).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`backgroundConfig`](#backgroundconfig-5)

<a id="barpadding"></a>

##### barPadding()

> **barPadding**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2031](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2031)

The pixel space between each bar in a group of bars.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`barPadding`](#barpadding-5)

<a id="baseline"></a>

##### baseline()

> **baseline**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2038](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2038)

The baseline for the x/y plot.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`baseline`](#baseline-5)

<a id="buffer"></a>

##### buffer()

> **buffer**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2045](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2045)

Determines whether or not to add additional padding at the ends of x or y scales. The most commone use for this is in Scatter Plots, so that the shapes do not appear directly on the axis itself. The value provided can either be `true` or `false` to toggle the behavior for all shape types, or a keyed Object for each shape type (ie. `{Bar: false, Circle: true, Line: false}`).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`buffer`](#buffer-5)

<a id="cache"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`cache`](#cache-11)

<a id="color"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

###### Inherited from

[`Plot`](#plot).[`color`](#color-12)

<a id="colorscale"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

###### Inherited from

[`Plot`](#plot).[`colorScale`](#colorscale-12)

<a id="colorscaleconfig"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Plot`](#plot).[`colorScaleConfig`](#colorscaleconfig-12)

<a id="colorscalemaxsize"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`colorScaleMaxSize`](#colorscalemaxsize-11)

<a id="colorscalepadding"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`AreaPlot`](#areaplot) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`AreaPlot`](#areaplot) \| (() => `boolean`)

###### Inherited from

[`Plot`](#plot).[`colorScalePadding`](#colorscalepadding-12)

<a id="colorscaleposition"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| [`AreaPlot`](#areaplot) \| (() => `string` \| `boolean`)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| [`AreaPlot`](#areaplot) \| (() => `string` \| `boolean`)

###### Inherited from

[`Plot`](#plot).[`colorScalePosition`](#colorscaleposition-11)

<a id="confidence"></a>

##### confidence()

> **confidence**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2073](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2073)

The confidence interval as an array of [lower, upper] bounds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Example

```ts
var data = {id: "alpha", value: 10, lci: 9, hci: 11};
...
// Accessor functions
.confidence([function(d) { return d.lci }, function(d) { return d.hci }])

// Or static keys
.confidence(["lci", "hci"])
```

###### Inherited from

[`Plot`](#plot).[`confidence`](#confidence-5)

<a id="confidenceconfig"></a>

##### confidenceConfig()

> **confidenceConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2090](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2090)

Configuration object for shapes rendered as confidence intervals.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`confidenceConfig`](#confidenceconfig-5)

<a id="data-1"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): [`AreaPlot`](#areaplot) \| `DataPoint`[]

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

[`AreaPlot`](#areaplot) \| `DataPoint`[]

###### Inherited from

[`Plot`](#plot).[`data`](#data-25)

<a id="datacutoff"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`dataCutoff`](#datacutoff-11)

<a id="depth"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`depth`](#depth-11)

<a id="destroy"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

###### Inherited from

[`Plot`](#plot).[`destroy`](#destroy-11)

<a id="detectresize"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`detectResize`](#detectresize-11)

<a id="detectresizedelay"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`detectResizeDelay`](#detectresizedelay-11)

<a id="detectvisible"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`detectVisible`](#detectvisible-11)

<a id="detectvisibleinterval"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`detectVisibleInterval`](#detectvisibleinterval-11)

<a id="discrete-1"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`discrete`](#discrete-16)

<a id="discretecutoff"></a>

##### discreteCutoff()

> **discreteCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2099](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2099)

When the width or height of the chart is less than or equal to this pixel value, the discrete axis will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`discreteCutoff`](#discretecutoff-5)

<a id="downloadbutton"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`downloadButton`](#downloadbutton-11)

<a id="downloadconfig"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Plot`](#plot).[`downloadConfig`](#downloadconfig-11)

<a id="downloadposition"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`downloadPosition`](#downloadposition-11)

<a id="duration-1"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`duration`](#duration-24)

<a id="filter"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

###### Inherited from

[`Plot`](#plot).[`filter`](#filter-11)

<a id="fontfamily"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| [`AreaPlot`](#areaplot) \| `string`[]

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| [`AreaPlot`](#areaplot) \| `string`[]

###### Inherited from

[`Plot`](#plot).[`fontFamily`](#fontfamily-11)

<a id="groupby"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): [`AreaPlot`](#areaplot) \| (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[]

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

[`AreaPlot`](#areaplot) \| (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[]

###### Inherited from

[`Plot`](#plot).[`groupBy`](#groupby-11)

<a id="grouppadding"></a>

##### groupPadding()

> **groupPadding**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2108](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2108)

The pixel space between groups of bars.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`groupPadding`](#grouppadding-5)

<a id="height"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`height`](#height-20)

<a id="hiddencolor"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

###### Inherited from

[`Plot`](#plot).[`hiddenColor`](#hiddencolor-11)

<a id="hiddenopacity"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `number`)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `number`)

###### Inherited from

[`Plot`](#plot).[`hiddenOpacity`](#hiddenopacity-11)

<a id="hover-1"></a>

##### hover()

> **hover**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `this`

Defined in: [charts/Viz.ts:1350](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1350)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`this`

###### Inherited from

[`Plot`](#plot).[`hover`](#hover-18)

<a id="label-1"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

###### Inherited from

[`Plot`](#plot).[`label`](#label-17)

<a id="labelconnectorconfig"></a>

##### labelConnectorConfig()

> **labelConnectorConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2117](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2117)

The d3plus-shape config used on the Line shapes created to connect lineLabels to the end of their associated Line path.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`labelConnectorConfig`](#labelconnectorconfig-5)

<a id="labelposition"></a>

##### labelPosition()

> **labelPosition**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2127](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2127)

The behavior to be used when calculating the position and size of each shape's label(s). The value passed can either be the _String_ name of the behavior to be used for all shapes, or an accessor _Function_ that will be provided each data point and will be expected to return the behavior to be used for that data point. The availability and options for this method depend on the default logic for each Shape. As an example, the values "outside" or "inside" can be set for Bar shapes, whose "auto" default will calculate the best position dynamically based on the available space.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`labelPosition`](#labelposition-5)

<a id="legend"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| [`AreaPlot`](#areaplot) \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| [`AreaPlot`](#areaplot) \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)

###### Inherited from

[`Plot`](#plot).[`legend`](#legend-12)

<a id="legendconfig"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Plot`](#plot).[`legendConfig`](#legendconfig-13)

<a id="legendfilterinvert"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`AreaPlot`](#areaplot) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`AreaPlot`](#areaplot) \| (() => `boolean`)

###### Inherited from

[`Plot`](#plot).[`legendFilterInvert`](#legendfilterinvert-11)

<a id="legendpadding"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`AreaPlot`](#areaplot) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`AreaPlot`](#areaplot) \| (() => `boolean`)

###### Inherited from

[`Plot`](#plot).[`legendPadding`](#legendpadding-12)

<a id="legendposition"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| [`AreaPlot`](#areaplot) \| (() => `string`)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| [`AreaPlot`](#areaplot) \| (() => `string`)

###### Inherited from

[`Plot`](#plot).[`legendPosition`](#legendposition-11)

<a id="legendsort"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): [`AreaPlot`](#areaplot) \| ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

[`AreaPlot`](#areaplot) \| ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`)

###### Inherited from

[`Plot`](#plot).[`legendSort`](#legendsort-11)

<a id="legendtooltip"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Plot`](#plot).[`legendTooltip`](#legendtooltip-11)

<a id="linelabels"></a>

##### lineLabels()

> **lineLabels**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2137](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2137)

Draws labels on the right side of any Line shapes that are drawn on the plot.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`lineLabels`](#linelabels-5)

<a id="linemarkerconfig"></a>

##### lineMarkerConfig()

> **lineMarkerConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2144](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2144)

Shape config for the Circle shapes drawn by the lineMarkers method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`lineMarkerConfig`](#linemarkerconfig-5)

<a id="linemarkers"></a>

##### lineMarkers()

> **lineMarkers**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2153](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2153)

Draws circle markers on each vertex of a Line.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`lineMarkers`](#linemarkers-5)

<a id="loadinghtml"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| [`AreaPlot`](#areaplot) \| ((`viz`: [`Viz`](#viz)) => `string`)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| [`AreaPlot`](#areaplot) \| ((`viz`: [`Viz`](#viz)) => `string`)

###### Inherited from

[`Plot`](#plot).[`loadingHTML`](#loadinghtml-11)

<a id="loadingmessage"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`loadingMessage`](#loadingmessage-11)

<a id="messagemask"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`messageMask`](#messagemask-11)

<a id="messagestyle"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Plot`](#plot).[`messageStyle`](#messagestyle-11)

<a id="nodatahtml"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| [`AreaPlot`](#areaplot) \| ((`viz`: [`Viz`](#viz)) => `string`)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| [`AreaPlot`](#areaplot) \| ((`viz`: [`Viz`](#viz)) => `string`)

###### Inherited from

[`Plot`](#plot).[`noDataHTML`](#nodatahtml-11)

<a id="nodatamessage"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`noDataMessage`](#nodatamessage-11)

<a id="render-1"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Plot`](#plot).[`render`](#render-25)

<a id="scrollcontainer"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| [`AreaPlot`](#areaplot) \| `HTMLElement` \| `Window`

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| [`AreaPlot`](#areaplot) \| `HTMLElement` \| `Window`

###### Inherited from

[`Plot`](#plot).[`scrollContainer`](#scrollcontainer-11)

<a id="select-1"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): [`AreaPlot`](#areaplot) \| `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\>

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

[`AreaPlot`](#areaplot) \| `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\>

###### Inherited from

[`Plot`](#plot).[`select`](#select-25)

<a id="shape"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

###### Inherited from

[`Plot`](#plot).[`shape`](#shape-17)

<a id="shapeconfig-1"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Plot`](#plot).[`shapeConfig`](#shapeconfig-25)

<a id="shapesort"></a>

##### shapeSort()

> **shapeSort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2162](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2162)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) that receives each shape Class (ie. "Circle", "Line", etc) as it's comparator arguments. Shapes are drawn in groups based on their type, so you are defining the layering order for all shapes of said type.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`shapeSort`](#shapesort-5)

<a id="size"></a>

##### size()

> **size**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2169](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2169)

Sets the size of bubbles to the given Number, data key, or function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`size`](#size-7)

<a id="sizemax"></a>

##### sizeMax()

> **sizeMax**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2178)

Sets the size scale maximum to the specified number.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`sizeMax`](#sizemax-6)

<a id="sizemin"></a>

##### sizeMin()

> **sizeMin**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2185](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2185)

Sets the size scale minimum to the specified number.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`sizeMin`](#sizemin-6)

<a id="sizescale"></a>

##### sizeScale()

> **sizeScale**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2192](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2192)

Sets the size scale to the specified string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`sizeScale`](#sizescale-6)

<a id="stacked"></a>

##### stacked()

> **stacked**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2199](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2199)

If *value* is specified, toggles shape stacking. If *value* is not specified, returns the current stack value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`stacked`](#stacked-5)

<a id="stackoffset"></a>

##### stackOffset()

> **stackOffset**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2206](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2206)

Sets the stack offset. If *value* is not specified, returns the current stack offset function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`stackOffset`](#stackoffset-5)

<a id="stackorder"></a>

##### stackOrder()

> **stackOrder**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2219](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2219)

Sets the stack order. If *value* is not specified, returns the current stack order function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`stackOrder`](#stackorder-5)

<a id="subtitle"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| [`AreaPlot`](#areaplot) \| ((`data`: `DataPoint`[]) => `string`)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| [`AreaPlot`](#areaplot) \| ((`data`: `DataPoint`[]) => `string`)

###### Inherited from

[`Plot`](#plot).[`subtitle`](#subtitle-11)

<a id="subtitleconfig"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Plot`](#plot).[`subtitleConfig`](#subtitleconfig-11)

<a id="subtitlepadding"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`AreaPlot`](#areaplot) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`AreaPlot`](#areaplot) \| (() => `boolean`)

###### Inherited from

[`Plot`](#plot).[`subtitlePadding`](#subtitlepadding-11)

<a id="svgdesc"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`svgDesc`](#svgdesc-11)

<a id="svgtitle"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`svgTitle`](#svgtitle-11)

<a id="threshold"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| [`AreaPlot`](#areaplot) \| ((`data`: `DataPoint`[]) => `number`)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| [`AreaPlot`](#areaplot) \| ((`data`: `DataPoint`[]) => `number`)

###### Inherited from

[`Plot`](#plot).[`threshold`](#threshold-11)

<a id="thresholdkey"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

###### Inherited from

[`Plot`](#plot).[`thresholdKey`](#thresholdkey-11)

<a id="thresholdname"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

###### Inherited from

[`Plot`](#plot).[`thresholdName`](#thresholdname-11)

<a id="time"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

###### Inherited from

[`Plot`](#plot).[`time`](#time-11)

<a id="timefilter"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

###### Inherited from

[`Plot`](#plot).[`timeFilter`](#timefilter-11)

<a id="timeline"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`timeline`](#timeline-11)

<a id="timelineconfig"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Plot`](#plot).[`timelineConfig`](#timelineconfig-11)

<a id="timelinedefault"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): [`AreaPlot`](#areaplot) \| `Date`[]

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

[`AreaPlot`](#areaplot) \| `Date`[]

###### Inherited from

[`Plot`](#plot).[`timelineDefault`](#timelinedefault-11)

<a id="timelinepadding"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`AreaPlot`](#areaplot) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`AreaPlot`](#areaplot) \| (() => `boolean`)

###### Inherited from

[`Plot`](#plot).[`timelinePadding`](#timelinepadding-11)

<a id="title"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| [`AreaPlot`](#areaplot) \| ((`data`: `DataPoint`[]) => `string`)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| [`AreaPlot`](#areaplot) \| ((`data`: `DataPoint`[]) => `string`)

###### Inherited from

[`Plot`](#plot).[`title`](#title-17)

<a id="titleconfig"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Plot`](#plot).[`titleConfig`](#titleconfig-17)

<a id="titlepadding"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`AreaPlot`](#areaplot) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`AreaPlot`](#areaplot) \| (() => `boolean`)

###### Inherited from

[`Plot`](#plot).[`titlePadding`](#titlepadding-11)

<a id="tooltip"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

###### Inherited from

[`Plot`](#plot).[`tooltip`](#tooltip-11)

<a id="tooltipconfig"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Plot`](#plot).[`tooltipConfig`](#tooltipconfig-11)

<a id="total"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `number`)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| [`AreaPlot`](#areaplot) \| ((`d`: `DataPoint`, `i`: `number`) => `number`)

###### Inherited from

[`Plot`](#plot).[`total`](#total-11)

<a id="totalconfig"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Plot`](#plot).[`totalConfig`](#totalconfig-11)

<a id="totalformat"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): [`AreaPlot`](#areaplot) \| ((`d`: `number`) => `string`)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

[`AreaPlot`](#areaplot) \| ((`d`: `number`) => `string`)

###### Inherited from

[`Plot`](#plot).[`totalFormat`](#totalformat-11)

<a id="totalpadding"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`AreaPlot`](#areaplot) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`AreaPlot`](#areaplot) \| (() => `boolean`)

###### Inherited from

[`Plot`](#plot).[`totalPadding`](#totalpadding-11)

<a id="width"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`width`](#width-20)

<a id="x-1"></a>

##### x()

> **x**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2236](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2236)

Accessor function or string key for the x-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x`](#x-13)

<a id="x2"></a>

##### x2()

> **x2**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2250)

Accessor function or string key for the secondary x-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x2`](#x2-5)

<a id="x2config"></a>

##### x2Config()

> **x2Config**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2280](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2280)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the secondary x-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x2Config`](#x2config-5)

<a id="x2domain"></a>

##### x2Domain()

> **x2Domain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2296](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2296)

The x2 domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x2Domain`](#x2domain-5)

<a id="x2sort"></a>

##### x2Sort()

> **x2Sort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2310](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2310)

Defines a custom sorting comparitor function to be used for discrete x2 axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x2Sort`](#x2sort-5)

<a id="xconfig"></a>

##### xConfig()

> **xConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2264](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2264)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the x-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`xConfig`](#xconfig-5)

<a id="xcutoff"></a>

##### xCutoff()

> **xCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2273](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2273)

When the width of the chart is less than or equal to this pixel value, and the x-axis is not the discrete axis, it will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`xCutoff`](#xcutoff-5)

<a id="xdomain"></a>

##### xDomain()

> **xDomain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2289](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2289)

The x domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`xDomain`](#xdomain-5)

<a id="xsort"></a>

##### xSort()

> **xSort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2303](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2303)

Defines a custom sorting comparitor function to be used for discrete x axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`xSort`](#xsort-5)

<a id="y-1"></a>

##### y()

> **y**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2317](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2317)

Accessor function or string key for the y-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y`](#y-13)

<a id="y2"></a>

##### y2()

> **y2**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2331](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2331)

Accessor function or string key for the secondary y-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y2`](#y2-5)

<a id="y2config"></a>

##### y2Config()

> **y2Config**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2366](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2366)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the secondary y-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y2Config`](#y2config-5)

<a id="y2domain"></a>

##### y2Domain()

> **y2Domain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2385](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2385)

The y2 domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y2Domain`](#y2domain-5)

<a id="y2sort"></a>

##### y2Sort()

> **y2Sort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2399](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2399)

Defines a custom sorting comparitor function to be used for discrete y2 axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y2Sort`](#y2sort-5)

<a id="yconfig"></a>

##### yConfig()

> **yConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2347](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2347)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the y-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

*Note:* If a "domain" array is passed to the y-axis config, it will be reversed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`yConfig`](#yconfig-5)

<a id="ycutoff"></a>

##### yCutoff()

> **yCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2359](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2359)

When the height of the chart is less than or equal to this pixel value, and the y-axis is not the discrete axis, it will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`yCutoff`](#ycutoff-5)

<a id="ydomain"></a>

##### yDomain()

> **yDomain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2378](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2378)

The y domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`yDomain`](#ydomain-5)

<a id="ysort"></a>

##### ySort()

> **ySort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2392](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2392)

Defines a custom sorting comparitor function to be used for discrete y axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`ySort`](#ysort-5)

<a id="zoom"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`zoom`](#zoom-11)

<a id="zoombrushhandlesize"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`zoomBrushHandleSize`](#zoombrushhandlesize-11)

<a id="zoombrushhandlestyle"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Plot`](#plot).[`zoomBrushHandleStyle`](#zoombrushhandlestyle-11)

<a id="zoombrushselectionstyle"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Plot`](#plot).[`zoomBrushSelectionStyle`](#zoombrushselectionstyle-11)

<a id="zoomcontrolstyle"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Plot`](#plot).[`zoomControlStyle`](#zoomcontrolstyle-11)

<a id="zoomcontrolstyleactive"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Plot`](#plot).[`zoomControlStyleActive`](#zoomcontrolstyleactive-11)

<a id="zoomcontrolstylehover"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| [`AreaPlot`](#areaplot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Plot`](#plot).[`zoomControlStyleHover`](#zoomcontrolstylehover-11)

<a id="zoomfactor"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`zoomFactor`](#zoomfactor-11)

<a id="zoommax"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`zoomMax`](#zoommax-11)

<a id="zoompadding"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`zoomPadding`](#zoompadding-11)

<a id="zoompan"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`zoomPan`](#zoompan-11)

<a id="zoomscroll"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`AreaPlot`](#areaplot)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`AreaPlot`](#areaplot)

###### Inherited from

[`Plot`](#plot).[`zoomScroll`](#zoomscroll-11)

***

<a id="axis"></a>

### Axis

Defined in: [components/Axis.ts:204](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L204)

Creates an SVG scale based on an array of data.

#### Extends

- [`BaseClass`](#baseclass)

#### Extended by

- [`AxisBottom`](#axisbottom)
- [`AxisLeft`](#axisleft)
- [`AxisRight`](#axisright)
- [`AxisTop`](#axistop)
- [`Timeline`](#timeline-18)

#### Methods

<a id="align"></a>

##### align()

###### Call Signature

> **align**(): `string`

Defined in: [components/Axis.ts:1520](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1520)

The horizontal alignment.

###### Returns

`string`

###### Call Signature

> **align**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1521](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1521)

The horizontal alignment.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="barconfig"></a>

##### barConfig()

###### Call Signature

> **barConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Axis.ts:1529](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1529)

Axis line style.

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **barConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1530](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1530)

Axis line style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="config-1"></a>

##### config()

###### Call Signature

> **config**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L91)

Methods that correspond to the key/value pairs and returns this class.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`BaseClass`](#baseclass).[`config`](#config-7)

###### Call Signature

> **config**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L92)

Methods that correspond to the key/value pairs and returns this class.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`config`](#config-7)

<a id="data-2"></a>

##### data()

###### Call Signature

> **data**(): `any`[]

Defined in: [components/Axis.ts:1541](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1541)

An array of data points, which helps determine which ticks should be shown and which time resolution should be displayed.

###### Returns

`any`[]

###### Call Signature

> **data**(`_`: `any`[]): `this`

Defined in: [components/Axis.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1543)

An array of data points, which helps determine which ticks should be shown and which time resolution should be displayed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any`[] |

###### Returns

`this`

<a id="domain"></a>

##### domain()

###### Call Signature

> **domain**(): `any`[]

Defined in: [components/Axis.ts:1553](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1553)

Scale domain of the axis.

###### Returns

`any`[]

###### Call Signature

> **domain**(`_`: `any`[]): `this`

Defined in: [components/Axis.ts:1555](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1555)

Scale domain of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any`[] |

###### Returns

`this`

<a id="duration-2"></a>

##### duration()

###### Call Signature

> **duration**(): `number`

Defined in: [components/Axis.ts:1564](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1564)

Transition duration of the axis.

###### Returns

`number`

###### Call Signature

> **duration**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1565](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1565)

Transition duration of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="grid"></a>

##### grid()

###### Call Signature

> **grid**(): `unknown`[] \| `undefined`

Defined in: [components/Axis.ts:1573](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1573)

Grid values of the axis.

###### Returns

`unknown`[] \| `undefined`

###### Call Signature

> **grid**(`_`: `unknown`[]): `this`

Defined in: [components/Axis.ts:1574](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1574)

Grid values of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown`[] |

###### Returns

`this`

<a id="gridconfig"></a>

##### gridConfig()

###### Call Signature

> **gridConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Axis.ts:1582](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1582)

Grid config of the axis.

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **gridConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1583)

Grid config of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="gridlog"></a>

##### gridLog()

###### Call Signature

> **gridLog**(): `boolean`

Defined in: [components/Axis.ts:1593](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1593)

Grid behavior of the axis when scale is logarithmic.

###### Returns

`boolean`

###### Call Signature

> **gridLog**(`_`: `boolean`): `this`

Defined in: [components/Axis.ts:1594](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1594)

Grid behavior of the axis when scale is logarithmic.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

<a id="gridsize"></a>

##### gridSize()

###### Call Signature

> **gridSize**(): `number` \| `undefined`

Defined in: [components/Axis.ts:1602](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1602)

Grid size of the axis.

###### Returns

`number` \| `undefined`

###### Call Signature

> **gridSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1603](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1603)

Grid size of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="height-1"></a>

##### height()

###### Call Signature

> **height**(): `number`

Defined in: [components/Axis.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1611)

Overall height of the axis.

###### Returns

`number`

###### Call Signature

> **height**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1612](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1612)

Overall height of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="labeloffset"></a>

##### labelOffset()

###### Call Signature

> **labelOffset**(): `boolean`

Defined in: [components/Axis.ts:1629](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1629)

Whether to offset overlapping labels further from the axis to prevent collisions.

###### Returns

`boolean`

###### Call Signature

> **labelOffset**(`_`: `boolean`): `this`

Defined in: [components/Axis.ts:1630](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1630)

Whether to offset overlapping labels further from the axis to prevent collisions.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

<a id="labelrotation"></a>

##### labelRotation()

###### Call Signature

> **labelRotation**(): `boolean` \| `undefined`

Defined in: [components/Axis.ts:1640](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1640)

Whether to rotate horizontal axis labels -90 degrees.

###### Returns

`boolean` \| `undefined`

###### Call Signature

> **labelRotation**(`_`: `boolean`): `this`

Defined in: [components/Axis.ts:1641](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1641)

Whether to rotate horizontal axis labels -90 degrees.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

<a id="labels"></a>

##### labels()

###### Call Signature

> **labels**(): `unknown`[] \| `undefined`

Defined in: [components/Axis.ts:1620](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1620)

Visible tick labels of the axis.

###### Returns

`unknown`[] \| `undefined`

###### Call Signature

> **labels**(`_`: `unknown`[]): `this`

Defined in: [components/Axis.ts:1621](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1621)

Visible tick labels of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown`[] |

###### Returns

`this`

<a id="locale-1"></a>

##### locale()

###### Call Signature

> **locale**(): `string`

Defined in: [utils/BaseClass.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L156)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Returns

`string`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`BaseClass`](#baseclass).[`locale`](#locale-7)

###### Call Signature

> **locale**(`_`: `string` \| `object`): `this`

Defined in: [utils/BaseClass.ts:157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L157)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `object` |

###### Returns

`this`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`BaseClass`](#baseclass).[`locale`](#locale-7)

<a id="maxsize"></a>

##### maxSize()

###### Call Signature

> **maxSize**(): `number`

Defined in: [components/Axis.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1651)

Maximum size allowed for the space that contains the axis tick labels and title.

###### Returns

`number`

###### Call Signature

> **maxSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1652](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1652)

Maximum size allowed for the space that contains the axis tick labels and title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="minsize"></a>

##### minSize()

###### Call Signature

> **minSize**(): `number`

Defined in: [components/Axis.ts:1660](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1660)

Minimum size alloted for the space that contains the axis tick labels and title.

###### Returns

`number`

###### Call Signature

> **minSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1661](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1661)

Minimum size alloted for the space that contains the axis tick labels and title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="on-1"></a>

##### on()

###### Call Signature

> **on**(): `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

Defined in: [utils/BaseClass.ts:176](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L176)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Returns

`Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `string`): ((...`args`: `unknown`[]) => `unknown`) \| `undefined`

Defined in: [utils/BaseClass.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L177)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

((...`args`: `unknown`[]) => `unknown`) \| `undefined`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `string`, `f`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [utils/BaseClass.ts:178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L178)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |
| `f` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:179](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L179)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

<a id="orient"></a>

##### orient()

###### Call Signature

> **orient**(): `string`

Defined in: [components/Axis.ts:1669](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1669)

The orientation of the shape.

###### Returns

`string`

###### Call Signature

> **orient**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1670](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1670)

The orientation of the shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="outerbounds"></a>

##### outerBounds()

> **outerBounds**(): `Record`\<`string`, `number`\>

Defined in: [components/Axis.ts:1700](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1700)

Returns the outer bounds of the axis content. Must be called after rendering.

###### Returns

`Record`\<`string`, `number`\>

###### Example

```ts
{"width": 180, "height": 24, "x": 10, "y": 20}
```

<a id="padding"></a>

##### padding()

###### Call Signature

> **padding**(): `number`

Defined in: [components/Axis.ts:1707](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1707)

The padding between each tick label.

###### Returns

`number`

###### Call Signature

> **padding**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1708)

The padding between each tick label.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="paddinginner"></a>

##### paddingInner()

###### Call Signature

> **paddingInner**(): `number`

Defined in: [components/Axis.ts:1716](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1716)

The inner padding of band scale.

###### Returns

`number`

###### Call Signature

> **paddingInner**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1717)

The inner padding of band scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="paddingouter"></a>

##### paddingOuter()

###### Call Signature

> **paddingOuter**(): `number`

Defined in: [components/Axis.ts:1727](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1727)

The outer padding of band scales.

###### Returns

`number`

###### Call Signature

> **paddingOuter**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1728](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1728)

The outer padding of band scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="parent-1"></a>

##### parent()

###### Call Signature

> **parent**(): `Record`\<`string`, `unknown`\>

Defined in: [utils/BaseClass.ts:200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L200)

Parent config used by the wrapper.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`BaseClass`](#baseclass).[`parent`](#parent-7)

###### Call Signature

> **parent**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L201)

Parent config used by the wrapper.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`parent`](#parent-7)

<a id="range"></a>

##### range()

###### Call Signature

> **range**(): (`number` \| `undefined`)[] \| `undefined`

Defined in: [components/Axis.ts:1738](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1738)

Scale range (in pixels) of the axis. The given array must have 2 values, but one may be `undefined` to allow the default behavior for that value.

###### Returns

(`number` \| `undefined`)[] \| `undefined`

###### Call Signature

> **range**(`_`: (`number` \| `undefined`)[]): `this`

Defined in: [components/Axis.ts:1739](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1739)

Scale range (in pixels) of the axis. The given array must have 2 values, but one may be `undefined` to allow the default behavior for that value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`number` \| `undefined`)[] |

###### Returns

`this`

<a id="render-2"></a>

##### render()

> **render**(`callback?`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [components/Axis.ts:566](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L566)

Renders the current Axis to the page.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | (...`args`: `unknown`[]) => `unknown` | Optional callback invoked after rendering completes. |

###### Returns

`this`

<a id="rounding"></a>

##### rounding()

###### Call Signature

> **rounding**(): `string`

Defined in: [components/Axis.ts:1747](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1747)

The rounding method for more evenly spaced ticks at the extents of the scale. Can be "none" (default), "outside", or "inside".

###### Returns

`string`

###### Call Signature

> **rounding**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1748](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1748)

The rounding method for more evenly spaced ticks at the extents of the scale. Can be "none" (default), "outside", or "inside".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="roundinginsidemaxprefix"></a>

##### roundingInsideMaxPrefix()

###### Call Signature

> **roundingInsideMaxPrefix**(): `string`

Defined in: [components/Axis.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1778)

The prefix for the maximum value of "inside" rounding scales.

###### Returns

`string`

###### Call Signature

> **roundingInsideMaxPrefix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1779](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1779)

The prefix for the maximum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="roundinginsidemaxsuffix"></a>

##### roundingInsideMaxSuffix()

###### Call Signature

> **roundingInsideMaxSuffix**(): `string`

Defined in: [components/Axis.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1789)

The suffix for the maximum value of "inside" rounding scales.

###### Returns

`string`

###### Call Signature

> **roundingInsideMaxSuffix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1790](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1790)

The suffix for the maximum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="roundinginsideminprefix"></a>

##### roundingInsideMinPrefix()

###### Call Signature

> **roundingInsideMinPrefix**(): `string`

Defined in: [components/Axis.ts:1756](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1756)

The prefix for the minimum value of "inside" rounding scales.

###### Returns

`string`

###### Call Signature

> **roundingInsideMinPrefix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1757](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1757)

The prefix for the minimum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="roundinginsideminsuffix"></a>

##### roundingInsideMinSuffix()

###### Call Signature

> **roundingInsideMinSuffix**(): `string`

Defined in: [components/Axis.ts:1767](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1767)

The suffix for the minimum value of "inside" rounding scales.

###### Returns

`string`

###### Call Signature

> **roundingInsideMinSuffix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1768](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1768)

The suffix for the minimum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="scale-1"></a>

##### scale()

###### Call Signature

> **scale**(): `string`

Defined in: [components/Axis.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1800)

Scale of the axis.

###### Returns

`string`

###### Call Signature

> **scale**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1801](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1801)

Scale of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="scalepadding"></a>

##### scalePadding()

###### Call Signature

> **scalePadding**(): `number`

Defined in: [components/Axis.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1809)

The "padding" property of the scale, often used in point scales.

###### Returns

`number`

###### Call Signature

> **scalePadding**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1810](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1810)

The "padding" property of the scale, often used in point scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="select-2"></a>

##### select()

###### Call Signature

> **select**(): `Selection`

Defined in: [components/Axis.ts:1820](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1820)

The SVG container element as a d3 selector or DOM element.

###### Returns

`Selection`

###### Call Signature

> **select**(`_`: `string` \| `HTMLElement`): `this`

Defined in: [components/Axis.ts:1821](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1821)

The SVG container element as a d3 selector or DOM element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `HTMLElement` |

###### Returns

`this`

<a id="shape-1"></a>

##### shape()

###### Call Signature

> **shape**(): `string`

Defined in: [components/Axis.ts:1831](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1831)

Tick shape constructor.

###### Returns

`string`

###### Call Signature

> **shape**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1832)

Tick shape constructor.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="shapeconfig-2"></a>

##### shapeConfig()

###### Call Signature

> **shapeConfig**(): `Record`\<`string`, `any`\>

Defined in: [components/Axis.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1841)

Tick style of the axis.

###### Returns

`Record`\<`string`, `any`\>

###### Overrides

[`BaseClass`](#baseclass).[`shapeConfig`](#shapeconfig-9)

###### Call Signature

> **shapeConfig**(`_`: `Record`\<`string`, `any`\>): `this`

Defined in: [components/Axis.ts:1843](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1843)

Tick style of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `any`\> |

###### Returns

`this`

###### Overrides

[`BaseClass`](#baseclass).[`shapeConfig`](#shapeconfig-9)

<a id="tickformat"></a>

##### tickFormat()

###### Call Signature

> **tickFormat**(): `any`

Defined in: [components/Axis.ts:1855](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1855)

Tick formatter.

###### Returns

`any`

###### Call Signature

> **tickFormat**(`_`: `any`): `this`

Defined in: [components/Axis.ts:1857](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1857)

Tick formatter.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`this`

<a id="ticks"></a>

##### ticks()

###### Call Signature

> **ticks**(): `unknown`[] \| `undefined`

Defined in: [components/Axis.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1866)

Tick values of the axis.

###### Returns

`unknown`[] \| `undefined`

###### Call Signature

> **ticks**(`_`: `unknown`[]): `this`

Defined in: [components/Axis.ts:1867](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1867)

Tick values of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown`[] |

###### Returns

`this`

<a id="ticksize"></a>

##### tickSize()

###### Call Signature

> **tickSize**(): `number`

Defined in: [components/Axis.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1875)

Tick size of the axis.

###### Returns

`number`

###### Call Signature

> **tickSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1876](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1876)

Tick size of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="ticksuffix"></a>

##### tickSuffix()

###### Call Signature

> **tickSuffix**(): `string`

Defined in: [components/Axis.ts:1884](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1884)

The tick abbreviation behavior for linear scales. Accepts "normal" (uses formatAbbreviate) or "smallest" (uses the suffix from the smallest tick as reference for every tick).

###### Returns

`string`

###### Call Signature

> **tickSuffix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1885](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1885)

The tick abbreviation behavior for linear scales. Accepts "normal" (uses formatAbbreviate) or "smallest" (uses the suffix from the smallest tick as reference for every tick).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="timelocale"></a>

##### timeLocale()

###### Call Signature

> **timeLocale**(): `Record`\<`string`, `unknown`\> \| `undefined`

Defined in: [components/Axis.ts:1895](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1895)

Defines a custom locale object to be used in time scale. This object must include the following properties: dateTime, date, time, periods, days, shortDays, months, shortMonths. For more information, you can revise [d3p.d3-time-format](https://github.com/d3/d3-time-format/blob/master/README.md#timeFormatLocale).

###### Returns

`Record`\<`string`, `unknown`\> \| `undefined`

###### Call Signature

> **timeLocale**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1896](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1896)

Defines a custom locale object to be used in time scale. This object must include the following properties: dateTime, date, time, periods, days, shortDays, months, shortMonths. For more information, you can revise [d3p.d3-time-format](https://github.com/d3/d3-time-format/blob/master/README.md#timeFormatLocale).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="title-1"></a>

##### title()

###### Call Signature

> **title**(): `string` \| `undefined`

Defined in: [components/Axis.ts:1904](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1904)

Title of the axis.

###### Returns

`string` \| `undefined`

###### Call Signature

> **title**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1905](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1905)

Title of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="titleconfig-1"></a>

##### titleConfig()

###### Call Signature

> **titleConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Axis.ts:1913](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1913)

Title configuration of the axis.

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **titleConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1914](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1914)

Title configuration of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="translate-1"></a>

##### translate()

###### Call Signature

> **translate**(): (`d`: `string`, `locale?`: `string`) => `string`

Defined in: [utils/BaseClass.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L214)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Returns

(`d`: `string`, `locale?`: `string`) => `string`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`translate`](#translate-7)

###### Call Signature

> **translate**(`_`: (`d`: `string`, `locale?`: `string`) => `string`): `this`

Defined in: [utils/BaseClass.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L215)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `string`, `locale?`: `string`) => `string` |

###### Returns

`this`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`translate`](#translate-7)

<a id="width-1"></a>

##### width()

###### Call Signature

> **width**(): `number`

Defined in: [components/Axis.ts:1924](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1924)

Overall width of the axis.

###### Returns

`number`

###### Call Signature

> **width**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1925](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1925)

Overall width of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

#### Properties

| Property | Type | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="property-_align"></a> `_align` | `string` | - | - | [components/Axis.ts:206](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L206) |
| <a id="property-_availableticks"></a> `_availableTicks` | `unknown`[] | - | - | [components/Axis.ts:271](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L271) |
| <a id="property-_barconfig"></a> `_barConfig` | `Record`\<`string`, `unknown`\> | - | - | [components/Axis.ts:207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L207) |
| <a id="property-_configdefault-1"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | - | [`BaseClass`](#baseclass).[`_configDefault`](#property-_configdefault-7) | [utils/BaseClass.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L69) |
| <a id="property-_d3scale"></a> `_d3Scale` | `any` | - | - | [components/Axis.ts:266](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L266) |
| <a id="property-_d3scalenegative"></a> `_d3ScaleNegative` | `any` | - | - | [components/Axis.ts:268](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L268) |
| <a id="property-_data-1"></a> `_data` | `any`[] | - | - | [components/Axis.ts:209](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L209) |
| <a id="property-_domain"></a> `_domain` | `any`[] | - | - | [components/Axis.ts:211](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L211) |
| <a id="property-_duration-1"></a> `_duration` | `number` | - | - | [components/Axis.ts:212](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L212) |
| <a id="property-_grid"></a> `_grid` | `unknown`[] \| *required* | - | - | [components/Axis.ts:216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L216) |
| <a id="property-_gridconfig"></a> `_gridConfig` | `Record`\<`string`, `unknown`\> | - | - | [components/Axis.ts:213](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L213) |
| <a id="property-_gridlog"></a> `_gridLog` | `boolean` | - | - | [components/Axis.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L214) |
| <a id="property-_gridsize"></a> `_gridSize` | `number` \| *required* | - | - | [components/Axis.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L215) |
| <a id="property-_group-1"></a> `_group` | `Selection` | - | - | [components/Axis.ts:269](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L269) |
| <a id="property-_height"></a> `_height` | `number` | - | - | [components/Axis.ts:217](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L217) |
| <a id="property-_labeloffset"></a> `_labelOffset` | `boolean` | - | - | [components/Axis.ts:218](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L218) |
| <a id="property-_labelrotation"></a> `_labelRotation` | `boolean` \| *required* | - | - | [components/Axis.ts:219](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L219) |
| <a id="property-_labels"></a> `_labels` | `unknown`[] \| *required* | - | - | [components/Axis.ts:220](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L220) |
| <a id="property-_lastscale"></a> `_lastScale` | ((`d`: `unknown`) => `number`) \| *required* | - | - | [components/Axis.ts:270](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L270) |
| <a id="property-_locale-1"></a> `_locale` | `any` | [`BaseClass`](#baseclass).[`_locale`](#property-_locale-7) | - | [components/Axis.ts:223](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L223) |
| <a id="property-_margin"></a> `_margin` | `Record`\<`string`, `number`\> | - | - | [components/Axis.ts:224](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L224) |
| <a id="property-_maxsize"></a> `_maxSize` | `number` | - | - | [components/Axis.ts:225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L225) |
| <a id="property-_minsize"></a> `_minSize` | `number` | - | - | [components/Axis.ts:226](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L226) |
| <a id="property-_on-1"></a> `_on` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | - | [`BaseClass`](#baseclass).[`_on`](#property-_on-7) | [utils/BaseClass.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L65) |
| <a id="property-_orient"></a> `_orient` | `string` | - | - | [components/Axis.ts:227](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L227) |
| <a id="property-_outerbounds"></a> `_outerBounds` | `Record`\<`string`, `number`\> | - | - | [components/Axis.ts:228](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L228) |
| <a id="property-_padding"></a> `_padding` | `number` | - | - | [components/Axis.ts:229](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L229) |
| <a id="property-_paddinginner"></a> `_paddingInner` | `number` | - | - | [components/Axis.ts:230](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L230) |
| <a id="property-_paddingouter"></a> `_paddingOuter` | `number` | - | - | [components/Axis.ts:231](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L231) |
| <a id="property-_parent-1"></a> `_parent` | `Record`\<`string`, `unknown`\> | - | [`BaseClass`](#baseclass).[`_parent`](#property-_parent-7) | [utils/BaseClass.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L66) |
| <a id="property-_position"></a> `_position` | `object` | - | - | [components/Axis.ts:232](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L232) |
| `_position.height` | `string` | - | - | [components/Axis.ts:235](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L235) |
| `_position.horizontal` | `boolean` | - | - | [components/Axis.ts:233](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L233) |
| `_position.opposite` | `string` | - | - | [components/Axis.ts:238](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L238) |
| `_position.width` | `string` | - | - | [components/Axis.ts:234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L234) |
| `_position.x` | `string` | - | - | [components/Axis.ts:236](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L236) |
| `_position.y` | `string` | - | - | [components/Axis.ts:237](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L237) |
| <a id="property-_range"></a> `_range` | (`number` \| `undefined`)[] \| *required* | - | - | [components/Axis.ts:240](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L240) |
| <a id="property-_rounding"></a> `_rounding` | `string` | - | - | [components/Axis.ts:241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L241) |
| <a id="property-_roundinginsidemaxprefix"></a> `_roundingInsideMaxPrefix` | `string` | - | - | [components/Axis.ts:244](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L244) |
| <a id="property-_roundinginsidemaxsuffix"></a> `_roundingInsideMaxSuffix` | `string` | - | - | [components/Axis.ts:245](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L245) |
| <a id="property-_roundinginsideminprefix"></a> `_roundingInsideMinPrefix` | `string` | - | - | [components/Axis.ts:242](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L242) |
| <a id="property-_roundinginsideminsuffix"></a> `_roundingInsideMinSuffix` | `string` | - | - | [components/Axis.ts:243](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L243) |
| <a id="property-_scale-1"></a> `_scale` | `string` | - | - | [components/Axis.ts:246](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L246) |
| <a id="property-_scalepadding"></a> `_scalePadding` | `number` | - | - | [components/Axis.ts:247](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L247) |
| <a id="property-_select-1"></a> `_select` | `Selection` | - | - | [components/Axis.ts:205](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L205) |
| <a id="property-_shape"></a> `_shape` | `string` | - | - | [components/Axis.ts:248](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L248) |
| <a id="property-_shapeconfig-1"></a> `_shapeConfig` | `Record`\<`string`, `any`\> | [`BaseClass`](#baseclass).[`_shapeConfig`](#property-_shapeconfig-7) | - | [components/Axis.ts:251](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L251) |
| <a id="property-_tickformat"></a> `_tickFormat` | `any` | - | - | [components/Axis.ts:253](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L253) |
| <a id="property-_ticks"></a> `_ticks` | `unknown`[] \| *required* | - | - | [components/Axis.ts:254](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L254) |
| <a id="property-_ticksize"></a> `_tickSize` | `number` | - | - | [components/Axis.ts:255](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L255) |
| <a id="property-_ticksuffix"></a> `_tickSuffix` | `string` | - | - | [components/Axis.ts:256](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L256) |
| <a id="property-_tickunit"></a> `_tickUnit` | `number` | - | - | [components/Axis.ts:257](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L257) |
| <a id="property-_timelocale"></a> `_timeLocale` | `Record`\<`string`, `unknown`\> \| *required* | - | - | [components/Axis.ts:258](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L258) |
| <a id="property-_title"></a> `_title` | `string` \| *required* | - | - | [components/Axis.ts:259](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L259) |
| <a id="property-_titleclass"></a> `_titleClass` | [`TextBox`](#textbox) | - | - | [components/Axis.ts:260](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L260) |
| <a id="property-_titleconfig"></a> `_titleConfig` | `Record`\<`string`, `any`\> | - | - | [components/Axis.ts:262](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L262) |
| <a id="property-_transition-1"></a> `_transition` | `Transition`\<`BaseType`\> | - | - | [components/Axis.ts:273](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L273) |
| <a id="property-_translate-1"></a> `_translate` | (`d`: `string`, `locale?`: `string`) => `string` | - | [`BaseClass`](#baseclass).[`_translate`](#property-_translate-7) | [utils/BaseClass.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L67) |
| <a id="property-_userformat"></a> `_userFormat` | `false` \| ((`d`: `unknown`) => `string`) \| *required* | - | - | [components/Axis.ts:274](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L274) |
| <a id="property-_uuid-1"></a> `_uuid` | `string` | - | [`BaseClass`](#baseclass).[`_uuid`](#property-_uuid-7) | [utils/BaseClass.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L68) |
| <a id="property-_visibleticks"></a> `_visibleTicks` | `unknown`[] | - | - | [components/Axis.ts:272](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L272) |
| <a id="property-_width"></a> `_width` | `number` | - | - | [components/Axis.ts:263](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L263) |

***

<a id="axisbottom"></a>

### AxisBottom

Defined in: [components/AxisBottom.ts:6](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/AxisBottom.ts#L6)

Shorthand method for creating an axis where the ticks are drawn below the horizontal domain path. Extends all functionality of the base [Axis](#Axis) class.

#### Extends

- [`Axis`](#axis)

#### Methods

<a id="align-1"></a>

##### align()

###### Call Signature

> **align**(): `string`

Defined in: [components/Axis.ts:1520](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1520)

The horizontal alignment.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`align`](#align)

###### Call Signature

> **align**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1521](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1521)

The horizontal alignment.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`align`](#align)

<a id="barconfig-1"></a>

##### barConfig()

###### Call Signature

> **barConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Axis.ts:1529](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1529)

Axis line style.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Axis`](#axis).[`barConfig`](#barconfig)

###### Call Signature

> **barConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1530](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1530)

Axis line style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`barConfig`](#barconfig)

<a id="config-2"></a>

##### config()

###### Call Signature

> **config**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L91)

Methods that correspond to the key/value pairs and returns this class.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`Axis`](#axis).[`config`](#config-1)

###### Call Signature

> **config**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L92)

Methods that correspond to the key/value pairs and returns this class.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`config`](#config-1)

<a id="data-3"></a>

##### data()

###### Call Signature

> **data**(): `any`[]

Defined in: [components/Axis.ts:1541](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1541)

An array of data points, which helps determine which ticks should be shown and which time resolution should be displayed.

###### Returns

`any`[]

###### Inherited from

[`Axis`](#axis).[`data`](#data-2)

###### Call Signature

> **data**(`_`: `any`[]): `this`

Defined in: [components/Axis.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1543)

An array of data points, which helps determine which ticks should be shown and which time resolution should be displayed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`data`](#data-2)

<a id="domain-1"></a>

##### domain()

###### Call Signature

> **domain**(): `any`[]

Defined in: [components/Axis.ts:1553](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1553)

Scale domain of the axis.

###### Returns

`any`[]

###### Inherited from

[`Axis`](#axis).[`domain`](#domain)

###### Call Signature

> **domain**(`_`: `any`[]): `this`

Defined in: [components/Axis.ts:1555](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1555)

Scale domain of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`domain`](#domain)

<a id="duration-3"></a>

##### duration()

###### Call Signature

> **duration**(): `number`

Defined in: [components/Axis.ts:1564](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1564)

Transition duration of the axis.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`duration`](#duration-2)

###### Call Signature

> **duration**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1565](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1565)

Transition duration of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`duration`](#duration-2)

<a id="grid-1"></a>

##### grid()

###### Call Signature

> **grid**(): `unknown`[] \| `undefined`

Defined in: [components/Axis.ts:1573](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1573)

Grid values of the axis.

###### Returns

`unknown`[] \| `undefined`

###### Inherited from

[`Axis`](#axis).[`grid`](#grid)

###### Call Signature

> **grid**(`_`: `unknown`[]): `this`

Defined in: [components/Axis.ts:1574](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1574)

Grid values of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`grid`](#grid)

<a id="gridconfig-1"></a>

##### gridConfig()

###### Call Signature

> **gridConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Axis.ts:1582](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1582)

Grid config of the axis.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Axis`](#axis).[`gridConfig`](#gridconfig)

###### Call Signature

> **gridConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1583)

Grid config of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`gridConfig`](#gridconfig)

<a id="gridlog-1"></a>

##### gridLog()

###### Call Signature

> **gridLog**(): `boolean`

Defined in: [components/Axis.ts:1593](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1593)

Grid behavior of the axis when scale is logarithmic.

###### Returns

`boolean`

###### Inherited from

[`Axis`](#axis).[`gridLog`](#gridlog)

###### Call Signature

> **gridLog**(`_`: `boolean`): `this`

Defined in: [components/Axis.ts:1594](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1594)

Grid behavior of the axis when scale is logarithmic.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`gridLog`](#gridlog)

<a id="gridsize-1"></a>

##### gridSize()

###### Call Signature

> **gridSize**(): `number` \| `undefined`

Defined in: [components/Axis.ts:1602](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1602)

Grid size of the axis.

###### Returns

`number` \| `undefined`

###### Inherited from

[`Axis`](#axis).[`gridSize`](#gridsize)

###### Call Signature

> **gridSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1603](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1603)

Grid size of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`gridSize`](#gridsize)

<a id="height-2"></a>

##### height()

###### Call Signature

> **height**(): `number`

Defined in: [components/Axis.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1611)

Overall height of the axis.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`height`](#height-1)

###### Call Signature

> **height**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1612](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1612)

Overall height of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`height`](#height-1)

<a id="labeloffset-1"></a>

##### labelOffset()

###### Call Signature

> **labelOffset**(): `boolean`

Defined in: [components/Axis.ts:1629](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1629)

Whether to offset overlapping labels further from the axis to prevent collisions.

###### Returns

`boolean`

###### Inherited from

[`Axis`](#axis).[`labelOffset`](#labeloffset)

###### Call Signature

> **labelOffset**(`_`: `boolean`): `this`

Defined in: [components/Axis.ts:1630](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1630)

Whether to offset overlapping labels further from the axis to prevent collisions.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`labelOffset`](#labeloffset)

<a id="labelrotation-1"></a>

##### labelRotation()

###### Call Signature

> **labelRotation**(): `boolean` \| `undefined`

Defined in: [components/Axis.ts:1640](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1640)

Whether to rotate horizontal axis labels -90 degrees.

###### Returns

`boolean` \| `undefined`

###### Inherited from

[`Axis`](#axis).[`labelRotation`](#labelrotation)

###### Call Signature

> **labelRotation**(`_`: `boolean`): `this`

Defined in: [components/Axis.ts:1641](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1641)

Whether to rotate horizontal axis labels -90 degrees.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`labelRotation`](#labelrotation)

<a id="labels-1"></a>

##### labels()

###### Call Signature

> **labels**(): `unknown`[] \| `undefined`

Defined in: [components/Axis.ts:1620](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1620)

Visible tick labels of the axis.

###### Returns

`unknown`[] \| `undefined`

###### Inherited from

[`Axis`](#axis).[`labels`](#labels)

###### Call Signature

> **labels**(`_`: `unknown`[]): `this`

Defined in: [components/Axis.ts:1621](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1621)

Visible tick labels of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`labels`](#labels)

<a id="locale-2"></a>

##### locale()

###### Call Signature

> **locale**(): `string`

Defined in: [utils/BaseClass.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L156)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Returns

`string`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Axis`](#axis).[`locale`](#locale-1)

###### Call Signature

> **locale**(`_`: `string` \| `object`): `this`

Defined in: [utils/BaseClass.ts:157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L157)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `object` |

###### Returns

`this`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Axis`](#axis).[`locale`](#locale-1)

<a id="maxsize-1"></a>

##### maxSize()

###### Call Signature

> **maxSize**(): `number`

Defined in: [components/Axis.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1651)

Maximum size allowed for the space that contains the axis tick labels and title.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`maxSize`](#maxsize)

###### Call Signature

> **maxSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1652](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1652)

Maximum size allowed for the space that contains the axis tick labels and title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`maxSize`](#maxsize)

<a id="minsize-1"></a>

##### minSize()

###### Call Signature

> **minSize**(): `number`

Defined in: [components/Axis.ts:1660](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1660)

Minimum size alloted for the space that contains the axis tick labels and title.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`minSize`](#minsize)

###### Call Signature

> **minSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1661](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1661)

Minimum size alloted for the space that contains the axis tick labels and title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`minSize`](#minsize)

<a id="on-2"></a>

##### on()

###### Call Signature

> **on**(): `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

Defined in: [utils/BaseClass.ts:176](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L176)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Returns

`Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Axis`](#axis).[`on`](#on-1)

###### Call Signature

> **on**(`_`: `string`): ((...`args`: `unknown`[]) => `unknown`) \| `undefined`

Defined in: [utils/BaseClass.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L177)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

((...`args`: `unknown`[]) => `unknown`) \| `undefined`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Axis`](#axis).[`on`](#on-1)

###### Call Signature

> **on**(`_`: `string`, `f`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [utils/BaseClass.ts:178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L178)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |
| `f` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Axis`](#axis).[`on`](#on-1)

###### Call Signature

> **on**(`_`: `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:179](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L179)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Axis`](#axis).[`on`](#on-1)

<a id="orient-1"></a>

##### orient()

###### Call Signature

> **orient**(): `string`

Defined in: [components/Axis.ts:1669](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1669)

The orientation of the shape.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`orient`](#orient)

###### Call Signature

> **orient**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1670](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1670)

The orientation of the shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`orient`](#orient)

<a id="outerbounds-1"></a>

##### outerBounds()

> **outerBounds**(): `Record`\<`string`, `number`\>

Defined in: [components/Axis.ts:1700](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1700)

Returns the outer bounds of the axis content. Must be called after rendering.

###### Returns

`Record`\<`string`, `number`\>

###### Example

```ts
{"width": 180, "height": 24, "x": 10, "y": 20}
```

###### Inherited from

[`Axis`](#axis).[`outerBounds`](#outerbounds)

<a id="padding-1"></a>

##### padding()

###### Call Signature

> **padding**(): `number`

Defined in: [components/Axis.ts:1707](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1707)

The padding between each tick label.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`padding`](#padding)

###### Call Signature

> **padding**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1708)

The padding between each tick label.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`padding`](#padding)

<a id="paddinginner-1"></a>

##### paddingInner()

###### Call Signature

> **paddingInner**(): `number`

Defined in: [components/Axis.ts:1716](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1716)

The inner padding of band scale.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`paddingInner`](#paddinginner)

###### Call Signature

> **paddingInner**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1717)

The inner padding of band scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`paddingInner`](#paddinginner)

<a id="paddingouter-1"></a>

##### paddingOuter()

###### Call Signature

> **paddingOuter**(): `number`

Defined in: [components/Axis.ts:1727](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1727)

The outer padding of band scales.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`paddingOuter`](#paddingouter)

###### Call Signature

> **paddingOuter**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1728](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1728)

The outer padding of band scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`paddingOuter`](#paddingouter)

<a id="parent-2"></a>

##### parent()

###### Call Signature

> **parent**(): `Record`\<`string`, `unknown`\>

Defined in: [utils/BaseClass.ts:200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L200)

Parent config used by the wrapper.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Axis`](#axis).[`parent`](#parent-1)

###### Call Signature

> **parent**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L201)

Parent config used by the wrapper.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`parent`](#parent-1)

<a id="range-1"></a>

##### range()

###### Call Signature

> **range**(): (`number` \| `undefined`)[] \| `undefined`

Defined in: [components/Axis.ts:1738](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1738)

Scale range (in pixels) of the axis. The given array must have 2 values, but one may be `undefined` to allow the default behavior for that value.

###### Returns

(`number` \| `undefined`)[] \| `undefined`

###### Inherited from

[`Axis`](#axis).[`range`](#range)

###### Call Signature

> **range**(`_`: (`number` \| `undefined`)[]): `this`

Defined in: [components/Axis.ts:1739](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1739)

Scale range (in pixels) of the axis. The given array must have 2 values, but one may be `undefined` to allow the default behavior for that value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`number` \| `undefined`)[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`range`](#range)

<a id="render-3"></a>

##### render()

> **render**(`callback?`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [components/Axis.ts:566](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L566)

Renders the current Axis to the page.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | (...`args`: `unknown`[]) => `unknown` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`render`](#render-2)

<a id="rounding-1"></a>

##### rounding()

###### Call Signature

> **rounding**(): `string`

Defined in: [components/Axis.ts:1747](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1747)

The rounding method for more evenly spaced ticks at the extents of the scale. Can be "none" (default), "outside", or "inside".

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`rounding`](#rounding)

###### Call Signature

> **rounding**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1748](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1748)

The rounding method for more evenly spaced ticks at the extents of the scale. Can be "none" (default), "outside", or "inside".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`rounding`](#rounding)

<a id="roundinginsidemaxprefix-1"></a>

##### roundingInsideMaxPrefix()

###### Call Signature

> **roundingInsideMaxPrefix**(): `string`

Defined in: [components/Axis.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1778)

The prefix for the maximum value of "inside" rounding scales.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMaxPrefix`](#roundinginsidemaxprefix)

###### Call Signature

> **roundingInsideMaxPrefix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1779](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1779)

The prefix for the maximum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMaxPrefix`](#roundinginsidemaxprefix)

<a id="roundinginsidemaxsuffix-1"></a>

##### roundingInsideMaxSuffix()

###### Call Signature

> **roundingInsideMaxSuffix**(): `string`

Defined in: [components/Axis.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1789)

The suffix for the maximum value of "inside" rounding scales.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMaxSuffix`](#roundinginsidemaxsuffix)

###### Call Signature

> **roundingInsideMaxSuffix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1790](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1790)

The suffix for the maximum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMaxSuffix`](#roundinginsidemaxsuffix)

<a id="roundinginsideminprefix-1"></a>

##### roundingInsideMinPrefix()

###### Call Signature

> **roundingInsideMinPrefix**(): `string`

Defined in: [components/Axis.ts:1756](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1756)

The prefix for the minimum value of "inside" rounding scales.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMinPrefix`](#roundinginsideminprefix)

###### Call Signature

> **roundingInsideMinPrefix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1757](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1757)

The prefix for the minimum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMinPrefix`](#roundinginsideminprefix)

<a id="roundinginsideminsuffix-1"></a>

##### roundingInsideMinSuffix()

###### Call Signature

> **roundingInsideMinSuffix**(): `string`

Defined in: [components/Axis.ts:1767](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1767)

The suffix for the minimum value of "inside" rounding scales.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMinSuffix`](#roundinginsideminsuffix)

###### Call Signature

> **roundingInsideMinSuffix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1768](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1768)

The suffix for the minimum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMinSuffix`](#roundinginsideminsuffix)

<a id="scale-2"></a>

##### scale()

###### Call Signature

> **scale**(): `string`

Defined in: [components/Axis.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1800)

Scale of the axis.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`scale`](#scale-1)

###### Call Signature

> **scale**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1801](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1801)

Scale of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`scale`](#scale-1)

<a id="scalepadding-1"></a>

##### scalePadding()

###### Call Signature

> **scalePadding**(): `number`

Defined in: [components/Axis.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1809)

The "padding" property of the scale, often used in point scales.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`scalePadding`](#scalepadding)

###### Call Signature

> **scalePadding**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1810](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1810)

The "padding" property of the scale, often used in point scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`scalePadding`](#scalepadding)

<a id="select-3"></a>

##### select()

###### Call Signature

> **select**(): `Selection`

Defined in: [components/Axis.ts:1820](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1820)

The SVG container element as a d3 selector or DOM element.

###### Returns

`Selection`

###### Inherited from

[`Axis`](#axis).[`select`](#select-2)

###### Call Signature

> **select**(`_`: `string` \| `HTMLElement`): `this`

Defined in: [components/Axis.ts:1821](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1821)

The SVG container element as a d3 selector or DOM element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `HTMLElement` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`select`](#select-2)

<a id="shape-2"></a>

##### shape()

###### Call Signature

> **shape**(): `string`

Defined in: [components/Axis.ts:1831](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1831)

Tick shape constructor.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`shape`](#shape-1)

###### Call Signature

> **shape**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1832)

Tick shape constructor.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`shape`](#shape-1)

<a id="shapeconfig-3"></a>

##### shapeConfig()

###### Call Signature

> **shapeConfig**(): `Record`\<`string`, `any`\>

Defined in: [components/Axis.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1841)

Tick style of the axis.

###### Returns

`Record`\<`string`, `any`\>

###### Inherited from

[`Axis`](#axis).[`shapeConfig`](#shapeconfig-2)

###### Call Signature

> **shapeConfig**(`_`: `Record`\<`string`, `any`\>): `this`

Defined in: [components/Axis.ts:1843](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1843)

Tick style of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `any`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`shapeConfig`](#shapeconfig-2)

<a id="tickformat-1"></a>

##### tickFormat()

###### Call Signature

> **tickFormat**(): `any`

Defined in: [components/Axis.ts:1855](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1855)

Tick formatter.

###### Returns

`any`

###### Inherited from

[`Axis`](#axis).[`tickFormat`](#tickformat)

###### Call Signature

> **tickFormat**(`_`: `any`): `this`

Defined in: [components/Axis.ts:1857](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1857)

Tick formatter.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`tickFormat`](#tickformat)

<a id="ticks-1"></a>

##### ticks()

###### Call Signature

> **ticks**(): `unknown`[] \| `undefined`

Defined in: [components/Axis.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1866)

Tick values of the axis.

###### Returns

`unknown`[] \| `undefined`

###### Inherited from

[`Axis`](#axis).[`ticks`](#ticks)

###### Call Signature

> **ticks**(`_`: `unknown`[]): `this`

Defined in: [components/Axis.ts:1867](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1867)

Tick values of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`ticks`](#ticks)

<a id="ticksize-1"></a>

##### tickSize()

###### Call Signature

> **tickSize**(): `number`

Defined in: [components/Axis.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1875)

Tick size of the axis.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`tickSize`](#ticksize)

###### Call Signature

> **tickSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1876](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1876)

Tick size of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`tickSize`](#ticksize)

<a id="ticksuffix-1"></a>

##### tickSuffix()

###### Call Signature

> **tickSuffix**(): `string`

Defined in: [components/Axis.ts:1884](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1884)

The tick abbreviation behavior for linear scales. Accepts "normal" (uses formatAbbreviate) or "smallest" (uses the suffix from the smallest tick as reference for every tick).

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`tickSuffix`](#ticksuffix)

###### Call Signature

> **tickSuffix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1885](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1885)

The tick abbreviation behavior for linear scales. Accepts "normal" (uses formatAbbreviate) or "smallest" (uses the suffix from the smallest tick as reference for every tick).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`tickSuffix`](#ticksuffix)

<a id="timelocale-1"></a>

##### timeLocale()

###### Call Signature

> **timeLocale**(): `Record`\<`string`, `unknown`\> \| `undefined`

Defined in: [components/Axis.ts:1895](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1895)

Defines a custom locale object to be used in time scale. This object must include the following properties: dateTime, date, time, periods, days, shortDays, months, shortMonths. For more information, you can revise [d3p.d3-time-format](https://github.com/d3/d3-time-format/blob/master/README.md#timeFormatLocale).

###### Returns

`Record`\<`string`, `unknown`\> \| `undefined`

###### Inherited from

[`Axis`](#axis).[`timeLocale`](#timelocale)

###### Call Signature

> **timeLocale**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1896](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1896)

Defines a custom locale object to be used in time scale. This object must include the following properties: dateTime, date, time, periods, days, shortDays, months, shortMonths. For more information, you can revise [d3p.d3-time-format](https://github.com/d3/d3-time-format/blob/master/README.md#timeFormatLocale).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`timeLocale`](#timelocale)

<a id="title-2"></a>

##### title()

###### Call Signature

> **title**(): `string` \| `undefined`

Defined in: [components/Axis.ts:1904](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1904)

Title of the axis.

###### Returns

`string` \| `undefined`

###### Inherited from

[`Axis`](#axis).[`title`](#title-1)

###### Call Signature

> **title**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1905](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1905)

Title of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`title`](#title-1)

<a id="titleconfig-2"></a>

##### titleConfig()

###### Call Signature

> **titleConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Axis.ts:1913](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1913)

Title configuration of the axis.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Axis`](#axis).[`titleConfig`](#titleconfig-1)

###### Call Signature

> **titleConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1914](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1914)

Title configuration of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`titleConfig`](#titleconfig-1)

<a id="translate-2"></a>

##### translate()

###### Call Signature

> **translate**(): (`d`: `string`, `locale?`: `string`) => `string`

Defined in: [utils/BaseClass.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L214)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Returns

(`d`: `string`, `locale?`: `string`) => `string`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Axis`](#axis).[`translate`](#translate-1)

###### Call Signature

> **translate**(`_`: (`d`: `string`, `locale?`: `string`) => `string`): `this`

Defined in: [utils/BaseClass.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L215)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `string`, `locale?`: `string`) => `string` |

###### Returns

`this`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Axis`](#axis).[`translate`](#translate-1)

<a id="width-2"></a>

##### width()

###### Call Signature

> **width**(): `number`

Defined in: [components/Axis.ts:1924](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1924)

Overall width of the axis.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`width`](#width-1)

###### Call Signature

> **width**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1925](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1925)

Overall width of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`width`](#width-1)

#### Properties

| Property | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="property-_align-1"></a> `_align` | `string` | [`Axis`](#axis).[`_align`](#property-_align) | [components/Axis.ts:206](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L206) |
| <a id="property-_availableticks-1"></a> `_availableTicks` | `unknown`[] | [`Axis`](#axis).[`_availableTicks`](#property-_availableticks) | [components/Axis.ts:271](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L271) |
| <a id="property-_barconfig-1"></a> `_barConfig` | `Record`\<`string`, `unknown`\> | [`Axis`](#axis).[`_barConfig`](#property-_barconfig) | [components/Axis.ts:207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L207) |
| <a id="property-_configdefault-2"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | [`Axis`](#axis).[`_configDefault`](#property-_configdefault-1) | [utils/BaseClass.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L69) |
| <a id="property-_d3scale-1"></a> `_d3Scale` | `any` | [`Axis`](#axis).[`_d3Scale`](#property-_d3scale) | [components/Axis.ts:266](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L266) |
| <a id="property-_d3scalenegative-1"></a> `_d3ScaleNegative` | `any` | [`Axis`](#axis).[`_d3ScaleNegative`](#property-_d3scalenegative) | [components/Axis.ts:268](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L268) |
| <a id="property-_data-2"></a> `_data` | `any`[] | [`Axis`](#axis).[`_data`](#property-_data-1) | [components/Axis.ts:209](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L209) |
| <a id="property-_domain-1"></a> `_domain` | `any`[] | [`Axis`](#axis).[`_domain`](#property-_domain) | [components/Axis.ts:211](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L211) |
| <a id="property-_duration-2"></a> `_duration` | `number` | [`Axis`](#axis).[`_duration`](#property-_duration-1) | [components/Axis.ts:212](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L212) |
| <a id="property-_grid-1"></a> `_grid` | `unknown`[] \| *required* | [`Axis`](#axis).[`_grid`](#property-_grid) | [components/Axis.ts:216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L216) |
| <a id="property-_gridconfig-1"></a> `_gridConfig` | `Record`\<`string`, `unknown`\> | [`Axis`](#axis).[`_gridConfig`](#property-_gridconfig) | [components/Axis.ts:213](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L213) |
| <a id="property-_gridlog-1"></a> `_gridLog` | `boolean` | [`Axis`](#axis).[`_gridLog`](#property-_gridlog) | [components/Axis.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L214) |
| <a id="property-_gridsize-1"></a> `_gridSize` | `number` \| *required* | [`Axis`](#axis).[`_gridSize`](#property-_gridsize) | [components/Axis.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L215) |
| <a id="property-_group-2"></a> `_group` | `Selection` | [`Axis`](#axis).[`_group`](#property-_group-1) | [components/Axis.ts:269](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L269) |
| <a id="property-_height-1"></a> `_height` | `number` | [`Axis`](#axis).[`_height`](#property-_height) | [components/Axis.ts:217](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L217) |
| <a id="property-_labeloffset-1"></a> `_labelOffset` | `boolean` | [`Axis`](#axis).[`_labelOffset`](#property-_labeloffset) | [components/Axis.ts:218](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L218) |
| <a id="property-_labelrotation-1"></a> `_labelRotation` | `boolean` \| *required* | [`Axis`](#axis).[`_labelRotation`](#property-_labelrotation) | [components/Axis.ts:219](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L219) |
| <a id="property-_labels-1"></a> `_labels` | `unknown`[] \| *required* | [`Axis`](#axis).[`_labels`](#property-_labels) | [components/Axis.ts:220](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L220) |
| <a id="property-_lastscale-1"></a> `_lastScale` | ((`d`: `unknown`) => `number`) \| *required* | [`Axis`](#axis).[`_lastScale`](#property-_lastscale) | [components/Axis.ts:270](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L270) |
| <a id="property-_locale-2"></a> `_locale` | `any` | [`Axis`](#axis).[`_locale`](#property-_locale-1) | [components/Axis.ts:223](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L223) |
| <a id="property-_margin-1"></a> `_margin` | `Record`\<`string`, `number`\> | [`Axis`](#axis).[`_margin`](#property-_margin) | [components/Axis.ts:224](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L224) |
| <a id="property-_maxsize-1"></a> `_maxSize` | `number` | [`Axis`](#axis).[`_maxSize`](#property-_maxsize) | [components/Axis.ts:225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L225) |
| <a id="property-_minsize-1"></a> `_minSize` | `number` | [`Axis`](#axis).[`_minSize`](#property-_minsize) | [components/Axis.ts:226](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L226) |
| <a id="property-_on-2"></a> `_on` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | [`Axis`](#axis).[`_on`](#property-_on-1) | [utils/BaseClass.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L65) |
| <a id="property-_orient-1"></a> `_orient` | `string` | [`Axis`](#axis).[`_orient`](#property-_orient) | [components/Axis.ts:227](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L227) |
| <a id="property-_outerbounds-1"></a> `_outerBounds` | `Record`\<`string`, `number`\> | [`Axis`](#axis).[`_outerBounds`](#property-_outerbounds) | [components/Axis.ts:228](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L228) |
| <a id="property-_padding-1"></a> `_padding` | `number` | [`Axis`](#axis).[`_padding`](#property-_padding) | [components/Axis.ts:229](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L229) |
| <a id="property-_paddinginner-1"></a> `_paddingInner` | `number` | [`Axis`](#axis).[`_paddingInner`](#property-_paddinginner) | [components/Axis.ts:230](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L230) |
| <a id="property-_paddingouter-1"></a> `_paddingOuter` | `number` | [`Axis`](#axis).[`_paddingOuter`](#property-_paddingouter) | [components/Axis.ts:231](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L231) |
| <a id="property-_parent-2"></a> `_parent` | `Record`\<`string`, `unknown`\> | [`Axis`](#axis).[`_parent`](#property-_parent-1) | [utils/BaseClass.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L66) |
| <a id="property-_position-1"></a> `_position` | `object` | [`Axis`](#axis).[`_position`](#property-_position) | [components/Axis.ts:232](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L232) |
| `_position.height` | `string` | - | [components/Axis.ts:235](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L235) |
| `_position.horizontal` | `boolean` | - | [components/Axis.ts:233](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L233) |
| `_position.opposite` | `string` | - | [components/Axis.ts:238](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L238) |
| `_position.width` | `string` | - | [components/Axis.ts:234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L234) |
| `_position.x` | `string` | - | [components/Axis.ts:236](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L236) |
| `_position.y` | `string` | - | [components/Axis.ts:237](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L237) |
| <a id="property-_range-1"></a> `_range` | (`number` \| `undefined`)[] \| *required* | [`Axis`](#axis).[`_range`](#property-_range) | [components/Axis.ts:240](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L240) |
| <a id="property-_rounding-1"></a> `_rounding` | `string` | [`Axis`](#axis).[`_rounding`](#property-_rounding) | [components/Axis.ts:241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L241) |
| <a id="property-_roundinginsidemaxprefix-1"></a> `_roundingInsideMaxPrefix` | `string` | [`Axis`](#axis).[`_roundingInsideMaxPrefix`](#property-_roundinginsidemaxprefix) | [components/Axis.ts:244](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L244) |
| <a id="property-_roundinginsidemaxsuffix-1"></a> `_roundingInsideMaxSuffix` | `string` | [`Axis`](#axis).[`_roundingInsideMaxSuffix`](#property-_roundinginsidemaxsuffix) | [components/Axis.ts:245](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L245) |
| <a id="property-_roundinginsideminprefix-1"></a> `_roundingInsideMinPrefix` | `string` | [`Axis`](#axis).[`_roundingInsideMinPrefix`](#property-_roundinginsideminprefix) | [components/Axis.ts:242](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L242) |
| <a id="property-_roundinginsideminsuffix-1"></a> `_roundingInsideMinSuffix` | `string` | [`Axis`](#axis).[`_roundingInsideMinSuffix`](#property-_roundinginsideminsuffix) | [components/Axis.ts:243](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L243) |
| <a id="property-_scale-2"></a> `_scale` | `string` | [`Axis`](#axis).[`_scale`](#property-_scale-1) | [components/Axis.ts:246](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L246) |
| <a id="property-_scalepadding-1"></a> `_scalePadding` | `number` | [`Axis`](#axis).[`_scalePadding`](#property-_scalepadding) | [components/Axis.ts:247](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L247) |
| <a id="property-_select-2"></a> `_select` | `Selection` | [`Axis`](#axis).[`_select`](#property-_select-1) | [components/Axis.ts:205](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L205) |
| <a id="property-_shape-1"></a> `_shape` | `string` | [`Axis`](#axis).[`_shape`](#property-_shape) | [components/Axis.ts:248](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L248) |
| <a id="property-_shapeconfig-2"></a> `_shapeConfig` | `Record`\<`string`, `any`\> | [`Axis`](#axis).[`_shapeConfig`](#property-_shapeconfig-1) | [components/Axis.ts:251](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L251) |
| <a id="property-_tickformat-1"></a> `_tickFormat` | `any` | [`Axis`](#axis).[`_tickFormat`](#property-_tickformat) | [components/Axis.ts:253](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L253) |
| <a id="property-_ticks-1"></a> `_ticks` | `unknown`[] \| *required* | [`Axis`](#axis).[`_ticks`](#property-_ticks) | [components/Axis.ts:254](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L254) |
| <a id="property-_ticksize-1"></a> `_tickSize` | `number` | [`Axis`](#axis).[`_tickSize`](#property-_ticksize) | [components/Axis.ts:255](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L255) |
| <a id="property-_ticksuffix-1"></a> `_tickSuffix` | `string` | [`Axis`](#axis).[`_tickSuffix`](#property-_ticksuffix) | [components/Axis.ts:256](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L256) |
| <a id="property-_tickunit-1"></a> `_tickUnit` | `number` | [`Axis`](#axis).[`_tickUnit`](#property-_tickunit) | [components/Axis.ts:257](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L257) |
| <a id="property-_timelocale-1"></a> `_timeLocale` | `Record`\<`string`, `unknown`\> \| *required* | [`Axis`](#axis).[`_timeLocale`](#property-_timelocale) | [components/Axis.ts:258](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L258) |
| <a id="property-_title-1"></a> `_title` | `string` \| *required* | [`Axis`](#axis).[`_title`](#property-_title) | [components/Axis.ts:259](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L259) |
| <a id="property-_titleclass-1"></a> `_titleClass` | [`TextBox`](#textbox) | [`Axis`](#axis).[`_titleClass`](#property-_titleclass) | [components/Axis.ts:260](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L260) |
| <a id="property-_titleconfig-1"></a> `_titleConfig` | `Record`\<`string`, `any`\> | [`Axis`](#axis).[`_titleConfig`](#property-_titleconfig) | [components/Axis.ts:262](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L262) |
| <a id="property-_transition-2"></a> `_transition` | `Transition`\<`BaseType`\> | [`Axis`](#axis).[`_transition`](#property-_transition-1) | [components/Axis.ts:273](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L273) |
| <a id="property-_translate-2"></a> `_translate` | (`d`: `string`, `locale?`: `string`) => `string` | [`Axis`](#axis).[`_translate`](#property-_translate-1) | [utils/BaseClass.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L67) |
| <a id="property-_userformat-1"></a> `_userFormat` | `false` \| ((`d`: `unknown`) => `string`) \| *required* | [`Axis`](#axis).[`_userFormat`](#property-_userformat) | [components/Axis.ts:274](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L274) |
| <a id="property-_uuid-2"></a> `_uuid` | `string` | [`Axis`](#axis).[`_uuid`](#property-_uuid-1) | [utils/BaseClass.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L68) |
| <a id="property-_visibleticks-1"></a> `_visibleTicks` | `unknown`[] | [`Axis`](#axis).[`_visibleTicks`](#property-_visibleticks) | [components/Axis.ts:272](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L272) |
| <a id="property-_width-1"></a> `_width` | `number` | [`Axis`](#axis).[`_width`](#property-_width) | [components/Axis.ts:263](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L263) |

***

<a id="axisleft"></a>

### AxisLeft

Defined in: [components/AxisLeft.ts:6](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/AxisLeft.ts#L6)

Shorthand method for creating an axis where the ticks are drawn to the left of the vertical domain path. Extends all functionality of the base [Axis](#Axis) class.

#### Extends

- [`Axis`](#axis)

#### Methods

<a id="align-2"></a>

##### align()

###### Call Signature

> **align**(): `string`

Defined in: [components/Axis.ts:1520](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1520)

The horizontal alignment.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`align`](#align)

###### Call Signature

> **align**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1521](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1521)

The horizontal alignment.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`align`](#align)

<a id="barconfig-2"></a>

##### barConfig()

###### Call Signature

> **barConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Axis.ts:1529](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1529)

Axis line style.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Axis`](#axis).[`barConfig`](#barconfig)

###### Call Signature

> **barConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1530](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1530)

Axis line style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`barConfig`](#barconfig)

<a id="config-3"></a>

##### config()

###### Call Signature

> **config**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L91)

Methods that correspond to the key/value pairs and returns this class.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`Axis`](#axis).[`config`](#config-1)

###### Call Signature

> **config**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L92)

Methods that correspond to the key/value pairs and returns this class.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`config`](#config-1)

<a id="data-4"></a>

##### data()

###### Call Signature

> **data**(): `any`[]

Defined in: [components/Axis.ts:1541](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1541)

An array of data points, which helps determine which ticks should be shown and which time resolution should be displayed.

###### Returns

`any`[]

###### Inherited from

[`Axis`](#axis).[`data`](#data-2)

###### Call Signature

> **data**(`_`: `any`[]): `this`

Defined in: [components/Axis.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1543)

An array of data points, which helps determine which ticks should be shown and which time resolution should be displayed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`data`](#data-2)

<a id="domain-2"></a>

##### domain()

###### Call Signature

> **domain**(): `any`[]

Defined in: [components/Axis.ts:1553](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1553)

Scale domain of the axis.

###### Returns

`any`[]

###### Inherited from

[`Axis`](#axis).[`domain`](#domain)

###### Call Signature

> **domain**(`_`: `any`[]): `this`

Defined in: [components/Axis.ts:1555](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1555)

Scale domain of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`domain`](#domain)

<a id="duration-4"></a>

##### duration()

###### Call Signature

> **duration**(): `number`

Defined in: [components/Axis.ts:1564](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1564)

Transition duration of the axis.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`duration`](#duration-2)

###### Call Signature

> **duration**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1565](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1565)

Transition duration of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`duration`](#duration-2)

<a id="grid-2"></a>

##### grid()

###### Call Signature

> **grid**(): `unknown`[] \| `undefined`

Defined in: [components/Axis.ts:1573](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1573)

Grid values of the axis.

###### Returns

`unknown`[] \| `undefined`

###### Inherited from

[`Axis`](#axis).[`grid`](#grid)

###### Call Signature

> **grid**(`_`: `unknown`[]): `this`

Defined in: [components/Axis.ts:1574](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1574)

Grid values of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`grid`](#grid)

<a id="gridconfig-2"></a>

##### gridConfig()

###### Call Signature

> **gridConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Axis.ts:1582](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1582)

Grid config of the axis.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Axis`](#axis).[`gridConfig`](#gridconfig)

###### Call Signature

> **gridConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1583)

Grid config of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`gridConfig`](#gridconfig)

<a id="gridlog-2"></a>

##### gridLog()

###### Call Signature

> **gridLog**(): `boolean`

Defined in: [components/Axis.ts:1593](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1593)

Grid behavior of the axis when scale is logarithmic.

###### Returns

`boolean`

###### Inherited from

[`Axis`](#axis).[`gridLog`](#gridlog)

###### Call Signature

> **gridLog**(`_`: `boolean`): `this`

Defined in: [components/Axis.ts:1594](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1594)

Grid behavior of the axis when scale is logarithmic.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`gridLog`](#gridlog)

<a id="gridsize-2"></a>

##### gridSize()

###### Call Signature

> **gridSize**(): `number` \| `undefined`

Defined in: [components/Axis.ts:1602](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1602)

Grid size of the axis.

###### Returns

`number` \| `undefined`

###### Inherited from

[`Axis`](#axis).[`gridSize`](#gridsize)

###### Call Signature

> **gridSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1603](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1603)

Grid size of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`gridSize`](#gridsize)

<a id="height-3"></a>

##### height()

###### Call Signature

> **height**(): `number`

Defined in: [components/Axis.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1611)

Overall height of the axis.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`height`](#height-1)

###### Call Signature

> **height**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1612](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1612)

Overall height of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`height`](#height-1)

<a id="labeloffset-2"></a>

##### labelOffset()

###### Call Signature

> **labelOffset**(): `boolean`

Defined in: [components/Axis.ts:1629](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1629)

Whether to offset overlapping labels further from the axis to prevent collisions.

###### Returns

`boolean`

###### Inherited from

[`Axis`](#axis).[`labelOffset`](#labeloffset)

###### Call Signature

> **labelOffset**(`_`: `boolean`): `this`

Defined in: [components/Axis.ts:1630](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1630)

Whether to offset overlapping labels further from the axis to prevent collisions.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`labelOffset`](#labeloffset)

<a id="labelrotation-2"></a>

##### labelRotation()

###### Call Signature

> **labelRotation**(): `boolean` \| `undefined`

Defined in: [components/Axis.ts:1640](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1640)

Whether to rotate horizontal axis labels -90 degrees.

###### Returns

`boolean` \| `undefined`

###### Inherited from

[`Axis`](#axis).[`labelRotation`](#labelrotation)

###### Call Signature

> **labelRotation**(`_`: `boolean`): `this`

Defined in: [components/Axis.ts:1641](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1641)

Whether to rotate horizontal axis labels -90 degrees.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`labelRotation`](#labelrotation)

<a id="labels-2"></a>

##### labels()

###### Call Signature

> **labels**(): `unknown`[] \| `undefined`

Defined in: [components/Axis.ts:1620](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1620)

Visible tick labels of the axis.

###### Returns

`unknown`[] \| `undefined`

###### Inherited from

[`Axis`](#axis).[`labels`](#labels)

###### Call Signature

> **labels**(`_`: `unknown`[]): `this`

Defined in: [components/Axis.ts:1621](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1621)

Visible tick labels of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`labels`](#labels)

<a id="locale-3"></a>

##### locale()

###### Call Signature

> **locale**(): `string`

Defined in: [utils/BaseClass.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L156)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Returns

`string`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Axis`](#axis).[`locale`](#locale-1)

###### Call Signature

> **locale**(`_`: `string` \| `object`): `this`

Defined in: [utils/BaseClass.ts:157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L157)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `object` |

###### Returns

`this`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Axis`](#axis).[`locale`](#locale-1)

<a id="maxsize-2"></a>

##### maxSize()

###### Call Signature

> **maxSize**(): `number`

Defined in: [components/Axis.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1651)

Maximum size allowed for the space that contains the axis tick labels and title.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`maxSize`](#maxsize)

###### Call Signature

> **maxSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1652](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1652)

Maximum size allowed for the space that contains the axis tick labels and title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`maxSize`](#maxsize)

<a id="minsize-2"></a>

##### minSize()

###### Call Signature

> **minSize**(): `number`

Defined in: [components/Axis.ts:1660](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1660)

Minimum size alloted for the space that contains the axis tick labels and title.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`minSize`](#minsize)

###### Call Signature

> **minSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1661](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1661)

Minimum size alloted for the space that contains the axis tick labels and title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`minSize`](#minsize)

<a id="on-3"></a>

##### on()

###### Call Signature

> **on**(): `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

Defined in: [utils/BaseClass.ts:176](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L176)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Returns

`Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Axis`](#axis).[`on`](#on-1)

###### Call Signature

> **on**(`_`: `string`): ((...`args`: `unknown`[]) => `unknown`) \| `undefined`

Defined in: [utils/BaseClass.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L177)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

((...`args`: `unknown`[]) => `unknown`) \| `undefined`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Axis`](#axis).[`on`](#on-1)

###### Call Signature

> **on**(`_`: `string`, `f`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [utils/BaseClass.ts:178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L178)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |
| `f` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Axis`](#axis).[`on`](#on-1)

###### Call Signature

> **on**(`_`: `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:179](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L179)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Axis`](#axis).[`on`](#on-1)

<a id="orient-2"></a>

##### orient()

###### Call Signature

> **orient**(): `string`

Defined in: [components/Axis.ts:1669](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1669)

The orientation of the shape.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`orient`](#orient)

###### Call Signature

> **orient**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1670](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1670)

The orientation of the shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`orient`](#orient)

<a id="outerbounds-2"></a>

##### outerBounds()

> **outerBounds**(): `Record`\<`string`, `number`\>

Defined in: [components/Axis.ts:1700](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1700)

Returns the outer bounds of the axis content. Must be called after rendering.

###### Returns

`Record`\<`string`, `number`\>

###### Example

```ts
{"width": 180, "height": 24, "x": 10, "y": 20}
```

###### Inherited from

[`Axis`](#axis).[`outerBounds`](#outerbounds)

<a id="padding-2"></a>

##### padding()

###### Call Signature

> **padding**(): `number`

Defined in: [components/Axis.ts:1707](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1707)

The padding between each tick label.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`padding`](#padding)

###### Call Signature

> **padding**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1708)

The padding between each tick label.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`padding`](#padding)

<a id="paddinginner-2"></a>

##### paddingInner()

###### Call Signature

> **paddingInner**(): `number`

Defined in: [components/Axis.ts:1716](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1716)

The inner padding of band scale.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`paddingInner`](#paddinginner)

###### Call Signature

> **paddingInner**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1717)

The inner padding of band scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`paddingInner`](#paddinginner)

<a id="paddingouter-2"></a>

##### paddingOuter()

###### Call Signature

> **paddingOuter**(): `number`

Defined in: [components/Axis.ts:1727](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1727)

The outer padding of band scales.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`paddingOuter`](#paddingouter)

###### Call Signature

> **paddingOuter**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1728](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1728)

The outer padding of band scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`paddingOuter`](#paddingouter)

<a id="parent-3"></a>

##### parent()

###### Call Signature

> **parent**(): `Record`\<`string`, `unknown`\>

Defined in: [utils/BaseClass.ts:200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L200)

Parent config used by the wrapper.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Axis`](#axis).[`parent`](#parent-1)

###### Call Signature

> **parent**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L201)

Parent config used by the wrapper.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`parent`](#parent-1)

<a id="range-2"></a>

##### range()

###### Call Signature

> **range**(): (`number` \| `undefined`)[] \| `undefined`

Defined in: [components/Axis.ts:1738](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1738)

Scale range (in pixels) of the axis. The given array must have 2 values, but one may be `undefined` to allow the default behavior for that value.

###### Returns

(`number` \| `undefined`)[] \| `undefined`

###### Inherited from

[`Axis`](#axis).[`range`](#range)

###### Call Signature

> **range**(`_`: (`number` \| `undefined`)[]): `this`

Defined in: [components/Axis.ts:1739](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1739)

Scale range (in pixels) of the axis. The given array must have 2 values, but one may be `undefined` to allow the default behavior for that value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`number` \| `undefined`)[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`range`](#range)

<a id="render-4"></a>

##### render()

> **render**(`callback?`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [components/Axis.ts:566](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L566)

Renders the current Axis to the page.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | (...`args`: `unknown`[]) => `unknown` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`render`](#render-2)

<a id="rounding-2"></a>

##### rounding()

###### Call Signature

> **rounding**(): `string`

Defined in: [components/Axis.ts:1747](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1747)

The rounding method for more evenly spaced ticks at the extents of the scale. Can be "none" (default), "outside", or "inside".

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`rounding`](#rounding)

###### Call Signature

> **rounding**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1748](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1748)

The rounding method for more evenly spaced ticks at the extents of the scale. Can be "none" (default), "outside", or "inside".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`rounding`](#rounding)

<a id="roundinginsidemaxprefix-2"></a>

##### roundingInsideMaxPrefix()

###### Call Signature

> **roundingInsideMaxPrefix**(): `string`

Defined in: [components/Axis.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1778)

The prefix for the maximum value of "inside" rounding scales.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMaxPrefix`](#roundinginsidemaxprefix)

###### Call Signature

> **roundingInsideMaxPrefix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1779](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1779)

The prefix for the maximum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMaxPrefix`](#roundinginsidemaxprefix)

<a id="roundinginsidemaxsuffix-2"></a>

##### roundingInsideMaxSuffix()

###### Call Signature

> **roundingInsideMaxSuffix**(): `string`

Defined in: [components/Axis.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1789)

The suffix for the maximum value of "inside" rounding scales.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMaxSuffix`](#roundinginsidemaxsuffix)

###### Call Signature

> **roundingInsideMaxSuffix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1790](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1790)

The suffix for the maximum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMaxSuffix`](#roundinginsidemaxsuffix)

<a id="roundinginsideminprefix-2"></a>

##### roundingInsideMinPrefix()

###### Call Signature

> **roundingInsideMinPrefix**(): `string`

Defined in: [components/Axis.ts:1756](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1756)

The prefix for the minimum value of "inside" rounding scales.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMinPrefix`](#roundinginsideminprefix)

###### Call Signature

> **roundingInsideMinPrefix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1757](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1757)

The prefix for the minimum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMinPrefix`](#roundinginsideminprefix)

<a id="roundinginsideminsuffix-2"></a>

##### roundingInsideMinSuffix()

###### Call Signature

> **roundingInsideMinSuffix**(): `string`

Defined in: [components/Axis.ts:1767](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1767)

The suffix for the minimum value of "inside" rounding scales.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMinSuffix`](#roundinginsideminsuffix)

###### Call Signature

> **roundingInsideMinSuffix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1768](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1768)

The suffix for the minimum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMinSuffix`](#roundinginsideminsuffix)

<a id="scale-3"></a>

##### scale()

###### Call Signature

> **scale**(): `string`

Defined in: [components/Axis.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1800)

Scale of the axis.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`scale`](#scale-1)

###### Call Signature

> **scale**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1801](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1801)

Scale of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`scale`](#scale-1)

<a id="scalepadding-2"></a>

##### scalePadding()

###### Call Signature

> **scalePadding**(): `number`

Defined in: [components/Axis.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1809)

The "padding" property of the scale, often used in point scales.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`scalePadding`](#scalepadding)

###### Call Signature

> **scalePadding**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1810](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1810)

The "padding" property of the scale, often used in point scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`scalePadding`](#scalepadding)

<a id="select-4"></a>

##### select()

###### Call Signature

> **select**(): `Selection`

Defined in: [components/Axis.ts:1820](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1820)

The SVG container element as a d3 selector or DOM element.

###### Returns

`Selection`

###### Inherited from

[`Axis`](#axis).[`select`](#select-2)

###### Call Signature

> **select**(`_`: `string` \| `HTMLElement`): `this`

Defined in: [components/Axis.ts:1821](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1821)

The SVG container element as a d3 selector or DOM element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `HTMLElement` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`select`](#select-2)

<a id="shape-3"></a>

##### shape()

###### Call Signature

> **shape**(): `string`

Defined in: [components/Axis.ts:1831](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1831)

Tick shape constructor.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`shape`](#shape-1)

###### Call Signature

> **shape**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1832)

Tick shape constructor.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`shape`](#shape-1)

<a id="shapeconfig-4"></a>

##### shapeConfig()

###### Call Signature

> **shapeConfig**(): `Record`\<`string`, `any`\>

Defined in: [components/Axis.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1841)

Tick style of the axis.

###### Returns

`Record`\<`string`, `any`\>

###### Inherited from

[`Axis`](#axis).[`shapeConfig`](#shapeconfig-2)

###### Call Signature

> **shapeConfig**(`_`: `Record`\<`string`, `any`\>): `this`

Defined in: [components/Axis.ts:1843](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1843)

Tick style of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `any`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`shapeConfig`](#shapeconfig-2)

<a id="tickformat-2"></a>

##### tickFormat()

###### Call Signature

> **tickFormat**(): `any`

Defined in: [components/Axis.ts:1855](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1855)

Tick formatter.

###### Returns

`any`

###### Inherited from

[`Axis`](#axis).[`tickFormat`](#tickformat)

###### Call Signature

> **tickFormat**(`_`: `any`): `this`

Defined in: [components/Axis.ts:1857](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1857)

Tick formatter.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`tickFormat`](#tickformat)

<a id="ticks-2"></a>

##### ticks()

###### Call Signature

> **ticks**(): `unknown`[] \| `undefined`

Defined in: [components/Axis.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1866)

Tick values of the axis.

###### Returns

`unknown`[] \| `undefined`

###### Inherited from

[`Axis`](#axis).[`ticks`](#ticks)

###### Call Signature

> **ticks**(`_`: `unknown`[]): `this`

Defined in: [components/Axis.ts:1867](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1867)

Tick values of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`ticks`](#ticks)

<a id="ticksize-2"></a>

##### tickSize()

###### Call Signature

> **tickSize**(): `number`

Defined in: [components/Axis.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1875)

Tick size of the axis.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`tickSize`](#ticksize)

###### Call Signature

> **tickSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1876](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1876)

Tick size of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`tickSize`](#ticksize)

<a id="ticksuffix-2"></a>

##### tickSuffix()

###### Call Signature

> **tickSuffix**(): `string`

Defined in: [components/Axis.ts:1884](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1884)

The tick abbreviation behavior for linear scales. Accepts "normal" (uses formatAbbreviate) or "smallest" (uses the suffix from the smallest tick as reference for every tick).

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`tickSuffix`](#ticksuffix)

###### Call Signature

> **tickSuffix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1885](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1885)

The tick abbreviation behavior for linear scales. Accepts "normal" (uses formatAbbreviate) or "smallest" (uses the suffix from the smallest tick as reference for every tick).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`tickSuffix`](#ticksuffix)

<a id="timelocale-2"></a>

##### timeLocale()

###### Call Signature

> **timeLocale**(): `Record`\<`string`, `unknown`\> \| `undefined`

Defined in: [components/Axis.ts:1895](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1895)

Defines a custom locale object to be used in time scale. This object must include the following properties: dateTime, date, time, periods, days, shortDays, months, shortMonths. For more information, you can revise [d3p.d3-time-format](https://github.com/d3/d3-time-format/blob/master/README.md#timeFormatLocale).

###### Returns

`Record`\<`string`, `unknown`\> \| `undefined`

###### Inherited from

[`Axis`](#axis).[`timeLocale`](#timelocale)

###### Call Signature

> **timeLocale**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1896](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1896)

Defines a custom locale object to be used in time scale. This object must include the following properties: dateTime, date, time, periods, days, shortDays, months, shortMonths. For more information, you can revise [d3p.d3-time-format](https://github.com/d3/d3-time-format/blob/master/README.md#timeFormatLocale).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`timeLocale`](#timelocale)

<a id="title-3"></a>

##### title()

###### Call Signature

> **title**(): `string` \| `undefined`

Defined in: [components/Axis.ts:1904](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1904)

Title of the axis.

###### Returns

`string` \| `undefined`

###### Inherited from

[`Axis`](#axis).[`title`](#title-1)

###### Call Signature

> **title**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1905](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1905)

Title of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`title`](#title-1)

<a id="titleconfig-3"></a>

##### titleConfig()

###### Call Signature

> **titleConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Axis.ts:1913](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1913)

Title configuration of the axis.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Axis`](#axis).[`titleConfig`](#titleconfig-1)

###### Call Signature

> **titleConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1914](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1914)

Title configuration of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`titleConfig`](#titleconfig-1)

<a id="translate-3"></a>

##### translate()

###### Call Signature

> **translate**(): (`d`: `string`, `locale?`: `string`) => `string`

Defined in: [utils/BaseClass.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L214)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Returns

(`d`: `string`, `locale?`: `string`) => `string`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Axis`](#axis).[`translate`](#translate-1)

###### Call Signature

> **translate**(`_`: (`d`: `string`, `locale?`: `string`) => `string`): `this`

Defined in: [utils/BaseClass.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L215)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `string`, `locale?`: `string`) => `string` |

###### Returns

`this`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Axis`](#axis).[`translate`](#translate-1)

<a id="width-3"></a>

##### width()

###### Call Signature

> **width**(): `number`

Defined in: [components/Axis.ts:1924](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1924)

Overall width of the axis.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`width`](#width-1)

###### Call Signature

> **width**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1925](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1925)

Overall width of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`width`](#width-1)

#### Properties

| Property | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="property-_align-2"></a> `_align` | `string` | [`Axis`](#axis).[`_align`](#property-_align) | [components/Axis.ts:206](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L206) |
| <a id="property-_availableticks-2"></a> `_availableTicks` | `unknown`[] | [`Axis`](#axis).[`_availableTicks`](#property-_availableticks) | [components/Axis.ts:271](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L271) |
| <a id="property-_barconfig-2"></a> `_barConfig` | `Record`\<`string`, `unknown`\> | [`Axis`](#axis).[`_barConfig`](#property-_barconfig) | [components/Axis.ts:207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L207) |
| <a id="property-_configdefault-3"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | [`Axis`](#axis).[`_configDefault`](#property-_configdefault-1) | [utils/BaseClass.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L69) |
| <a id="property-_d3scale-2"></a> `_d3Scale` | `any` | [`Axis`](#axis).[`_d3Scale`](#property-_d3scale) | [components/Axis.ts:266](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L266) |
| <a id="property-_d3scalenegative-2"></a> `_d3ScaleNegative` | `any` | [`Axis`](#axis).[`_d3ScaleNegative`](#property-_d3scalenegative) | [components/Axis.ts:268](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L268) |
| <a id="property-_data-3"></a> `_data` | `any`[] | [`Axis`](#axis).[`_data`](#property-_data-1) | [components/Axis.ts:209](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L209) |
| <a id="property-_domain-2"></a> `_domain` | `any`[] | [`Axis`](#axis).[`_domain`](#property-_domain) | [components/Axis.ts:211](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L211) |
| <a id="property-_duration-3"></a> `_duration` | `number` | [`Axis`](#axis).[`_duration`](#property-_duration-1) | [components/Axis.ts:212](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L212) |
| <a id="property-_grid-2"></a> `_grid` | `unknown`[] \| *required* | [`Axis`](#axis).[`_grid`](#property-_grid) | [components/Axis.ts:216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L216) |
| <a id="property-_gridconfig-2"></a> `_gridConfig` | `Record`\<`string`, `unknown`\> | [`Axis`](#axis).[`_gridConfig`](#property-_gridconfig) | [components/Axis.ts:213](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L213) |
| <a id="property-_gridlog-2"></a> `_gridLog` | `boolean` | [`Axis`](#axis).[`_gridLog`](#property-_gridlog) | [components/Axis.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L214) |
| <a id="property-_gridsize-2"></a> `_gridSize` | `number` \| *required* | [`Axis`](#axis).[`_gridSize`](#property-_gridsize) | [components/Axis.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L215) |
| <a id="property-_group-3"></a> `_group` | `Selection` | [`Axis`](#axis).[`_group`](#property-_group-1) | [components/Axis.ts:269](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L269) |
| <a id="property-_height-2"></a> `_height` | `number` | [`Axis`](#axis).[`_height`](#property-_height) | [components/Axis.ts:217](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L217) |
| <a id="property-_labeloffset-2"></a> `_labelOffset` | `boolean` | [`Axis`](#axis).[`_labelOffset`](#property-_labeloffset) | [components/Axis.ts:218](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L218) |
| <a id="property-_labelrotation-2"></a> `_labelRotation` | `boolean` \| *required* | [`Axis`](#axis).[`_labelRotation`](#property-_labelrotation) | [components/Axis.ts:219](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L219) |
| <a id="property-_labels-2"></a> `_labels` | `unknown`[] \| *required* | [`Axis`](#axis).[`_labels`](#property-_labels) | [components/Axis.ts:220](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L220) |
| <a id="property-_lastscale-2"></a> `_lastScale` | ((`d`: `unknown`) => `number`) \| *required* | [`Axis`](#axis).[`_lastScale`](#property-_lastscale) | [components/Axis.ts:270](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L270) |
| <a id="property-_locale-3"></a> `_locale` | `any` | [`Axis`](#axis).[`_locale`](#property-_locale-1) | [components/Axis.ts:223](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L223) |
| <a id="property-_margin-2"></a> `_margin` | `Record`\<`string`, `number`\> | [`Axis`](#axis).[`_margin`](#property-_margin) | [components/Axis.ts:224](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L224) |
| <a id="property-_maxsize-2"></a> `_maxSize` | `number` | [`Axis`](#axis).[`_maxSize`](#property-_maxsize) | [components/Axis.ts:225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L225) |
| <a id="property-_minsize-2"></a> `_minSize` | `number` | [`Axis`](#axis).[`_minSize`](#property-_minsize) | [components/Axis.ts:226](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L226) |
| <a id="property-_on-3"></a> `_on` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | [`Axis`](#axis).[`_on`](#property-_on-1) | [utils/BaseClass.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L65) |
| <a id="property-_orient-2"></a> `_orient` | `string` | [`Axis`](#axis).[`_orient`](#property-_orient) | [components/Axis.ts:227](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L227) |
| <a id="property-_outerbounds-2"></a> `_outerBounds` | `Record`\<`string`, `number`\> | [`Axis`](#axis).[`_outerBounds`](#property-_outerbounds) | [components/Axis.ts:228](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L228) |
| <a id="property-_padding-2"></a> `_padding` | `number` | [`Axis`](#axis).[`_padding`](#property-_padding) | [components/Axis.ts:229](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L229) |
| <a id="property-_paddinginner-2"></a> `_paddingInner` | `number` | [`Axis`](#axis).[`_paddingInner`](#property-_paddinginner) | [components/Axis.ts:230](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L230) |
| <a id="property-_paddingouter-2"></a> `_paddingOuter` | `number` | [`Axis`](#axis).[`_paddingOuter`](#property-_paddingouter) | [components/Axis.ts:231](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L231) |
| <a id="property-_parent-3"></a> `_parent` | `Record`\<`string`, `unknown`\> | [`Axis`](#axis).[`_parent`](#property-_parent-1) | [utils/BaseClass.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L66) |
| <a id="property-_position-2"></a> `_position` | `object` | [`Axis`](#axis).[`_position`](#property-_position) | [components/Axis.ts:232](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L232) |
| `_position.height` | `string` | - | [components/Axis.ts:235](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L235) |
| `_position.horizontal` | `boolean` | - | [components/Axis.ts:233](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L233) |
| `_position.opposite` | `string` | - | [components/Axis.ts:238](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L238) |
| `_position.width` | `string` | - | [components/Axis.ts:234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L234) |
| `_position.x` | `string` | - | [components/Axis.ts:236](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L236) |
| `_position.y` | `string` | - | [components/Axis.ts:237](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L237) |
| <a id="property-_range-2"></a> `_range` | (`number` \| `undefined`)[] \| *required* | [`Axis`](#axis).[`_range`](#property-_range) | [components/Axis.ts:240](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L240) |
| <a id="property-_rounding-2"></a> `_rounding` | `string` | [`Axis`](#axis).[`_rounding`](#property-_rounding) | [components/Axis.ts:241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L241) |
| <a id="property-_roundinginsidemaxprefix-2"></a> `_roundingInsideMaxPrefix` | `string` | [`Axis`](#axis).[`_roundingInsideMaxPrefix`](#property-_roundinginsidemaxprefix) | [components/Axis.ts:244](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L244) |
| <a id="property-_roundinginsidemaxsuffix-2"></a> `_roundingInsideMaxSuffix` | `string` | [`Axis`](#axis).[`_roundingInsideMaxSuffix`](#property-_roundinginsidemaxsuffix) | [components/Axis.ts:245](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L245) |
| <a id="property-_roundinginsideminprefix-2"></a> `_roundingInsideMinPrefix` | `string` | [`Axis`](#axis).[`_roundingInsideMinPrefix`](#property-_roundinginsideminprefix) | [components/Axis.ts:242](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L242) |
| <a id="property-_roundinginsideminsuffix-2"></a> `_roundingInsideMinSuffix` | `string` | [`Axis`](#axis).[`_roundingInsideMinSuffix`](#property-_roundinginsideminsuffix) | [components/Axis.ts:243](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L243) |
| <a id="property-_scale-3"></a> `_scale` | `string` | [`Axis`](#axis).[`_scale`](#property-_scale-1) | [components/Axis.ts:246](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L246) |
| <a id="property-_scalepadding-2"></a> `_scalePadding` | `number` | [`Axis`](#axis).[`_scalePadding`](#property-_scalepadding) | [components/Axis.ts:247](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L247) |
| <a id="property-_select-3"></a> `_select` | `Selection` | [`Axis`](#axis).[`_select`](#property-_select-1) | [components/Axis.ts:205](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L205) |
| <a id="property-_shape-2"></a> `_shape` | `string` | [`Axis`](#axis).[`_shape`](#property-_shape) | [components/Axis.ts:248](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L248) |
| <a id="property-_shapeconfig-3"></a> `_shapeConfig` | `Record`\<`string`, `any`\> | [`Axis`](#axis).[`_shapeConfig`](#property-_shapeconfig-1) | [components/Axis.ts:251](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L251) |
| <a id="property-_tickformat-2"></a> `_tickFormat` | `any` | [`Axis`](#axis).[`_tickFormat`](#property-_tickformat) | [components/Axis.ts:253](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L253) |
| <a id="property-_ticks-2"></a> `_ticks` | `unknown`[] \| *required* | [`Axis`](#axis).[`_ticks`](#property-_ticks) | [components/Axis.ts:254](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L254) |
| <a id="property-_ticksize-2"></a> `_tickSize` | `number` | [`Axis`](#axis).[`_tickSize`](#property-_ticksize) | [components/Axis.ts:255](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L255) |
| <a id="property-_ticksuffix-2"></a> `_tickSuffix` | `string` | [`Axis`](#axis).[`_tickSuffix`](#property-_ticksuffix) | [components/Axis.ts:256](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L256) |
| <a id="property-_tickunit-2"></a> `_tickUnit` | `number` | [`Axis`](#axis).[`_tickUnit`](#property-_tickunit) | [components/Axis.ts:257](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L257) |
| <a id="property-_timelocale-2"></a> `_timeLocale` | `Record`\<`string`, `unknown`\> \| *required* | [`Axis`](#axis).[`_timeLocale`](#property-_timelocale) | [components/Axis.ts:258](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L258) |
| <a id="property-_title-2"></a> `_title` | `string` \| *required* | [`Axis`](#axis).[`_title`](#property-_title) | [components/Axis.ts:259](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L259) |
| <a id="property-_titleclass-2"></a> `_titleClass` | [`TextBox`](#textbox) | [`Axis`](#axis).[`_titleClass`](#property-_titleclass) | [components/Axis.ts:260](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L260) |
| <a id="property-_titleconfig-2"></a> `_titleConfig` | `Record`\<`string`, `any`\> | [`Axis`](#axis).[`_titleConfig`](#property-_titleconfig) | [components/Axis.ts:262](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L262) |
| <a id="property-_transition-3"></a> `_transition` | `Transition`\<`BaseType`\> | [`Axis`](#axis).[`_transition`](#property-_transition-1) | [components/Axis.ts:273](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L273) |
| <a id="property-_translate-3"></a> `_translate` | (`d`: `string`, `locale?`: `string`) => `string` | [`Axis`](#axis).[`_translate`](#property-_translate-1) | [utils/BaseClass.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L67) |
| <a id="property-_userformat-2"></a> `_userFormat` | `false` \| ((`d`: `unknown`) => `string`) \| *required* | [`Axis`](#axis).[`_userFormat`](#property-_userformat) | [components/Axis.ts:274](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L274) |
| <a id="property-_uuid-3"></a> `_uuid` | `string` | [`Axis`](#axis).[`_uuid`](#property-_uuid-1) | [utils/BaseClass.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L68) |
| <a id="property-_visibleticks-2"></a> `_visibleTicks` | `unknown`[] | [`Axis`](#axis).[`_visibleTicks`](#property-_visibleticks) | [components/Axis.ts:272](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L272) |
| <a id="property-_width-2"></a> `_width` | `number` | [`Axis`](#axis).[`_width`](#property-_width) | [components/Axis.ts:263](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L263) |

***

<a id="axisright"></a>

### AxisRight

Defined in: [components/AxisRight.ts:6](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/AxisRight.ts#L6)

Shorthand method for creating an axis where the ticks are drawn to the right of the vertical domain path. Extends all functionality of the base [Axis](#Axis) class.

#### Extends

- [`Axis`](#axis)

#### Methods

<a id="align-3"></a>

##### align()

###### Call Signature

> **align**(): `string`

Defined in: [components/Axis.ts:1520](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1520)

The horizontal alignment.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`align`](#align)

###### Call Signature

> **align**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1521](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1521)

The horizontal alignment.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`align`](#align)

<a id="barconfig-3"></a>

##### barConfig()

###### Call Signature

> **barConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Axis.ts:1529](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1529)

Axis line style.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Axis`](#axis).[`barConfig`](#barconfig)

###### Call Signature

> **barConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1530](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1530)

Axis line style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`barConfig`](#barconfig)

<a id="config-4"></a>

##### config()

###### Call Signature

> **config**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L91)

Methods that correspond to the key/value pairs and returns this class.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`Axis`](#axis).[`config`](#config-1)

###### Call Signature

> **config**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L92)

Methods that correspond to the key/value pairs and returns this class.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`config`](#config-1)

<a id="data-5"></a>

##### data()

###### Call Signature

> **data**(): `any`[]

Defined in: [components/Axis.ts:1541](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1541)

An array of data points, which helps determine which ticks should be shown and which time resolution should be displayed.

###### Returns

`any`[]

###### Inherited from

[`Axis`](#axis).[`data`](#data-2)

###### Call Signature

> **data**(`_`: `any`[]): `this`

Defined in: [components/Axis.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1543)

An array of data points, which helps determine which ticks should be shown and which time resolution should be displayed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`data`](#data-2)

<a id="domain-3"></a>

##### domain()

###### Call Signature

> **domain**(): `any`[]

Defined in: [components/Axis.ts:1553](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1553)

Scale domain of the axis.

###### Returns

`any`[]

###### Inherited from

[`Axis`](#axis).[`domain`](#domain)

###### Call Signature

> **domain**(`_`: `any`[]): `this`

Defined in: [components/Axis.ts:1555](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1555)

Scale domain of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`domain`](#domain)

<a id="duration-5"></a>

##### duration()

###### Call Signature

> **duration**(): `number`

Defined in: [components/Axis.ts:1564](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1564)

Transition duration of the axis.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`duration`](#duration-2)

###### Call Signature

> **duration**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1565](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1565)

Transition duration of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`duration`](#duration-2)

<a id="grid-3"></a>

##### grid()

###### Call Signature

> **grid**(): `unknown`[] \| `undefined`

Defined in: [components/Axis.ts:1573](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1573)

Grid values of the axis.

###### Returns

`unknown`[] \| `undefined`

###### Inherited from

[`Axis`](#axis).[`grid`](#grid)

###### Call Signature

> **grid**(`_`: `unknown`[]): `this`

Defined in: [components/Axis.ts:1574](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1574)

Grid values of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`grid`](#grid)

<a id="gridconfig-3"></a>

##### gridConfig()

###### Call Signature

> **gridConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Axis.ts:1582](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1582)

Grid config of the axis.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Axis`](#axis).[`gridConfig`](#gridconfig)

###### Call Signature

> **gridConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1583)

Grid config of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`gridConfig`](#gridconfig)

<a id="gridlog-3"></a>

##### gridLog()

###### Call Signature

> **gridLog**(): `boolean`

Defined in: [components/Axis.ts:1593](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1593)

Grid behavior of the axis when scale is logarithmic.

###### Returns

`boolean`

###### Inherited from

[`Axis`](#axis).[`gridLog`](#gridlog)

###### Call Signature

> **gridLog**(`_`: `boolean`): `this`

Defined in: [components/Axis.ts:1594](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1594)

Grid behavior of the axis when scale is logarithmic.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`gridLog`](#gridlog)

<a id="gridsize-3"></a>

##### gridSize()

###### Call Signature

> **gridSize**(): `number` \| `undefined`

Defined in: [components/Axis.ts:1602](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1602)

Grid size of the axis.

###### Returns

`number` \| `undefined`

###### Inherited from

[`Axis`](#axis).[`gridSize`](#gridsize)

###### Call Signature

> **gridSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1603](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1603)

Grid size of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`gridSize`](#gridsize)

<a id="height-4"></a>

##### height()

###### Call Signature

> **height**(): `number`

Defined in: [components/Axis.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1611)

Overall height of the axis.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`height`](#height-1)

###### Call Signature

> **height**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1612](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1612)

Overall height of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`height`](#height-1)

<a id="labeloffset-3"></a>

##### labelOffset()

###### Call Signature

> **labelOffset**(): `boolean`

Defined in: [components/Axis.ts:1629](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1629)

Whether to offset overlapping labels further from the axis to prevent collisions.

###### Returns

`boolean`

###### Inherited from

[`Axis`](#axis).[`labelOffset`](#labeloffset)

###### Call Signature

> **labelOffset**(`_`: `boolean`): `this`

Defined in: [components/Axis.ts:1630](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1630)

Whether to offset overlapping labels further from the axis to prevent collisions.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`labelOffset`](#labeloffset)

<a id="labelrotation-3"></a>

##### labelRotation()

###### Call Signature

> **labelRotation**(): `boolean` \| `undefined`

Defined in: [components/Axis.ts:1640](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1640)

Whether to rotate horizontal axis labels -90 degrees.

###### Returns

`boolean` \| `undefined`

###### Inherited from

[`Axis`](#axis).[`labelRotation`](#labelrotation)

###### Call Signature

> **labelRotation**(`_`: `boolean`): `this`

Defined in: [components/Axis.ts:1641](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1641)

Whether to rotate horizontal axis labels -90 degrees.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`labelRotation`](#labelrotation)

<a id="labels-3"></a>

##### labels()

###### Call Signature

> **labels**(): `unknown`[] \| `undefined`

Defined in: [components/Axis.ts:1620](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1620)

Visible tick labels of the axis.

###### Returns

`unknown`[] \| `undefined`

###### Inherited from

[`Axis`](#axis).[`labels`](#labels)

###### Call Signature

> **labels**(`_`: `unknown`[]): `this`

Defined in: [components/Axis.ts:1621](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1621)

Visible tick labels of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`labels`](#labels)

<a id="locale-4"></a>

##### locale()

###### Call Signature

> **locale**(): `string`

Defined in: [utils/BaseClass.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L156)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Returns

`string`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Axis`](#axis).[`locale`](#locale-1)

###### Call Signature

> **locale**(`_`: `string` \| `object`): `this`

Defined in: [utils/BaseClass.ts:157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L157)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `object` |

###### Returns

`this`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Axis`](#axis).[`locale`](#locale-1)

<a id="maxsize-3"></a>

##### maxSize()

###### Call Signature

> **maxSize**(): `number`

Defined in: [components/Axis.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1651)

Maximum size allowed for the space that contains the axis tick labels and title.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`maxSize`](#maxsize)

###### Call Signature

> **maxSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1652](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1652)

Maximum size allowed for the space that contains the axis tick labels and title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`maxSize`](#maxsize)

<a id="minsize-3"></a>

##### minSize()

###### Call Signature

> **minSize**(): `number`

Defined in: [components/Axis.ts:1660](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1660)

Minimum size alloted for the space that contains the axis tick labels and title.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`minSize`](#minsize)

###### Call Signature

> **minSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1661](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1661)

Minimum size alloted for the space that contains the axis tick labels and title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`minSize`](#minsize)

<a id="on-4"></a>

##### on()

###### Call Signature

> **on**(): `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

Defined in: [utils/BaseClass.ts:176](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L176)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Returns

`Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Axis`](#axis).[`on`](#on-1)

###### Call Signature

> **on**(`_`: `string`): ((...`args`: `unknown`[]) => `unknown`) \| `undefined`

Defined in: [utils/BaseClass.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L177)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

((...`args`: `unknown`[]) => `unknown`) \| `undefined`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Axis`](#axis).[`on`](#on-1)

###### Call Signature

> **on**(`_`: `string`, `f`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [utils/BaseClass.ts:178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L178)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |
| `f` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Axis`](#axis).[`on`](#on-1)

###### Call Signature

> **on**(`_`: `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:179](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L179)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Axis`](#axis).[`on`](#on-1)

<a id="orient-3"></a>

##### orient()

###### Call Signature

> **orient**(): `string`

Defined in: [components/Axis.ts:1669](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1669)

The orientation of the shape.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`orient`](#orient)

###### Call Signature

> **orient**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1670](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1670)

The orientation of the shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`orient`](#orient)

<a id="outerbounds-3"></a>

##### outerBounds()

> **outerBounds**(): `Record`\<`string`, `number`\>

Defined in: [components/Axis.ts:1700](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1700)

Returns the outer bounds of the axis content. Must be called after rendering.

###### Returns

`Record`\<`string`, `number`\>

###### Example

```ts
{"width": 180, "height": 24, "x": 10, "y": 20}
```

###### Inherited from

[`Axis`](#axis).[`outerBounds`](#outerbounds)

<a id="padding-3"></a>

##### padding()

###### Call Signature

> **padding**(): `number`

Defined in: [components/Axis.ts:1707](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1707)

The padding between each tick label.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`padding`](#padding)

###### Call Signature

> **padding**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1708)

The padding between each tick label.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`padding`](#padding)

<a id="paddinginner-3"></a>

##### paddingInner()

###### Call Signature

> **paddingInner**(): `number`

Defined in: [components/Axis.ts:1716](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1716)

The inner padding of band scale.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`paddingInner`](#paddinginner)

###### Call Signature

> **paddingInner**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1717)

The inner padding of band scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`paddingInner`](#paddinginner)

<a id="paddingouter-3"></a>

##### paddingOuter()

###### Call Signature

> **paddingOuter**(): `number`

Defined in: [components/Axis.ts:1727](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1727)

The outer padding of band scales.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`paddingOuter`](#paddingouter)

###### Call Signature

> **paddingOuter**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1728](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1728)

The outer padding of band scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`paddingOuter`](#paddingouter)

<a id="parent-4"></a>

##### parent()

###### Call Signature

> **parent**(): `Record`\<`string`, `unknown`\>

Defined in: [utils/BaseClass.ts:200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L200)

Parent config used by the wrapper.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Axis`](#axis).[`parent`](#parent-1)

###### Call Signature

> **parent**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L201)

Parent config used by the wrapper.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`parent`](#parent-1)

<a id="range-3"></a>

##### range()

###### Call Signature

> **range**(): (`number` \| `undefined`)[] \| `undefined`

Defined in: [components/Axis.ts:1738](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1738)

Scale range (in pixels) of the axis. The given array must have 2 values, but one may be `undefined` to allow the default behavior for that value.

###### Returns

(`number` \| `undefined`)[] \| `undefined`

###### Inherited from

[`Axis`](#axis).[`range`](#range)

###### Call Signature

> **range**(`_`: (`number` \| `undefined`)[]): `this`

Defined in: [components/Axis.ts:1739](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1739)

Scale range (in pixels) of the axis. The given array must have 2 values, but one may be `undefined` to allow the default behavior for that value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`number` \| `undefined`)[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`range`](#range)

<a id="render-5"></a>

##### render()

> **render**(`callback?`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [components/Axis.ts:566](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L566)

Renders the current Axis to the page.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | (...`args`: `unknown`[]) => `unknown` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`render`](#render-2)

<a id="rounding-3"></a>

##### rounding()

###### Call Signature

> **rounding**(): `string`

Defined in: [components/Axis.ts:1747](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1747)

The rounding method for more evenly spaced ticks at the extents of the scale. Can be "none" (default), "outside", or "inside".

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`rounding`](#rounding)

###### Call Signature

> **rounding**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1748](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1748)

The rounding method for more evenly spaced ticks at the extents of the scale. Can be "none" (default), "outside", or "inside".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`rounding`](#rounding)

<a id="roundinginsidemaxprefix-3"></a>

##### roundingInsideMaxPrefix()

###### Call Signature

> **roundingInsideMaxPrefix**(): `string`

Defined in: [components/Axis.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1778)

The prefix for the maximum value of "inside" rounding scales.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMaxPrefix`](#roundinginsidemaxprefix)

###### Call Signature

> **roundingInsideMaxPrefix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1779](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1779)

The prefix for the maximum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMaxPrefix`](#roundinginsidemaxprefix)

<a id="roundinginsidemaxsuffix-3"></a>

##### roundingInsideMaxSuffix()

###### Call Signature

> **roundingInsideMaxSuffix**(): `string`

Defined in: [components/Axis.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1789)

The suffix for the maximum value of "inside" rounding scales.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMaxSuffix`](#roundinginsidemaxsuffix)

###### Call Signature

> **roundingInsideMaxSuffix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1790](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1790)

The suffix for the maximum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMaxSuffix`](#roundinginsidemaxsuffix)

<a id="roundinginsideminprefix-3"></a>

##### roundingInsideMinPrefix()

###### Call Signature

> **roundingInsideMinPrefix**(): `string`

Defined in: [components/Axis.ts:1756](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1756)

The prefix for the minimum value of "inside" rounding scales.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMinPrefix`](#roundinginsideminprefix)

###### Call Signature

> **roundingInsideMinPrefix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1757](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1757)

The prefix for the minimum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMinPrefix`](#roundinginsideminprefix)

<a id="roundinginsideminsuffix-3"></a>

##### roundingInsideMinSuffix()

###### Call Signature

> **roundingInsideMinSuffix**(): `string`

Defined in: [components/Axis.ts:1767](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1767)

The suffix for the minimum value of "inside" rounding scales.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMinSuffix`](#roundinginsideminsuffix)

###### Call Signature

> **roundingInsideMinSuffix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1768](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1768)

The suffix for the minimum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMinSuffix`](#roundinginsideminsuffix)

<a id="scale-4"></a>

##### scale()

###### Call Signature

> **scale**(): `string`

Defined in: [components/Axis.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1800)

Scale of the axis.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`scale`](#scale-1)

###### Call Signature

> **scale**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1801](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1801)

Scale of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`scale`](#scale-1)

<a id="scalepadding-3"></a>

##### scalePadding()

###### Call Signature

> **scalePadding**(): `number`

Defined in: [components/Axis.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1809)

The "padding" property of the scale, often used in point scales.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`scalePadding`](#scalepadding)

###### Call Signature

> **scalePadding**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1810](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1810)

The "padding" property of the scale, often used in point scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`scalePadding`](#scalepadding)

<a id="select-5"></a>

##### select()

###### Call Signature

> **select**(): `Selection`

Defined in: [components/Axis.ts:1820](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1820)

The SVG container element as a d3 selector or DOM element.

###### Returns

`Selection`

###### Inherited from

[`Axis`](#axis).[`select`](#select-2)

###### Call Signature

> **select**(`_`: `string` \| `HTMLElement`): `this`

Defined in: [components/Axis.ts:1821](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1821)

The SVG container element as a d3 selector or DOM element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `HTMLElement` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`select`](#select-2)

<a id="shape-4"></a>

##### shape()

###### Call Signature

> **shape**(): `string`

Defined in: [components/Axis.ts:1831](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1831)

Tick shape constructor.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`shape`](#shape-1)

###### Call Signature

> **shape**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1832)

Tick shape constructor.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`shape`](#shape-1)

<a id="shapeconfig-5"></a>

##### shapeConfig()

###### Call Signature

> **shapeConfig**(): `Record`\<`string`, `any`\>

Defined in: [components/Axis.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1841)

Tick style of the axis.

###### Returns

`Record`\<`string`, `any`\>

###### Inherited from

[`Axis`](#axis).[`shapeConfig`](#shapeconfig-2)

###### Call Signature

> **shapeConfig**(`_`: `Record`\<`string`, `any`\>): `this`

Defined in: [components/Axis.ts:1843](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1843)

Tick style of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `any`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`shapeConfig`](#shapeconfig-2)

<a id="tickformat-3"></a>

##### tickFormat()

###### Call Signature

> **tickFormat**(): `any`

Defined in: [components/Axis.ts:1855](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1855)

Tick formatter.

###### Returns

`any`

###### Inherited from

[`Axis`](#axis).[`tickFormat`](#tickformat)

###### Call Signature

> **tickFormat**(`_`: `any`): `this`

Defined in: [components/Axis.ts:1857](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1857)

Tick formatter.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`tickFormat`](#tickformat)

<a id="ticks-3"></a>

##### ticks()

###### Call Signature

> **ticks**(): `unknown`[] \| `undefined`

Defined in: [components/Axis.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1866)

Tick values of the axis.

###### Returns

`unknown`[] \| `undefined`

###### Inherited from

[`Axis`](#axis).[`ticks`](#ticks)

###### Call Signature

> **ticks**(`_`: `unknown`[]): `this`

Defined in: [components/Axis.ts:1867](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1867)

Tick values of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`ticks`](#ticks)

<a id="ticksize-3"></a>

##### tickSize()

###### Call Signature

> **tickSize**(): `number`

Defined in: [components/Axis.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1875)

Tick size of the axis.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`tickSize`](#ticksize)

###### Call Signature

> **tickSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1876](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1876)

Tick size of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`tickSize`](#ticksize)

<a id="ticksuffix-3"></a>

##### tickSuffix()

###### Call Signature

> **tickSuffix**(): `string`

Defined in: [components/Axis.ts:1884](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1884)

The tick abbreviation behavior for linear scales. Accepts "normal" (uses formatAbbreviate) or "smallest" (uses the suffix from the smallest tick as reference for every tick).

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`tickSuffix`](#ticksuffix)

###### Call Signature

> **tickSuffix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1885](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1885)

The tick abbreviation behavior for linear scales. Accepts "normal" (uses formatAbbreviate) or "smallest" (uses the suffix from the smallest tick as reference for every tick).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`tickSuffix`](#ticksuffix)

<a id="timelocale-3"></a>

##### timeLocale()

###### Call Signature

> **timeLocale**(): `Record`\<`string`, `unknown`\> \| `undefined`

Defined in: [components/Axis.ts:1895](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1895)

Defines a custom locale object to be used in time scale. This object must include the following properties: dateTime, date, time, periods, days, shortDays, months, shortMonths. For more information, you can revise [d3p.d3-time-format](https://github.com/d3/d3-time-format/blob/master/README.md#timeFormatLocale).

###### Returns

`Record`\<`string`, `unknown`\> \| `undefined`

###### Inherited from

[`Axis`](#axis).[`timeLocale`](#timelocale)

###### Call Signature

> **timeLocale**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1896](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1896)

Defines a custom locale object to be used in time scale. This object must include the following properties: dateTime, date, time, periods, days, shortDays, months, shortMonths. For more information, you can revise [d3p.d3-time-format](https://github.com/d3/d3-time-format/blob/master/README.md#timeFormatLocale).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`timeLocale`](#timelocale)

<a id="title-4"></a>

##### title()

###### Call Signature

> **title**(): `string` \| `undefined`

Defined in: [components/Axis.ts:1904](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1904)

Title of the axis.

###### Returns

`string` \| `undefined`

###### Inherited from

[`Axis`](#axis).[`title`](#title-1)

###### Call Signature

> **title**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1905](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1905)

Title of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`title`](#title-1)

<a id="titleconfig-4"></a>

##### titleConfig()

###### Call Signature

> **titleConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Axis.ts:1913](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1913)

Title configuration of the axis.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Axis`](#axis).[`titleConfig`](#titleconfig-1)

###### Call Signature

> **titleConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1914](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1914)

Title configuration of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`titleConfig`](#titleconfig-1)

<a id="translate-4"></a>

##### translate()

###### Call Signature

> **translate**(): (`d`: `string`, `locale?`: `string`) => `string`

Defined in: [utils/BaseClass.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L214)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Returns

(`d`: `string`, `locale?`: `string`) => `string`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Axis`](#axis).[`translate`](#translate-1)

###### Call Signature

> **translate**(`_`: (`d`: `string`, `locale?`: `string`) => `string`): `this`

Defined in: [utils/BaseClass.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L215)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `string`, `locale?`: `string`) => `string` |

###### Returns

`this`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Axis`](#axis).[`translate`](#translate-1)

<a id="width-4"></a>

##### width()

###### Call Signature

> **width**(): `number`

Defined in: [components/Axis.ts:1924](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1924)

Overall width of the axis.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`width`](#width-1)

###### Call Signature

> **width**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1925](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1925)

Overall width of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`width`](#width-1)

#### Properties

| Property | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="property-_align-3"></a> `_align` | `string` | [`Axis`](#axis).[`_align`](#property-_align) | [components/Axis.ts:206](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L206) |
| <a id="property-_availableticks-3"></a> `_availableTicks` | `unknown`[] | [`Axis`](#axis).[`_availableTicks`](#property-_availableticks) | [components/Axis.ts:271](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L271) |
| <a id="property-_barconfig-3"></a> `_barConfig` | `Record`\<`string`, `unknown`\> | [`Axis`](#axis).[`_barConfig`](#property-_barconfig) | [components/Axis.ts:207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L207) |
| <a id="property-_configdefault-4"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | [`Axis`](#axis).[`_configDefault`](#property-_configdefault-1) | [utils/BaseClass.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L69) |
| <a id="property-_d3scale-3"></a> `_d3Scale` | `any` | [`Axis`](#axis).[`_d3Scale`](#property-_d3scale) | [components/Axis.ts:266](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L266) |
| <a id="property-_d3scalenegative-3"></a> `_d3ScaleNegative` | `any` | [`Axis`](#axis).[`_d3ScaleNegative`](#property-_d3scalenegative) | [components/Axis.ts:268](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L268) |
| <a id="property-_data-4"></a> `_data` | `any`[] | [`Axis`](#axis).[`_data`](#property-_data-1) | [components/Axis.ts:209](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L209) |
| <a id="property-_domain-3"></a> `_domain` | `any`[] | [`Axis`](#axis).[`_domain`](#property-_domain) | [components/Axis.ts:211](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L211) |
| <a id="property-_duration-4"></a> `_duration` | `number` | [`Axis`](#axis).[`_duration`](#property-_duration-1) | [components/Axis.ts:212](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L212) |
| <a id="property-_grid-3"></a> `_grid` | `unknown`[] \| *required* | [`Axis`](#axis).[`_grid`](#property-_grid) | [components/Axis.ts:216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L216) |
| <a id="property-_gridconfig-3"></a> `_gridConfig` | `Record`\<`string`, `unknown`\> | [`Axis`](#axis).[`_gridConfig`](#property-_gridconfig) | [components/Axis.ts:213](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L213) |
| <a id="property-_gridlog-3"></a> `_gridLog` | `boolean` | [`Axis`](#axis).[`_gridLog`](#property-_gridlog) | [components/Axis.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L214) |
| <a id="property-_gridsize-3"></a> `_gridSize` | `number` \| *required* | [`Axis`](#axis).[`_gridSize`](#property-_gridsize) | [components/Axis.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L215) |
| <a id="property-_group-4"></a> `_group` | `Selection` | [`Axis`](#axis).[`_group`](#property-_group-1) | [components/Axis.ts:269](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L269) |
| <a id="property-_height-3"></a> `_height` | `number` | [`Axis`](#axis).[`_height`](#property-_height) | [components/Axis.ts:217](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L217) |
| <a id="property-_labeloffset-3"></a> `_labelOffset` | `boolean` | [`Axis`](#axis).[`_labelOffset`](#property-_labeloffset) | [components/Axis.ts:218](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L218) |
| <a id="property-_labelrotation-3"></a> `_labelRotation` | `boolean` \| *required* | [`Axis`](#axis).[`_labelRotation`](#property-_labelrotation) | [components/Axis.ts:219](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L219) |
| <a id="property-_labels-3"></a> `_labels` | `unknown`[] \| *required* | [`Axis`](#axis).[`_labels`](#property-_labels) | [components/Axis.ts:220](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L220) |
| <a id="property-_lastscale-3"></a> `_lastScale` | ((`d`: `unknown`) => `number`) \| *required* | [`Axis`](#axis).[`_lastScale`](#property-_lastscale) | [components/Axis.ts:270](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L270) |
| <a id="property-_locale-4"></a> `_locale` | `any` | [`Axis`](#axis).[`_locale`](#property-_locale-1) | [components/Axis.ts:223](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L223) |
| <a id="property-_margin-3"></a> `_margin` | `Record`\<`string`, `number`\> | [`Axis`](#axis).[`_margin`](#property-_margin) | [components/Axis.ts:224](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L224) |
| <a id="property-_maxsize-3"></a> `_maxSize` | `number` | [`Axis`](#axis).[`_maxSize`](#property-_maxsize) | [components/Axis.ts:225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L225) |
| <a id="property-_minsize-3"></a> `_minSize` | `number` | [`Axis`](#axis).[`_minSize`](#property-_minsize) | [components/Axis.ts:226](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L226) |
| <a id="property-_on-4"></a> `_on` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | [`Axis`](#axis).[`_on`](#property-_on-1) | [utils/BaseClass.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L65) |
| <a id="property-_orient-3"></a> `_orient` | `string` | [`Axis`](#axis).[`_orient`](#property-_orient) | [components/Axis.ts:227](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L227) |
| <a id="property-_outerbounds-3"></a> `_outerBounds` | `Record`\<`string`, `number`\> | [`Axis`](#axis).[`_outerBounds`](#property-_outerbounds) | [components/Axis.ts:228](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L228) |
| <a id="property-_padding-3"></a> `_padding` | `number` | [`Axis`](#axis).[`_padding`](#property-_padding) | [components/Axis.ts:229](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L229) |
| <a id="property-_paddinginner-3"></a> `_paddingInner` | `number` | [`Axis`](#axis).[`_paddingInner`](#property-_paddinginner) | [components/Axis.ts:230](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L230) |
| <a id="property-_paddingouter-3"></a> `_paddingOuter` | `number` | [`Axis`](#axis).[`_paddingOuter`](#property-_paddingouter) | [components/Axis.ts:231](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L231) |
| <a id="property-_parent-4"></a> `_parent` | `Record`\<`string`, `unknown`\> | [`Axis`](#axis).[`_parent`](#property-_parent-1) | [utils/BaseClass.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L66) |
| <a id="property-_position-3"></a> `_position` | `object` | [`Axis`](#axis).[`_position`](#property-_position) | [components/Axis.ts:232](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L232) |
| `_position.height` | `string` | - | [components/Axis.ts:235](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L235) |
| `_position.horizontal` | `boolean` | - | [components/Axis.ts:233](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L233) |
| `_position.opposite` | `string` | - | [components/Axis.ts:238](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L238) |
| `_position.width` | `string` | - | [components/Axis.ts:234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L234) |
| `_position.x` | `string` | - | [components/Axis.ts:236](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L236) |
| `_position.y` | `string` | - | [components/Axis.ts:237](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L237) |
| <a id="property-_range-3"></a> `_range` | (`number` \| `undefined`)[] \| *required* | [`Axis`](#axis).[`_range`](#property-_range) | [components/Axis.ts:240](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L240) |
| <a id="property-_rounding-3"></a> `_rounding` | `string` | [`Axis`](#axis).[`_rounding`](#property-_rounding) | [components/Axis.ts:241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L241) |
| <a id="property-_roundinginsidemaxprefix-3"></a> `_roundingInsideMaxPrefix` | `string` | [`Axis`](#axis).[`_roundingInsideMaxPrefix`](#property-_roundinginsidemaxprefix) | [components/Axis.ts:244](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L244) |
| <a id="property-_roundinginsidemaxsuffix-3"></a> `_roundingInsideMaxSuffix` | `string` | [`Axis`](#axis).[`_roundingInsideMaxSuffix`](#property-_roundinginsidemaxsuffix) | [components/Axis.ts:245](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L245) |
| <a id="property-_roundinginsideminprefix-3"></a> `_roundingInsideMinPrefix` | `string` | [`Axis`](#axis).[`_roundingInsideMinPrefix`](#property-_roundinginsideminprefix) | [components/Axis.ts:242](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L242) |
| <a id="property-_roundinginsideminsuffix-3"></a> `_roundingInsideMinSuffix` | `string` | [`Axis`](#axis).[`_roundingInsideMinSuffix`](#property-_roundinginsideminsuffix) | [components/Axis.ts:243](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L243) |
| <a id="property-_scale-4"></a> `_scale` | `string` | [`Axis`](#axis).[`_scale`](#property-_scale-1) | [components/Axis.ts:246](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L246) |
| <a id="property-_scalepadding-3"></a> `_scalePadding` | `number` | [`Axis`](#axis).[`_scalePadding`](#property-_scalepadding) | [components/Axis.ts:247](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L247) |
| <a id="property-_select-4"></a> `_select` | `Selection` | [`Axis`](#axis).[`_select`](#property-_select-1) | [components/Axis.ts:205](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L205) |
| <a id="property-_shape-3"></a> `_shape` | `string` | [`Axis`](#axis).[`_shape`](#property-_shape) | [components/Axis.ts:248](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L248) |
| <a id="property-_shapeconfig-4"></a> `_shapeConfig` | `Record`\<`string`, `any`\> | [`Axis`](#axis).[`_shapeConfig`](#property-_shapeconfig-1) | [components/Axis.ts:251](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L251) |
| <a id="property-_tickformat-3"></a> `_tickFormat` | `any` | [`Axis`](#axis).[`_tickFormat`](#property-_tickformat) | [components/Axis.ts:253](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L253) |
| <a id="property-_ticks-3"></a> `_ticks` | `unknown`[] \| *required* | [`Axis`](#axis).[`_ticks`](#property-_ticks) | [components/Axis.ts:254](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L254) |
| <a id="property-_ticksize-3"></a> `_tickSize` | `number` | [`Axis`](#axis).[`_tickSize`](#property-_ticksize) | [components/Axis.ts:255](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L255) |
| <a id="property-_ticksuffix-3"></a> `_tickSuffix` | `string` | [`Axis`](#axis).[`_tickSuffix`](#property-_ticksuffix) | [components/Axis.ts:256](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L256) |
| <a id="property-_tickunit-3"></a> `_tickUnit` | `number` | [`Axis`](#axis).[`_tickUnit`](#property-_tickunit) | [components/Axis.ts:257](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L257) |
| <a id="property-_timelocale-3"></a> `_timeLocale` | `Record`\<`string`, `unknown`\> \| *required* | [`Axis`](#axis).[`_timeLocale`](#property-_timelocale) | [components/Axis.ts:258](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L258) |
| <a id="property-_title-3"></a> `_title` | `string` \| *required* | [`Axis`](#axis).[`_title`](#property-_title) | [components/Axis.ts:259](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L259) |
| <a id="property-_titleclass-3"></a> `_titleClass` | [`TextBox`](#textbox) | [`Axis`](#axis).[`_titleClass`](#property-_titleclass) | [components/Axis.ts:260](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L260) |
| <a id="property-_titleconfig-3"></a> `_titleConfig` | `Record`\<`string`, `any`\> | [`Axis`](#axis).[`_titleConfig`](#property-_titleconfig) | [components/Axis.ts:262](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L262) |
| <a id="property-_transition-4"></a> `_transition` | `Transition`\<`BaseType`\> | [`Axis`](#axis).[`_transition`](#property-_transition-1) | [components/Axis.ts:273](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L273) |
| <a id="property-_translate-4"></a> `_translate` | (`d`: `string`, `locale?`: `string`) => `string` | [`Axis`](#axis).[`_translate`](#property-_translate-1) | [utils/BaseClass.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L67) |
| <a id="property-_userformat-3"></a> `_userFormat` | `false` \| ((`d`: `unknown`) => `string`) \| *required* | [`Axis`](#axis).[`_userFormat`](#property-_userformat) | [components/Axis.ts:274](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L274) |
| <a id="property-_uuid-4"></a> `_uuid` | `string` | [`Axis`](#axis).[`_uuid`](#property-_uuid-1) | [utils/BaseClass.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L68) |
| <a id="property-_visibleticks-3"></a> `_visibleTicks` | `unknown`[] | [`Axis`](#axis).[`_visibleTicks`](#property-_visibleticks) | [components/Axis.ts:272](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L272) |
| <a id="property-_width-3"></a> `_width` | `number` | [`Axis`](#axis).[`_width`](#property-_width) | [components/Axis.ts:263](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L263) |

***

<a id="axistop"></a>

### AxisTop

Defined in: [components/AxisTop.ts:6](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/AxisTop.ts#L6)

Shorthand method for creating an axis where the ticks are drawn above the vertical domain path. Extends all functionality of the base [Axis](#Axis) class.

#### Extends

- [`Axis`](#axis)

#### Methods

<a id="align-4"></a>

##### align()

###### Call Signature

> **align**(): `string`

Defined in: [components/Axis.ts:1520](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1520)

The horizontal alignment.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`align`](#align)

###### Call Signature

> **align**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1521](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1521)

The horizontal alignment.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`align`](#align)

<a id="barconfig-4"></a>

##### barConfig()

###### Call Signature

> **barConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Axis.ts:1529](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1529)

Axis line style.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Axis`](#axis).[`barConfig`](#barconfig)

###### Call Signature

> **barConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1530](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1530)

Axis line style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`barConfig`](#barconfig)

<a id="config-5"></a>

##### config()

###### Call Signature

> **config**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L91)

Methods that correspond to the key/value pairs and returns this class.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`Axis`](#axis).[`config`](#config-1)

###### Call Signature

> **config**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L92)

Methods that correspond to the key/value pairs and returns this class.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`config`](#config-1)

<a id="data-6"></a>

##### data()

###### Call Signature

> **data**(): `any`[]

Defined in: [components/Axis.ts:1541](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1541)

An array of data points, which helps determine which ticks should be shown and which time resolution should be displayed.

###### Returns

`any`[]

###### Inherited from

[`Axis`](#axis).[`data`](#data-2)

###### Call Signature

> **data**(`_`: `any`[]): `this`

Defined in: [components/Axis.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1543)

An array of data points, which helps determine which ticks should be shown and which time resolution should be displayed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`data`](#data-2)

<a id="domain-4"></a>

##### domain()

###### Call Signature

> **domain**(): `any`[]

Defined in: [components/Axis.ts:1553](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1553)

Scale domain of the axis.

###### Returns

`any`[]

###### Inherited from

[`Axis`](#axis).[`domain`](#domain)

###### Call Signature

> **domain**(`_`: `any`[]): `this`

Defined in: [components/Axis.ts:1555](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1555)

Scale domain of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`domain`](#domain)

<a id="duration-6"></a>

##### duration()

###### Call Signature

> **duration**(): `number`

Defined in: [components/Axis.ts:1564](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1564)

Transition duration of the axis.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`duration`](#duration-2)

###### Call Signature

> **duration**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1565](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1565)

Transition duration of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`duration`](#duration-2)

<a id="grid-4"></a>

##### grid()

###### Call Signature

> **grid**(): `unknown`[] \| `undefined`

Defined in: [components/Axis.ts:1573](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1573)

Grid values of the axis.

###### Returns

`unknown`[] \| `undefined`

###### Inherited from

[`Axis`](#axis).[`grid`](#grid)

###### Call Signature

> **grid**(`_`: `unknown`[]): `this`

Defined in: [components/Axis.ts:1574](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1574)

Grid values of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`grid`](#grid)

<a id="gridconfig-4"></a>

##### gridConfig()

###### Call Signature

> **gridConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Axis.ts:1582](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1582)

Grid config of the axis.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Axis`](#axis).[`gridConfig`](#gridconfig)

###### Call Signature

> **gridConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1583)

Grid config of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`gridConfig`](#gridconfig)

<a id="gridlog-4"></a>

##### gridLog()

###### Call Signature

> **gridLog**(): `boolean`

Defined in: [components/Axis.ts:1593](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1593)

Grid behavior of the axis when scale is logarithmic.

###### Returns

`boolean`

###### Inherited from

[`Axis`](#axis).[`gridLog`](#gridlog)

###### Call Signature

> **gridLog**(`_`: `boolean`): `this`

Defined in: [components/Axis.ts:1594](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1594)

Grid behavior of the axis when scale is logarithmic.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`gridLog`](#gridlog)

<a id="gridsize-4"></a>

##### gridSize()

###### Call Signature

> **gridSize**(): `number` \| `undefined`

Defined in: [components/Axis.ts:1602](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1602)

Grid size of the axis.

###### Returns

`number` \| `undefined`

###### Inherited from

[`Axis`](#axis).[`gridSize`](#gridsize)

###### Call Signature

> **gridSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1603](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1603)

Grid size of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`gridSize`](#gridsize)

<a id="height-5"></a>

##### height()

###### Call Signature

> **height**(): `number`

Defined in: [components/Axis.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1611)

Overall height of the axis.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`height`](#height-1)

###### Call Signature

> **height**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1612](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1612)

Overall height of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`height`](#height-1)

<a id="labeloffset-4"></a>

##### labelOffset()

###### Call Signature

> **labelOffset**(): `boolean`

Defined in: [components/Axis.ts:1629](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1629)

Whether to offset overlapping labels further from the axis to prevent collisions.

###### Returns

`boolean`

###### Inherited from

[`Axis`](#axis).[`labelOffset`](#labeloffset)

###### Call Signature

> **labelOffset**(`_`: `boolean`): `this`

Defined in: [components/Axis.ts:1630](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1630)

Whether to offset overlapping labels further from the axis to prevent collisions.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`labelOffset`](#labeloffset)

<a id="labelrotation-4"></a>

##### labelRotation()

###### Call Signature

> **labelRotation**(): `boolean` \| `undefined`

Defined in: [components/Axis.ts:1640](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1640)

Whether to rotate horizontal axis labels -90 degrees.

###### Returns

`boolean` \| `undefined`

###### Inherited from

[`Axis`](#axis).[`labelRotation`](#labelrotation)

###### Call Signature

> **labelRotation**(`_`: `boolean`): `this`

Defined in: [components/Axis.ts:1641](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1641)

Whether to rotate horizontal axis labels -90 degrees.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`labelRotation`](#labelrotation)

<a id="labels-4"></a>

##### labels()

###### Call Signature

> **labels**(): `unknown`[] \| `undefined`

Defined in: [components/Axis.ts:1620](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1620)

Visible tick labels of the axis.

###### Returns

`unknown`[] \| `undefined`

###### Inherited from

[`Axis`](#axis).[`labels`](#labels)

###### Call Signature

> **labels**(`_`: `unknown`[]): `this`

Defined in: [components/Axis.ts:1621](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1621)

Visible tick labels of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`labels`](#labels)

<a id="locale-5"></a>

##### locale()

###### Call Signature

> **locale**(): `string`

Defined in: [utils/BaseClass.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L156)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Returns

`string`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Axis`](#axis).[`locale`](#locale-1)

###### Call Signature

> **locale**(`_`: `string` \| `object`): `this`

Defined in: [utils/BaseClass.ts:157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L157)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `object` |

###### Returns

`this`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Axis`](#axis).[`locale`](#locale-1)

<a id="maxsize-4"></a>

##### maxSize()

###### Call Signature

> **maxSize**(): `number`

Defined in: [components/Axis.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1651)

Maximum size allowed for the space that contains the axis tick labels and title.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`maxSize`](#maxsize)

###### Call Signature

> **maxSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1652](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1652)

Maximum size allowed for the space that contains the axis tick labels and title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`maxSize`](#maxsize)

<a id="minsize-4"></a>

##### minSize()

###### Call Signature

> **minSize**(): `number`

Defined in: [components/Axis.ts:1660](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1660)

Minimum size alloted for the space that contains the axis tick labels and title.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`minSize`](#minsize)

###### Call Signature

> **minSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1661](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1661)

Minimum size alloted for the space that contains the axis tick labels and title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`minSize`](#minsize)

<a id="on-5"></a>

##### on()

###### Call Signature

> **on**(): `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

Defined in: [utils/BaseClass.ts:176](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L176)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Returns

`Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Axis`](#axis).[`on`](#on-1)

###### Call Signature

> **on**(`_`: `string`): ((...`args`: `unknown`[]) => `unknown`) \| `undefined`

Defined in: [utils/BaseClass.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L177)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

((...`args`: `unknown`[]) => `unknown`) \| `undefined`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Axis`](#axis).[`on`](#on-1)

###### Call Signature

> **on**(`_`: `string`, `f`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [utils/BaseClass.ts:178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L178)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |
| `f` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Axis`](#axis).[`on`](#on-1)

###### Call Signature

> **on**(`_`: `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:179](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L179)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Axis`](#axis).[`on`](#on-1)

<a id="orient-4"></a>

##### orient()

###### Call Signature

> **orient**(): `string`

Defined in: [components/Axis.ts:1669](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1669)

The orientation of the shape.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`orient`](#orient)

###### Call Signature

> **orient**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1670](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1670)

The orientation of the shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`orient`](#orient)

<a id="outerbounds-4"></a>

##### outerBounds()

> **outerBounds**(): `Record`\<`string`, `number`\>

Defined in: [components/Axis.ts:1700](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1700)

Returns the outer bounds of the axis content. Must be called after rendering.

###### Returns

`Record`\<`string`, `number`\>

###### Example

```ts
{"width": 180, "height": 24, "x": 10, "y": 20}
```

###### Inherited from

[`Axis`](#axis).[`outerBounds`](#outerbounds)

<a id="padding-4"></a>

##### padding()

###### Call Signature

> **padding**(): `number`

Defined in: [components/Axis.ts:1707](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1707)

The padding between each tick label.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`padding`](#padding)

###### Call Signature

> **padding**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1708)

The padding between each tick label.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`padding`](#padding)

<a id="paddinginner-4"></a>

##### paddingInner()

###### Call Signature

> **paddingInner**(): `number`

Defined in: [components/Axis.ts:1716](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1716)

The inner padding of band scale.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`paddingInner`](#paddinginner)

###### Call Signature

> **paddingInner**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1717)

The inner padding of band scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`paddingInner`](#paddinginner)

<a id="paddingouter-4"></a>

##### paddingOuter()

###### Call Signature

> **paddingOuter**(): `number`

Defined in: [components/Axis.ts:1727](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1727)

The outer padding of band scales.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`paddingOuter`](#paddingouter)

###### Call Signature

> **paddingOuter**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1728](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1728)

The outer padding of band scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`paddingOuter`](#paddingouter)

<a id="parent-5"></a>

##### parent()

###### Call Signature

> **parent**(): `Record`\<`string`, `unknown`\>

Defined in: [utils/BaseClass.ts:200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L200)

Parent config used by the wrapper.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Axis`](#axis).[`parent`](#parent-1)

###### Call Signature

> **parent**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L201)

Parent config used by the wrapper.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`parent`](#parent-1)

<a id="range-4"></a>

##### range()

###### Call Signature

> **range**(): (`number` \| `undefined`)[] \| `undefined`

Defined in: [components/Axis.ts:1738](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1738)

Scale range (in pixels) of the axis. The given array must have 2 values, but one may be `undefined` to allow the default behavior for that value.

###### Returns

(`number` \| `undefined`)[] \| `undefined`

###### Inherited from

[`Axis`](#axis).[`range`](#range)

###### Call Signature

> **range**(`_`: (`number` \| `undefined`)[]): `this`

Defined in: [components/Axis.ts:1739](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1739)

Scale range (in pixels) of the axis. The given array must have 2 values, but one may be `undefined` to allow the default behavior for that value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`number` \| `undefined`)[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`range`](#range)

<a id="render-6"></a>

##### render()

> **render**(`callback?`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [components/Axis.ts:566](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L566)

Renders the current Axis to the page.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | (...`args`: `unknown`[]) => `unknown` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`render`](#render-2)

<a id="rounding-4"></a>

##### rounding()

###### Call Signature

> **rounding**(): `string`

Defined in: [components/Axis.ts:1747](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1747)

The rounding method for more evenly spaced ticks at the extents of the scale. Can be "none" (default), "outside", or "inside".

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`rounding`](#rounding)

###### Call Signature

> **rounding**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1748](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1748)

The rounding method for more evenly spaced ticks at the extents of the scale. Can be "none" (default), "outside", or "inside".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`rounding`](#rounding)

<a id="roundinginsidemaxprefix-4"></a>

##### roundingInsideMaxPrefix()

###### Call Signature

> **roundingInsideMaxPrefix**(): `string`

Defined in: [components/Axis.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1778)

The prefix for the maximum value of "inside" rounding scales.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMaxPrefix`](#roundinginsidemaxprefix)

###### Call Signature

> **roundingInsideMaxPrefix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1779](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1779)

The prefix for the maximum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMaxPrefix`](#roundinginsidemaxprefix)

<a id="roundinginsidemaxsuffix-4"></a>

##### roundingInsideMaxSuffix()

###### Call Signature

> **roundingInsideMaxSuffix**(): `string`

Defined in: [components/Axis.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1789)

The suffix for the maximum value of "inside" rounding scales.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMaxSuffix`](#roundinginsidemaxsuffix)

###### Call Signature

> **roundingInsideMaxSuffix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1790](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1790)

The suffix for the maximum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMaxSuffix`](#roundinginsidemaxsuffix)

<a id="roundinginsideminprefix-4"></a>

##### roundingInsideMinPrefix()

###### Call Signature

> **roundingInsideMinPrefix**(): `string`

Defined in: [components/Axis.ts:1756](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1756)

The prefix for the minimum value of "inside" rounding scales.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMinPrefix`](#roundinginsideminprefix)

###### Call Signature

> **roundingInsideMinPrefix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1757](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1757)

The prefix for the minimum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMinPrefix`](#roundinginsideminprefix)

<a id="roundinginsideminsuffix-4"></a>

##### roundingInsideMinSuffix()

###### Call Signature

> **roundingInsideMinSuffix**(): `string`

Defined in: [components/Axis.ts:1767](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1767)

The suffix for the minimum value of "inside" rounding scales.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMinSuffix`](#roundinginsideminsuffix)

###### Call Signature

> **roundingInsideMinSuffix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1768](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1768)

The suffix for the minimum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMinSuffix`](#roundinginsideminsuffix)

<a id="scale-5"></a>

##### scale()

###### Call Signature

> **scale**(): `string`

Defined in: [components/Axis.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1800)

Scale of the axis.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`scale`](#scale-1)

###### Call Signature

> **scale**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1801](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1801)

Scale of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`scale`](#scale-1)

<a id="scalepadding-4"></a>

##### scalePadding()

###### Call Signature

> **scalePadding**(): `number`

Defined in: [components/Axis.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1809)

The "padding" property of the scale, often used in point scales.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`scalePadding`](#scalepadding)

###### Call Signature

> **scalePadding**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1810](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1810)

The "padding" property of the scale, often used in point scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`scalePadding`](#scalepadding)

<a id="select-6"></a>

##### select()

###### Call Signature

> **select**(): `Selection`

Defined in: [components/Axis.ts:1820](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1820)

The SVG container element as a d3 selector or DOM element.

###### Returns

`Selection`

###### Inherited from

[`Axis`](#axis).[`select`](#select-2)

###### Call Signature

> **select**(`_`: `string` \| `HTMLElement`): `this`

Defined in: [components/Axis.ts:1821](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1821)

The SVG container element as a d3 selector or DOM element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `HTMLElement` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`select`](#select-2)

<a id="shape-5"></a>

##### shape()

###### Call Signature

> **shape**(): `string`

Defined in: [components/Axis.ts:1831](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1831)

Tick shape constructor.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`shape`](#shape-1)

###### Call Signature

> **shape**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1832)

Tick shape constructor.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`shape`](#shape-1)

<a id="shapeconfig-6"></a>

##### shapeConfig()

###### Call Signature

> **shapeConfig**(): `Record`\<`string`, `any`\>

Defined in: [components/Axis.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1841)

Tick style of the axis.

###### Returns

`Record`\<`string`, `any`\>

###### Inherited from

[`Axis`](#axis).[`shapeConfig`](#shapeconfig-2)

###### Call Signature

> **shapeConfig**(`_`: `Record`\<`string`, `any`\>): `this`

Defined in: [components/Axis.ts:1843](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1843)

Tick style of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `any`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`shapeConfig`](#shapeconfig-2)

<a id="tickformat-4"></a>

##### tickFormat()

###### Call Signature

> **tickFormat**(): `any`

Defined in: [components/Axis.ts:1855](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1855)

Tick formatter.

###### Returns

`any`

###### Inherited from

[`Axis`](#axis).[`tickFormat`](#tickformat)

###### Call Signature

> **tickFormat**(`_`: `any`): `this`

Defined in: [components/Axis.ts:1857](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1857)

Tick formatter.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`tickFormat`](#tickformat)

<a id="ticks-4"></a>

##### ticks()

###### Call Signature

> **ticks**(): `unknown`[] \| `undefined`

Defined in: [components/Axis.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1866)

Tick values of the axis.

###### Returns

`unknown`[] \| `undefined`

###### Inherited from

[`Axis`](#axis).[`ticks`](#ticks)

###### Call Signature

> **ticks**(`_`: `unknown`[]): `this`

Defined in: [components/Axis.ts:1867](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1867)

Tick values of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`ticks`](#ticks)

<a id="ticksize-4"></a>

##### tickSize()

###### Call Signature

> **tickSize**(): `number`

Defined in: [components/Axis.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1875)

Tick size of the axis.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`tickSize`](#ticksize)

###### Call Signature

> **tickSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1876](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1876)

Tick size of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`tickSize`](#ticksize)

<a id="ticksuffix-4"></a>

##### tickSuffix()

###### Call Signature

> **tickSuffix**(): `string`

Defined in: [components/Axis.ts:1884](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1884)

The tick abbreviation behavior for linear scales. Accepts "normal" (uses formatAbbreviate) or "smallest" (uses the suffix from the smallest tick as reference for every tick).

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`tickSuffix`](#ticksuffix)

###### Call Signature

> **tickSuffix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1885](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1885)

The tick abbreviation behavior for linear scales. Accepts "normal" (uses formatAbbreviate) or "smallest" (uses the suffix from the smallest tick as reference for every tick).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`tickSuffix`](#ticksuffix)

<a id="timelocale-4"></a>

##### timeLocale()

###### Call Signature

> **timeLocale**(): `Record`\<`string`, `unknown`\> \| `undefined`

Defined in: [components/Axis.ts:1895](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1895)

Defines a custom locale object to be used in time scale. This object must include the following properties: dateTime, date, time, periods, days, shortDays, months, shortMonths. For more information, you can revise [d3p.d3-time-format](https://github.com/d3/d3-time-format/blob/master/README.md#timeFormatLocale).

###### Returns

`Record`\<`string`, `unknown`\> \| `undefined`

###### Inherited from

[`Axis`](#axis).[`timeLocale`](#timelocale)

###### Call Signature

> **timeLocale**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1896](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1896)

Defines a custom locale object to be used in time scale. This object must include the following properties: dateTime, date, time, periods, days, shortDays, months, shortMonths. For more information, you can revise [d3p.d3-time-format](https://github.com/d3/d3-time-format/blob/master/README.md#timeFormatLocale).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`timeLocale`](#timelocale)

<a id="title-5"></a>

##### title()

###### Call Signature

> **title**(): `string` \| `undefined`

Defined in: [components/Axis.ts:1904](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1904)

Title of the axis.

###### Returns

`string` \| `undefined`

###### Inherited from

[`Axis`](#axis).[`title`](#title-1)

###### Call Signature

> **title**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1905](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1905)

Title of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`title`](#title-1)

<a id="titleconfig-5"></a>

##### titleConfig()

###### Call Signature

> **titleConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Axis.ts:1913](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1913)

Title configuration of the axis.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Axis`](#axis).[`titleConfig`](#titleconfig-1)

###### Call Signature

> **titleConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1914](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1914)

Title configuration of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`titleConfig`](#titleconfig-1)

<a id="translate-5"></a>

##### translate()

###### Call Signature

> **translate**(): (`d`: `string`, `locale?`: `string`) => `string`

Defined in: [utils/BaseClass.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L214)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Returns

(`d`: `string`, `locale?`: `string`) => `string`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Axis`](#axis).[`translate`](#translate-1)

###### Call Signature

> **translate**(`_`: (`d`: `string`, `locale?`: `string`) => `string`): `this`

Defined in: [utils/BaseClass.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L215)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `string`, `locale?`: `string`) => `string` |

###### Returns

`this`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Axis`](#axis).[`translate`](#translate-1)

<a id="width-5"></a>

##### width()

###### Call Signature

> **width**(): `number`

Defined in: [components/Axis.ts:1924](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1924)

Overall width of the axis.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`width`](#width-1)

###### Call Signature

> **width**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1925](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1925)

Overall width of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`width`](#width-1)

#### Properties

| Property | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="property-_align-4"></a> `_align` | `string` | [`Axis`](#axis).[`_align`](#property-_align) | [components/Axis.ts:206](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L206) |
| <a id="property-_availableticks-4"></a> `_availableTicks` | `unknown`[] | [`Axis`](#axis).[`_availableTicks`](#property-_availableticks) | [components/Axis.ts:271](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L271) |
| <a id="property-_barconfig-4"></a> `_barConfig` | `Record`\<`string`, `unknown`\> | [`Axis`](#axis).[`_barConfig`](#property-_barconfig) | [components/Axis.ts:207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L207) |
| <a id="property-_configdefault-5"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | [`Axis`](#axis).[`_configDefault`](#property-_configdefault-1) | [utils/BaseClass.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L69) |
| <a id="property-_d3scale-4"></a> `_d3Scale` | `any` | [`Axis`](#axis).[`_d3Scale`](#property-_d3scale) | [components/Axis.ts:266](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L266) |
| <a id="property-_d3scalenegative-4"></a> `_d3ScaleNegative` | `any` | [`Axis`](#axis).[`_d3ScaleNegative`](#property-_d3scalenegative) | [components/Axis.ts:268](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L268) |
| <a id="property-_data-5"></a> `_data` | `any`[] | [`Axis`](#axis).[`_data`](#property-_data-1) | [components/Axis.ts:209](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L209) |
| <a id="property-_domain-4"></a> `_domain` | `any`[] | [`Axis`](#axis).[`_domain`](#property-_domain) | [components/Axis.ts:211](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L211) |
| <a id="property-_duration-5"></a> `_duration` | `number` | [`Axis`](#axis).[`_duration`](#property-_duration-1) | [components/Axis.ts:212](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L212) |
| <a id="property-_grid-4"></a> `_grid` | `unknown`[] \| *required* | [`Axis`](#axis).[`_grid`](#property-_grid) | [components/Axis.ts:216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L216) |
| <a id="property-_gridconfig-4"></a> `_gridConfig` | `Record`\<`string`, `unknown`\> | [`Axis`](#axis).[`_gridConfig`](#property-_gridconfig) | [components/Axis.ts:213](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L213) |
| <a id="property-_gridlog-4"></a> `_gridLog` | `boolean` | [`Axis`](#axis).[`_gridLog`](#property-_gridlog) | [components/Axis.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L214) |
| <a id="property-_gridsize-4"></a> `_gridSize` | `number` \| *required* | [`Axis`](#axis).[`_gridSize`](#property-_gridsize) | [components/Axis.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L215) |
| <a id="property-_group-5"></a> `_group` | `Selection` | [`Axis`](#axis).[`_group`](#property-_group-1) | [components/Axis.ts:269](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L269) |
| <a id="property-_height-4"></a> `_height` | `number` | [`Axis`](#axis).[`_height`](#property-_height) | [components/Axis.ts:217](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L217) |
| <a id="property-_labeloffset-4"></a> `_labelOffset` | `boolean` | [`Axis`](#axis).[`_labelOffset`](#property-_labeloffset) | [components/Axis.ts:218](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L218) |
| <a id="property-_labelrotation-4"></a> `_labelRotation` | `boolean` \| *required* | [`Axis`](#axis).[`_labelRotation`](#property-_labelrotation) | [components/Axis.ts:219](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L219) |
| <a id="property-_labels-4"></a> `_labels` | `unknown`[] \| *required* | [`Axis`](#axis).[`_labels`](#property-_labels) | [components/Axis.ts:220](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L220) |
| <a id="property-_lastscale-4"></a> `_lastScale` | ((`d`: `unknown`) => `number`) \| *required* | [`Axis`](#axis).[`_lastScale`](#property-_lastscale) | [components/Axis.ts:270](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L270) |
| <a id="property-_locale-5"></a> `_locale` | `any` | [`Axis`](#axis).[`_locale`](#property-_locale-1) | [components/Axis.ts:223](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L223) |
| <a id="property-_margin-4"></a> `_margin` | `Record`\<`string`, `number`\> | [`Axis`](#axis).[`_margin`](#property-_margin) | [components/Axis.ts:224](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L224) |
| <a id="property-_maxsize-4"></a> `_maxSize` | `number` | [`Axis`](#axis).[`_maxSize`](#property-_maxsize) | [components/Axis.ts:225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L225) |
| <a id="property-_minsize-4"></a> `_minSize` | `number` | [`Axis`](#axis).[`_minSize`](#property-_minsize) | [components/Axis.ts:226](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L226) |
| <a id="property-_on-5"></a> `_on` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | [`Axis`](#axis).[`_on`](#property-_on-1) | [utils/BaseClass.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L65) |
| <a id="property-_orient-4"></a> `_orient` | `string` | [`Axis`](#axis).[`_orient`](#property-_orient) | [components/Axis.ts:227](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L227) |
| <a id="property-_outerbounds-4"></a> `_outerBounds` | `Record`\<`string`, `number`\> | [`Axis`](#axis).[`_outerBounds`](#property-_outerbounds) | [components/Axis.ts:228](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L228) |
| <a id="property-_padding-4"></a> `_padding` | `number` | [`Axis`](#axis).[`_padding`](#property-_padding) | [components/Axis.ts:229](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L229) |
| <a id="property-_paddinginner-4"></a> `_paddingInner` | `number` | [`Axis`](#axis).[`_paddingInner`](#property-_paddinginner) | [components/Axis.ts:230](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L230) |
| <a id="property-_paddingouter-4"></a> `_paddingOuter` | `number` | [`Axis`](#axis).[`_paddingOuter`](#property-_paddingouter) | [components/Axis.ts:231](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L231) |
| <a id="property-_parent-5"></a> `_parent` | `Record`\<`string`, `unknown`\> | [`Axis`](#axis).[`_parent`](#property-_parent-1) | [utils/BaseClass.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L66) |
| <a id="property-_position-4"></a> `_position` | `object` | [`Axis`](#axis).[`_position`](#property-_position) | [components/Axis.ts:232](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L232) |
| `_position.height` | `string` | - | [components/Axis.ts:235](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L235) |
| `_position.horizontal` | `boolean` | - | [components/Axis.ts:233](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L233) |
| `_position.opposite` | `string` | - | [components/Axis.ts:238](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L238) |
| `_position.width` | `string` | - | [components/Axis.ts:234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L234) |
| `_position.x` | `string` | - | [components/Axis.ts:236](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L236) |
| `_position.y` | `string` | - | [components/Axis.ts:237](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L237) |
| <a id="property-_range-4"></a> `_range` | (`number` \| `undefined`)[] \| *required* | [`Axis`](#axis).[`_range`](#property-_range) | [components/Axis.ts:240](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L240) |
| <a id="property-_rounding-4"></a> `_rounding` | `string` | [`Axis`](#axis).[`_rounding`](#property-_rounding) | [components/Axis.ts:241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L241) |
| <a id="property-_roundinginsidemaxprefix-4"></a> `_roundingInsideMaxPrefix` | `string` | [`Axis`](#axis).[`_roundingInsideMaxPrefix`](#property-_roundinginsidemaxprefix) | [components/Axis.ts:244](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L244) |
| <a id="property-_roundinginsidemaxsuffix-4"></a> `_roundingInsideMaxSuffix` | `string` | [`Axis`](#axis).[`_roundingInsideMaxSuffix`](#property-_roundinginsidemaxsuffix) | [components/Axis.ts:245](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L245) |
| <a id="property-_roundinginsideminprefix-4"></a> `_roundingInsideMinPrefix` | `string` | [`Axis`](#axis).[`_roundingInsideMinPrefix`](#property-_roundinginsideminprefix) | [components/Axis.ts:242](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L242) |
| <a id="property-_roundinginsideminsuffix-4"></a> `_roundingInsideMinSuffix` | `string` | [`Axis`](#axis).[`_roundingInsideMinSuffix`](#property-_roundinginsideminsuffix) | [components/Axis.ts:243](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L243) |
| <a id="property-_scale-5"></a> `_scale` | `string` | [`Axis`](#axis).[`_scale`](#property-_scale-1) | [components/Axis.ts:246](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L246) |
| <a id="property-_scalepadding-4"></a> `_scalePadding` | `number` | [`Axis`](#axis).[`_scalePadding`](#property-_scalepadding) | [components/Axis.ts:247](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L247) |
| <a id="property-_select-5"></a> `_select` | `Selection` | [`Axis`](#axis).[`_select`](#property-_select-1) | [components/Axis.ts:205](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L205) |
| <a id="property-_shape-4"></a> `_shape` | `string` | [`Axis`](#axis).[`_shape`](#property-_shape) | [components/Axis.ts:248](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L248) |
| <a id="property-_shapeconfig-5"></a> `_shapeConfig` | `Record`\<`string`, `any`\> | [`Axis`](#axis).[`_shapeConfig`](#property-_shapeconfig-1) | [components/Axis.ts:251](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L251) |
| <a id="property-_tickformat-4"></a> `_tickFormat` | `any` | [`Axis`](#axis).[`_tickFormat`](#property-_tickformat) | [components/Axis.ts:253](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L253) |
| <a id="property-_ticks-4"></a> `_ticks` | `unknown`[] \| *required* | [`Axis`](#axis).[`_ticks`](#property-_ticks) | [components/Axis.ts:254](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L254) |
| <a id="property-_ticksize-4"></a> `_tickSize` | `number` | [`Axis`](#axis).[`_tickSize`](#property-_ticksize) | [components/Axis.ts:255](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L255) |
| <a id="property-_ticksuffix-4"></a> `_tickSuffix` | `string` | [`Axis`](#axis).[`_tickSuffix`](#property-_ticksuffix) | [components/Axis.ts:256](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L256) |
| <a id="property-_tickunit-4"></a> `_tickUnit` | `number` | [`Axis`](#axis).[`_tickUnit`](#property-_tickunit) | [components/Axis.ts:257](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L257) |
| <a id="property-_timelocale-4"></a> `_timeLocale` | `Record`\<`string`, `unknown`\> \| *required* | [`Axis`](#axis).[`_timeLocale`](#property-_timelocale) | [components/Axis.ts:258](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L258) |
| <a id="property-_title-4"></a> `_title` | `string` \| *required* | [`Axis`](#axis).[`_title`](#property-_title) | [components/Axis.ts:259](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L259) |
| <a id="property-_titleclass-4"></a> `_titleClass` | [`TextBox`](#textbox) | [`Axis`](#axis).[`_titleClass`](#property-_titleclass) | [components/Axis.ts:260](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L260) |
| <a id="property-_titleconfig-4"></a> `_titleConfig` | `Record`\<`string`, `any`\> | [`Axis`](#axis).[`_titleConfig`](#property-_titleconfig) | [components/Axis.ts:262](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L262) |
| <a id="property-_transition-5"></a> `_transition` | `Transition`\<`BaseType`\> | [`Axis`](#axis).[`_transition`](#property-_transition-1) | [components/Axis.ts:273](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L273) |
| <a id="property-_translate-5"></a> `_translate` | (`d`: `string`, `locale?`: `string`) => `string` | [`Axis`](#axis).[`_translate`](#property-_translate-1) | [utils/BaseClass.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L67) |
| <a id="property-_userformat-4"></a> `_userFormat` | `false` \| ((`d`: `unknown`) => `string`) \| *required* | [`Axis`](#axis).[`_userFormat`](#property-_userformat) | [components/Axis.ts:274](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L274) |
| <a id="property-_uuid-5"></a> `_uuid` | `string` | [`Axis`](#axis).[`_uuid`](#property-_uuid-1) | [utils/BaseClass.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L68) |
| <a id="property-_visibleticks-4"></a> `_visibleTicks` | `unknown`[] | [`Axis`](#axis).[`_visibleTicks`](#property-_visibleticks) | [components/Axis.ts:272](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L272) |
| <a id="property-_width-4"></a> `_width` | `number` | [`Axis`](#axis).[`_width`](#property-_width) | [components/Axis.ts:263](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L263) |

***

<a id="bar"></a>

### Bar

Defined in: [shapes/Bar.ts:11](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L11)

Creates SVG areas based on an array of data.

#### Extends

- [`Shape`](#shape-23)

#### Methods

<a id="_datafilter"></a>

##### \_dataFilter()?

> `optional` **\_dataFilter**(`data`: `DataPoint`[]): `DataPoint`[]

Defined in: [shapes/Shape.ts:105](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L105)

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `data` | `DataPoint`[] | The raw data array to filter. |

###### Returns

`DataPoint`[]

###### Inherited from

[`Shape`](#shape-23).[`_dataFilter`](#_datafilter-4)

<a id="active-2"></a>

##### active()

###### Call Signature

> **active**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

Defined in: [shapes/Shape.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1019)

The active callback function for highlighting shapes.

###### Returns

((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

###### Inherited from

[`Shape`](#shape-23).[`active`](#active-25)

###### Call Signature

> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1020](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1020)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`active`](#active-25)

<a id="activeopacity-1"></a>

##### activeOpacity()

###### Call Signature

> **activeOpacity**(): `number`

Defined in: [shapes/Shape.ts:1037](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1037)

When shapes are active, this is the opacity of any shape that is not active.

###### Returns

`number`

###### Inherited from

[`Shape`](#shape-23).[`activeOpacity`](#activeopacity-6)

###### Call Signature

> **activeOpacity**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1038](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1038)

When shapes are active, this is the opacity of any shape that is not active.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`activeOpacity`](#activeopacity-6)

<a id="activestyle-1"></a>

##### activeStyle()

###### Call Signature

> **activeStyle**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1048](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1048)

The style to apply to active shapes.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`activeStyle`](#activestyle-6)

###### Call Signature

> **activeStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1049](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1049)

The style to apply to active shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`activeStyle`](#activestyle-6)

<a id="arialabel-1"></a>

##### ariaLabel()

###### Call Signature

> **ariaLabel**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1059](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1059)

The aria-label attribute for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`ariaLabel`](#arialabel-6)

###### Call Signature

> **ariaLabel**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1060](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1060)

The aria-label attribute for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`ariaLabel`](#arialabel-6)

<a id="backgroundimage-1"></a>

##### backgroundImage()

###### Call Signature

> **backgroundImage**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1070](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1070)

The background-image accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`backgroundImage`](#backgroundimage-6)

###### Call Signature

> **backgroundImage**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1071](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1071)

The background-image accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`backgroundImage`](#backgroundimage-6)

<a id="config-6"></a>

##### config()

###### Call Signature

> **config**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L91)

Methods that correspond to the key/value pairs and returns this class.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`Shape`](#shape-23).[`config`](#config-15)

###### Call Signature

> **config**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L92)

Methods that correspond to the key/value pairs and returns this class.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`config`](#config-15)

<a id="data-7"></a>

##### data()

###### Call Signature

> **data**(): `DataPoint`[]

Defined in: [shapes/Shape.ts:1082](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1082)

The data array used to create shapes. A shape will be drawn for each object in the array.

###### Returns

`DataPoint`[]

###### Inherited from

[`Shape`](#shape-23).[`data`](#data-32)

###### Call Signature

> **data**(`_`: `DataPoint`[]): `this`

Defined in: [shapes/Shape.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1083)

The data array used to create shapes. A shape will be drawn for each object in the array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `DataPoint`[] |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`data`](#data-32)

<a id="discrete-2"></a>

##### discrete()

###### Call Signature

> **discrete**(): `string` \| `undefined`

Defined in: [shapes/Shape.ts:1091](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1091)

Determines if either the X or Y position is discrete along a Line, which helps in determining the nearest data point on a line for a hit area event.

###### Returns

`string` \| `undefined`

###### Inherited from

[`Shape`](#shape-23).[`discrete`](#discrete-23)

###### Call Signature

> **discrete**(`_`: `string`): `this`

Defined in: [shapes/Shape.ts:1092](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1092)

Determines if either the X or Y position is discrete along a Line, which helps in determining the nearest data point on a line for a hit area event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`discrete`](#discrete-23)

<a id="duration-7"></a>

##### duration()

###### Call Signature

> **duration**(): `number`

Defined in: [shapes/Shape.ts:1100](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1100)

The animation duration in milliseconds.

###### Returns

`number`

###### Inherited from

[`Shape`](#shape-23).[`duration`](#duration-31)

###### Call Signature

> **duration**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1101](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1101)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`duration`](#duration-31)

<a id="fill-1"></a>

##### fill()

###### Call Signature

> **fill**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1109](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1109)

The fill color accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`fill`](#fill-6)

###### Call Signature

> **fill**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1110](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1110)

The fill color accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`fill`](#fill-6)

<a id="fillopacity-1"></a>

##### fillOpacity()

###### Call Signature

> **fillOpacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1120](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1120)

Defines the "fill-opacity" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`fillOpacity`](#fillopacity-6)

###### Call Signature

> **fillOpacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1121](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1121)

Defines the "fill-opacity" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`fillOpacity`](#fillopacity-6)

<a id="height-6"></a>

##### height()

###### Call Signature

> **height**(): `AccessorFn`

Defined in: [shapes/Bar.ts:194](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L194)

The height accessor for each bar.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.height;
}
```

###### Call Signature

> **height**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Bar.ts:195](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L195)

The height accessor for each bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.height;
}
```

<a id="hitarea-1"></a>

##### hitArea()

###### Call Signature

> **hitArea**(): ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) \| `null`

Defined in: [shapes/Shape.ts:1180](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1180)

The mouse hit area accessor function.

###### Returns

((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) \| `null`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`hitArea`](#hitarea-6)

###### Call Signature

> **hitArea**(`_`: `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>)): `this`

Defined in: [shapes/Shape.ts:1187](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1187)

The mouse hit area accessor function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) |

###### Returns

`this`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`hitArea`](#hitarea-6)

<a id="hover-2"></a>

##### hover()

###### Call Signature

> **hover**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

Defined in: [shapes/Shape.ts:1131](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1131)

The hover callback function for highlighting shapes on mouseover.

###### Returns

((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

###### Inherited from

[`Shape`](#shape-23).[`hover`](#hover-25)

###### Call Signature

> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1132](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1132)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`hover`](#hover-25)

<a id="hoveropacity-1"></a>

##### hoverOpacity()

###### Call Signature

> **hoverOpacity**(): `number`

Defined in: [shapes/Shape.ts:1160](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1160)

The opacity of non-hovered shapes when any shape is hovered.

###### Returns

`number`

###### Inherited from

[`Shape`](#shape-23).[`hoverOpacity`](#hoveropacity-6)

###### Call Signature

> **hoverOpacity**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1161](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1161)

The opacity of non-hovered shapes when any shape is hovered.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`hoverOpacity`](#hoveropacity-6)

<a id="hoverstyle-1"></a>

##### hoverStyle()

###### Call Signature

> **hoverStyle**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1149](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1149)

The style to apply to hovered shapes.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`hoverStyle`](#hoverstyle-6)

###### Call Signature

> **hoverStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1150)

The style to apply to hovered shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`hoverStyle`](#hoverstyle-6)

<a id="id-1"></a>

##### id()

###### Call Signature

> **id**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1220](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1220)

The unique id accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`id`](#id-8)

###### Call Signature

> **id**(`_`: `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1221](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1221)

The unique id accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`id`](#id-8)

<a id="label-2"></a>

##### label()

###### Call Signature

> **label**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1229](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1229)

The text label accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`label`](#label-24)

###### Call Signature

> **label**(`_`: `string` \| `string`[] \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1230](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1230)

The text label accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `string`[] \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`label`](#label-24)

<a id="labelbounds-1"></a>

##### labelBounds()

###### Call Signature

> **labelBounds**(): ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null`

Defined in: [shapes/Shape.ts:1251](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1251)

The label bounds accessor function.

###### Returns

((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`labelBounds`](#labelbounds-6)

###### Call Signature

> **labelBounds**(`_`: `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`)): `this`

Defined in: [shapes/Shape.ts:1258](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1258)

The label bounds accessor function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) |

###### Returns

`this`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`labelBounds`](#labelbounds-6)

<a id="labelconfig-1"></a>

##### labelConfig()

###### Call Signature

> **labelConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1291](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1291)

A pass-through to the config method of the TextBox class used to create a shape's labels.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`labelConfig`](#labelconfig-7)

###### Call Signature

> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1292](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1292)

A pass-through to the config method of the TextBox class used to create a shape's labels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`labelConfig`](#labelconfig-7)

<a id="locale-6"></a>

##### locale()

###### Call Signature

> **locale**(): `string`

Defined in: [utils/BaseClass.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L156)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Returns

`string`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Shape`](#shape-23).[`locale`](#locale-15)

###### Call Signature

> **locale**(`_`: `string` \| `object`): `this`

Defined in: [utils/BaseClass.ts:157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L157)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `object` |

###### Returns

`this`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Shape`](#shape-23).[`locale`](#locale-15)

<a id="on-6"></a>

##### on()

###### Call Signature

> **on**(): `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

Defined in: [utils/BaseClass.ts:176](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L176)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Returns

`Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

###### Call Signature

> **on**(`_`: `string`): ((...`args`: `unknown`[]) => `unknown`) \| `undefined`

Defined in: [utils/BaseClass.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L177)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

((...`args`: `unknown`[]) => `unknown`) \| `undefined`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

###### Call Signature

> **on**(`_`: `string`, `f`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [utils/BaseClass.ts:178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L178)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |
| `f` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

###### Call Signature

> **on**(`_`: `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:179](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L179)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

<a id="opacity-1"></a>

##### opacity()

###### Call Signature

> **opacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1302](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1302)

The opacity accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`opacity`](#opacity-7)

###### Call Signature

> **opacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1303](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1303)

The opacity accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`opacity`](#opacity-7)

<a id="parent-6"></a>

##### parent()

###### Call Signature

> **parent**(): `Record`\<`string`, `unknown`\>

Defined in: [utils/BaseClass.ts:200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L200)

Parent config used by the wrapper.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`parent`](#parent-15)

###### Call Signature

> **parent**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L201)

Parent config used by the wrapper.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`parent`](#parent-15)

<a id="pointerevents-1"></a>

##### pointerEvents()

###### Call Signature

> **pointerEvents**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1313](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1313)

The pointer-events CSS property for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`pointerEvents`](#pointerevents-7)

###### Call Signature

> **pointerEvents**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1314](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1314)

The pointer-events CSS property for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`pointerEvents`](#pointerevents-7)

<a id="render-7"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [shapes/Bar.ts:61](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L61)

Draws the bars.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Overrides

[`Shape`](#shape-23).[`render`](#render-32)

<a id="role-1"></a>

##### role()

###### Call Signature

> **role**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1325](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1325)

The role attribute.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`role`](#role-6)

###### Call Signature

> **role**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1326](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1326)

The role attribute.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`role`](#role-6)

<a id="rotate-1"></a>

##### rotate()

###### Call Signature

> **rotate**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1336](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1336)

The rotation angle in degrees for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`rotate`](#rotate-6)

###### Call Signature

> **rotate**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1337](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1337)

The rotation angle in degrees for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`rotate`](#rotate-6)

<a id="rx-1"></a>

##### rx()

###### Call Signature

> **rx**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1347](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1347)

Defines the "rx" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`rx`](#rx-6)

###### Call Signature

> **rx**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1348](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1348)

Defines the "rx" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`rx`](#rx-6)

<a id="ry-1"></a>

##### ry()

###### Call Signature

> **ry**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1358](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1358)

Defines the "rx" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`ry`](#ry-6)

###### Call Signature

> **ry**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1359](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1359)

Defines the "rx" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`ry`](#ry-6)

<a id="scale-6"></a>

##### scale()

###### Call Signature

> **scale**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1369](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1369)

The scale transform accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`scale`](#scale-12)

###### Call Signature

> **scale**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1370](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1370)

The scale transform accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`scale`](#scale-12)

<a id="select-7"></a>

##### select()

###### Call Signature

> **select**(): `Selection`

Defined in: [shapes/Shape.ts:1380](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1380)

The SVG container element as a d3 selector or DOM element.

###### Returns

`Selection`

###### Inherited from

[`Shape`](#shape-23).[`select`](#select-32)

###### Call Signature

> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`

Defined in: [shapes/Shape.ts:1381](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1381)

The SVG container element as a d3 selector or DOM element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `HTMLElement` \| `SVGElement` \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`select`](#select-32)

<a id="shapeconfig-7"></a>

##### shapeConfig()

###### Call Signature

> **shapeConfig**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L225)

Configuration object with key/value pairs applied as method calls on each shape.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`Shape`](#shape-23).[`shapeConfig`](#shapeconfig-33)

###### Call Signature

> **shapeConfig**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:226](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L226)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`shapeConfig`](#shapeconfig-33)

<a id="shaperendering-1"></a>

##### shapeRendering()

###### Call Signature

> **shapeRendering**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1396](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1396)

The shape-rendering.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`shapeRendering`](#shaperendering-6)

###### Call Signature

> **shapeRendering**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1397)

The shape-rendering.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`shapeRendering`](#shaperendering-6)

<a id="sort-1"></a>

##### sort()

###### Call Signature

> **sort**(): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`

Defined in: [shapes/Shape.ts:1408](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1408)

A comparator function used to sort shapes for layering order.

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`

###### Inherited from

[`Shape`](#shape-23).[`sort`](#sort-9)

###### Call Signature

> **sort**(`_`: ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1409](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1409)

A comparator function used to sort shapes for layering order.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`sort`](#sort-9)

<a id="stroke-1"></a>

##### stroke()

###### Call Signature

> **stroke**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1419](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1419)

The stroke color accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`stroke`](#stroke-6)

###### Call Signature

> **stroke**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1420](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1420)

The stroke color accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`stroke`](#stroke-6)

<a id="strokedasharray-1"></a>

##### strokeDasharray()

###### Call Signature

> **strokeDasharray**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1430](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1430)

Defines the "stroke-dasharray" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeDasharray`](#strokedasharray-6)

###### Call Signature

> **strokeDasharray**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1431](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1431)

Defines the "stroke-dasharray" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeDasharray`](#strokedasharray-6)

<a id="strokelinecap-1"></a>

##### strokeLinecap()

###### Call Signature

> **strokeLinecap**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1442](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1442)

Defines the "stroke-linecap" attribute for the shapes. Accepted values are `"butt"`, `"round"`, and `"square"`.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeLinecap`](#strokelinecap-6)

###### Call Signature

> **strokeLinecap**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1443](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1443)

Defines the "stroke-linecap" attribute for the shapes. Accepted values are `"butt"`, `"round"`, and `"square"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeLinecap`](#strokelinecap-6)

<a id="strokeopacity-1"></a>

##### strokeOpacity()

###### Call Signature

> **strokeOpacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1454](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1454)

Defines the "stroke-opacity" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeOpacity`](#strokeopacity-6)

###### Call Signature

> **strokeOpacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1455](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1455)

Defines the "stroke-opacity" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeOpacity`](#strokeopacity-6)

<a id="strokewidth-1"></a>

##### strokeWidth()

###### Call Signature

> **strokeWidth**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1466](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1466)

The stroke-width.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeWidth`](#strokewidth-6)

###### Call Signature

> **strokeWidth**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1467](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1467)

The stroke-width.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeWidth`](#strokewidth-6)

<a id="textanchor-1"></a>

##### textAnchor()

###### Call Signature

> **textAnchor**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1477](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1477)

The text-anchor.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`textAnchor`](#textanchor-6)

###### Call Signature

> **textAnchor**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1478](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1478)

The text-anchor.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`textAnchor`](#textanchor-6)

<a id="texture-1"></a>

##### texture()

###### Call Signature

> **texture**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1488](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1488)

Defines the texture used inside of each shape. This uses the [textures.js](https://riccardoscalco.it/textures/) package, and expects either a simple string (`"lines"` or `"circles"`) or a more complex Object containing the various properties of the texture (ie. `{texture: "lines", orientation: "3/8", stroke: "darkorange"}`). If multiple textures are necessary, provide an accsesor Function that returns the correct String/Object for each given data point and index.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`texture`](#texture-6)

###### Call Signature

> **texture**(`_`: `string` \| `Record`\<`string`, `unknown`\> \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1489](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1489)

Defines the texture used inside of each shape. This uses the [textures.js](https://riccardoscalco.it/textures/) package, and expects either a simple string (`"lines"` or `"circles"`) or a more complex Object containing the various properties of the texture (ie. `{texture: "lines", orientation: "3/8", stroke: "darkorange"}`). If multiple textures are necessary, provide an accsesor Function that returns the correct String/Object for each given data point and index.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `Record`\<`string`, `unknown`\> \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`texture`](#texture-6)

<a id="texturedefault-1"></a>

##### textureDefault()

###### Call Signature

> **textureDefault**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1503)

A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`textureDefault`](#texturedefault-6)

###### Call Signature

> **textureDefault**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1504](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1504)

A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`textureDefault`](#texturedefault-6)

<a id="translate-6"></a>

##### translate()

###### Call Signature

> **translate**(): (`d`: `string`, `locale?`: `string`) => `string`

Defined in: [utils/BaseClass.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L214)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Returns

(`d`: `string`, `locale?`: `string`) => `string`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Shape`](#shape-23).[`translate`](#translate-15)

###### Call Signature

> **translate**(`_`: (`d`: `string`, `locale?`: `string`) => `string`): `this`

Defined in: [utils/BaseClass.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L215)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `string`, `locale?`: `string`) => `string` |

###### Returns

`this`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Shape`](#shape-23).[`translate`](#translate-15)

<a id="vectoreffect-1"></a>

##### vectorEffect()

###### Call Signature

> **vectorEffect**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1514](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1514)

The vector-effect.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`vectorEffect`](#vectoreffect-6)

###### Call Signature

> **vectorEffect**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1515](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1515)

The vector-effect.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`vectorEffect`](#vectoreffect-6)

<a id="verticalalign-1"></a>

##### verticalAlign()

###### Call Signature

> **verticalAlign**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1525](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1525)

The vertical alignment.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`verticalAlign`](#verticalalign-7)

###### Call Signature

> **verticalAlign**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1526](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1526)

The vertical alignment.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`verticalAlign`](#verticalalign-7)

<a id="width-6"></a>

##### width()

###### Call Signature

> **width**(): `AccessorFn`

Defined in: [shapes/Bar.ts:210](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L210)

The width accessor for each bar.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.width;
}
```

###### Call Signature

> **width**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Bar.ts:211](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L211)

The width accessor for each bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.width;
}
```

<a id="x-2"></a>

##### x()

###### Call Signature

> **x**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1542](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1542)

The x position accessor for each shape.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`x`](#x-15)

###### Call Signature

> **x**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1543)

The x position accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`x`](#x-15)

<a id="x0-1"></a>

##### x0()

###### Call Signature

> **x0**(): `AccessorFn`

Defined in: [shapes/Bar.ts:221](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L221)

The x0 (left edge) position accessor for each bar.

###### Returns

`AccessorFn`

###### Call Signature

> **x0**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Bar.ts:222](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L222)

The x0 (left edge) position accessor for each bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

<a id="x1-1"></a>

##### x1()

###### Call Signature

> **x1**(): `AccessorFn` \| `null`

Defined in: [shapes/Bar.ts:234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L234)

The x1 (right edge) position accessor for each bar.

###### Returns

`AccessorFn` \| `null`

###### Call Signature

> **x1**(`_`: `number` \| `AccessorFn` \| `null`): `this`

Defined in: [shapes/Bar.ts:235](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L235)

The x1 (right edge) position accessor for each bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` \| `null` |

###### Returns

`this`

<a id="y-2"></a>

##### y()

###### Call Signature

> **y**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1558](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1558)

The y position accessor for each shape.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.y;
}
```

###### Inherited from

[`Shape`](#shape-23).[`y`](#y-15)

###### Call Signature

> **y**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1559](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1559)

The y position accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.y;
}
```

###### Inherited from

[`Shape`](#shape-23).[`y`](#y-15)

<a id="y0-1"></a>

##### y0()

###### Call Signature

> **y0**(): `AccessorFn`

Defined in: [shapes/Bar.ts:251](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L251)

The y0 (top edge) position accessor for each bar.

###### Returns

`AccessorFn`

###### Call Signature

> **y0**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Bar.ts:252](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L252)

The y0 (top edge) position accessor for each bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

<a id="y1-1"></a>

##### y1()

###### Call Signature

> **y1**(): `AccessorFn` \| `null`

Defined in: [shapes/Bar.ts:264](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L264)

The y1 (bottom edge) position accessor for each bar.

###### Returns

`AccessorFn` \| `null`

###### Call Signature

> **y1**(`_`: `number` \| `AccessorFn` \| `null`): `this`

Defined in: [shapes/Bar.ts:265](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L265)

The y1 (bottom edge) position accessor for each bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` \| `null` |

###### Returns

`this`

#### Properties

| Property | Type | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="property-_active-1"></a> `_active` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | - | [`Shape`](#shape-23).[`_active`](#property-_active-6) | [shapes/Shape.ts:116](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L116) |
| <a id="property-_activegroup-1"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-23).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:112](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L112) |
| <a id="property-_activeopacity-1"></a> `_activeOpacity` | `number` | - | [`Shape`](#shape-23).[`_activeOpacity`](#property-_activeopacity-6) | [shapes/Shape.ts:57](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L57) |
| <a id="property-_activestyle-1"></a> `_activeStyle` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_activeStyle`](#property-_activestyle-6) | [shapes/Shape.ts:58](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L58) |
| <a id="property-_arialabel-1"></a> `_ariaLabel` | `AccessorFn` | - | [`Shape`](#shape-23).[`_ariaLabel`](#property-_arialabel-6) | [shapes/Shape.ts:59](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L59) |
| <a id="property-_backgroundimage-1"></a> `_backgroundImage` | `AccessorFn` | - | [`Shape`](#shape-23).[`_backgroundImage`](#property-_backgroundimage-6) | [shapes/Shape.ts:60](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L60) |
| <a id="property-_backgroundimageclass-1"></a> `_backgroundImageClass` | [`Image`](#image) | - | [`Shape`](#shape-23).[`_backgroundImageClass`](#property-_backgroundimageclass-6) | [shapes/Shape.ts:61](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L61) |
| <a id="property-_configdefault-6"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | - | [`Shape`](#shape-23).[`_configDefault`](#property-_configdefault-15) | [utils/BaseClass.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L69) |
| <a id="property-_curve-1"></a> `_curve` | `AccessorFn` | - | [`Shape`](#shape-23).[`_curve`](#property-_curve-6) | [shapes/Shape.ts:121](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L121) |
| <a id="property-_data-6"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-23).[`_data`](#property-_data-15) | [shapes/Shape.ts:62](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L62) |
| <a id="property-_defined-1"></a> `_defined` | `AccessorFn` | - | [`Shape`](#shape-23).[`_defined`](#property-_defined-6) | [shapes/Shape.ts:120](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L120) |
| <a id="property-_discrete-1"></a> `_discrete` | `string` \| *required* | - | [`Shape`](#shape-23).[`_discrete`](#property-_discrete-6) | [shapes/Shape.ts:118](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L118) |
| <a id="property-_duration-6"></a> `_duration` | `number` | - | [`Shape`](#shape-23).[`_duration`](#property-_duration-15) | [shapes/Shape.ts:63](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L63) |
| <a id="property-_enter-1"></a> `_enter` | `Selection` | - | [`Shape`](#shape-23).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:109](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L109) |
| <a id="property-_exit-1"></a> `_exit` | `Selection` | - | [`Shape`](#shape-23).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:110](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L110) |
| <a id="property-_fill-1"></a> `_fill` | `AccessorFn` | - | [`Shape`](#shape-23).[`_fill`](#property-_fill-6) | [shapes/Shape.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L64) |
| <a id="property-_fillopacity-1"></a> `_fillOpacity` | `AccessorFn` | - | [`Shape`](#shape-23).[`_fillOpacity`](#property-_fillopacity-6) | [shapes/Shape.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L65) |
| <a id="property-_group-6"></a> `_group` | `Selection` | - | [`Shape`](#shape-23).[`_group`](#property-_group-13) | [shapes/Shape.ts:107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L107) |
| <a id="property-_height-5"></a> `_height` | `AccessorFn` | - | - | [shapes/Bar.ts:12](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L12) |
| <a id="property-_hitarea-1"></a> `_hitArea` | ((`d`: `DataPoint`, `i`: `number`, `aes`: `ShapeAes`) => `Record`\<`string`, `unknown`\>) \| `null` | - | [`Shape`](#shape-23).[`_hitArea`](#property-_hitarea-6) | [shapes/Shape.ts:113](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L113) |
| <a id="property-_hover-1"></a> `_hover` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | - | [`Shape`](#shape-23).[`_hover`](#property-_hover-6) | [shapes/Shape.ts:117](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L117) |
| <a id="property-_hovergroup-1"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-23).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:111](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L111) |
| <a id="property-_hoveropacity-1"></a> `_hoverOpacity` | `number` | - | [`Shape`](#shape-23).[`_hoverOpacity`](#property-_hoveropacity-6) | [shapes/Shape.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L66) |
| <a id="property-_hoverstyle-1"></a> `_hoverStyle` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_hoverStyle`](#property-_hoverstyle-6) | [shapes/Shape.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L67) |
| <a id="property-_id-1"></a> `_id` | `AccessorFn` | - | [`Shape`](#shape-23).[`_id`](#property-_id-8) | [shapes/Shape.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L68) |
| <a id="property-_label-1"></a> `_label` | `AccessorFn` | - | [`Shape`](#shape-23).[`_label`](#property-_label-7) | [shapes/Shape.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L69) |
| <a id="property-_labelbounds-1"></a> `_labelBounds` | ((`d`: `DataPoint`, `i`: `number`, `aes`: `ShapeAes`) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null` | [`Shape`](#shape-23).[`_labelBounds`](#property-_labelbounds-6) | - | [shapes/Bar.ts:13](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L13) |
| <a id="property-_labelclass-1"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-23).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L70) |
| <a id="property-_labelconfig-1"></a> `_labelConfig` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_labelConfig`](#property-_labelconfig-7) | [shapes/Shape.ts:71](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L71) |
| <a id="property-_locale-6"></a> `_locale` | `string` | - | [`Shape`](#shape-23).[`_locale`](#property-_locale-15) | [utils/BaseClass.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L64) |
| <a id="property-_name-1"></a> `_name` | `string` | [`Shape`](#shape-23).[`_name`](#property-_name-6) | - | [shapes/Bar.ts:20](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L20) |
| <a id="property-_on-6"></a> `_on` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | - | [`Shape`](#shape-23).[`_on`](#property-_on-15) | [utils/BaseClass.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L65) |
| <a id="property-_opacity-1"></a> `_opacity` | `AccessorFn` | - | [`Shape`](#shape-23).[`_opacity`](#property-_opacity-7) | [shapes/Shape.ts:80](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L80) |
| <a id="property-_parent-6"></a> `_parent` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_parent`](#property-_parent-15) | [utils/BaseClass.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L66) |
| <a id="property-_path-1"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_path`](#property-_path-6) | [shapes/Shape.ts:119](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L119) |
| <a id="property-_pointerevents-1"></a> `_pointerEvents` | `AccessorFn` | - | [`Shape`](#shape-23).[`_pointerEvents`](#property-_pointerevents-7) | [shapes/Shape.ts:81](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L81) |
| <a id="property-_role-1"></a> `_role` | `AccessorFn` | - | [`Shape`](#shape-23).[`_role`](#property-_role-6) | [shapes/Shape.ts:82](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L82) |
| <a id="property-_rotate-1"></a> `_rotate` | `AccessorFn` | - | [`Shape`](#shape-23).[`_rotate`](#property-_rotate-6) | [shapes/Shape.ts:83](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L83) |
| <a id="property-_rx-1"></a> `_rx` | `AccessorFn` | - | [`Shape`](#shape-23).[`_rx`](#property-_rx-6) | [shapes/Shape.ts:84](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L84) |
| <a id="property-_ry-1"></a> `_ry` | `AccessorFn` | - | [`Shape`](#shape-23).[`_ry`](#property-_ry-6) | [shapes/Shape.ts:85](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L85) |
| <a id="property-_scale-6"></a> `_scale` | `AccessorFn` | - | [`Shape`](#shape-23).[`_scale`](#property-_scale-12) | [shapes/Shape.ts:86](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L86) |
| <a id="property-_select-6"></a> `_select` | `Selection` | - | [`Shape`](#shape-23).[`_select`](#property-_select-15) | [shapes/Shape.ts:102](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L102) |
| <a id="property-_shapeconfig-6"></a> `_shapeConfig?` | [`D3plusConfig`](#d3plusconfig) | - | [`Shape`](#shape-23).[`_shapeConfig`](#property-_shapeconfig-15) | [utils/BaseClass.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L70) |
| <a id="property-_shaperendering-1"></a> `_shapeRendering` | `AccessorFn` | - | [`Shape`](#shape-23).[`_shapeRendering`](#property-_shaperendering-6) | [shapes/Shape.ts:87](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L87) |
| <a id="property-_sort-1"></a> `_sort` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | - | [`Shape`](#shape-23).[`_sort`](#property-_sort-6) | [shapes/Shape.ts:106](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L106) |
| <a id="property-_stroke-1"></a> `_stroke` | `AccessorFn` | - | [`Shape`](#shape-23).[`_stroke`](#property-_stroke-6) | [shapes/Shape.ts:88](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L88) |
| <a id="property-_strokedasharray-1"></a> `_strokeDasharray` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeDasharray`](#property-_strokedasharray-6) | [shapes/Shape.ts:89](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L89) |
| <a id="property-_strokelinecap-1"></a> `_strokeLinecap` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeLinecap`](#property-_strokelinecap-6) | [shapes/Shape.ts:90](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L90) |
| <a id="property-_strokeopacity-1"></a> `_strokeOpacity` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeOpacity`](#property-_strokeopacity-6) | [shapes/Shape.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L91) |
| <a id="property-_strokewidth-1"></a> `_strokeWidth` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeWidth`](#property-_strokewidth-6) | [shapes/Shape.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L92) |
| <a id="property-_tagname-1"></a> `_tagName` | `string` | - | [`Shape`](#shape-23).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:93](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L93) |
| <a id="property-_textanchor-1"></a> `_textAnchor` | `AccessorFn` | - | [`Shape`](#shape-23).[`_textAnchor`](#property-_textanchor-6) | [shapes/Shape.ts:94](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L94) |
| <a id="property-_texture-1"></a> `_texture` | `AccessorFn` | - | [`Shape`](#shape-23).[`_texture`](#property-_texture-6) | [shapes/Shape.ts:95](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L95) |
| <a id="property-_texturedefault-1"></a> `_textureDefault` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_textureDefault`](#property-_texturedefault-6) | [shapes/Shape.ts:96](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L96) |
| <a id="property-_texturedefs-1"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-23).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:97](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L97) |
| <a id="property-_transition-6"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-23).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:103](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L103) |
| <a id="property-_translate-6"></a> `_translate` | (`d`: `string`, `locale?`: `string`) => `string` | - | [`Shape`](#shape-23).[`_translate`](#property-_translate-15) | [utils/BaseClass.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L67) |
| <a id="property-_update-1"></a> `_update` | `Selection` | - | [`Shape`](#shape-23).[`_update`](#property-_update-6) | [shapes/Shape.ts:108](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L108) |
| <a id="property-_uuid-6"></a> `_uuid` | `string` | - | [`Shape`](#shape-23).[`_uuid`](#property-_uuid-15) | [utils/BaseClass.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L68) |
| <a id="property-_vectoreffect-1"></a> `_vectorEffect` | `AccessorFn` | - | [`Shape`](#shape-23).[`_vectorEffect`](#property-_vectoreffect-6) | [shapes/Shape.ts:98](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L98) |
| <a id="property-_verticalalign-1"></a> `_verticalAlign` | `AccessorFn` | - | [`Shape`](#shape-23).[`_verticalAlign`](#property-_verticalalign-7) | [shapes/Shape.ts:99](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L99) |
| <a id="property-_width-5"></a> `_width` | `AccessorFn` | - | - | [shapes/Bar.ts:21](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L21) |
| <a id="property-_x-1"></a> `_x` | `AccessorFn` | [`Shape`](#shape-23).[`_x`](#property-_x-8) | - | [shapes/Bar.ts:22](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L22) |
| <a id="property-_x0-1"></a> `_x0` | `AccessorFn` | - | - | [shapes/Bar.ts:23](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L23) |
| <a id="property-_x1-1"></a> `_x1` | `AccessorFn` \| `null` | - | - | [shapes/Bar.ts:24](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L24) |
| <a id="property-_y-1"></a> `_y` | `AccessorFn` | [`Shape`](#shape-23).[`_y`](#property-_y-8) | - | [shapes/Bar.ts:25](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L25) |
| <a id="property-_y0-1"></a> `_y0` | `AccessorFn` | - | - | [shapes/Bar.ts:26](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L26) |
| <a id="property-_y1-1"></a> `_y1` | `AccessorFn` \| `null` | - | - | [shapes/Bar.ts:27](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Bar.ts#L27) |

***

<a id="barchart"></a>

### BarChart

Defined in: [charts/BarChart.ts:13](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/BarChart.ts#L13)

Creates a bar chart based on an array of data.

#### Example

```ts
new d3plus.Plot()
.baseline(0)
.discrete("x")
.shape("Bar")
```

#### Extends

- [`Plot`](#plot)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-3"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`active`](#active-18)

<a id="aggs-1"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`aggs`](#aggs-11)

<a id="annotations-1"></a>

##### annotations()

> **annotations**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2004](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2004)

Allows drawing custom shapes to be used as annotations in the provided x/y plot. This method accepts custom config objects for the [Shape](http://d3plus.org/docs/#Shape) class, either a single config object or an array of config objects. Each config object requires an additional parameter, the "shape", which denotes which [Shape](http://d3plus.org/docs/#Shape) sub-class to use ([Rect](http://d3plus.org/docs/#Rect), [Line](http://d3plus.org/docs/#Line), etc).

Additionally, each config object can also contain an optional "layer" key, which defines whether the annotations will be displayed in "front" or in "back" of the primary visualization shapes. This value defaults to "back" if not present.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`annotations`](#annotations-5)

<a id="ariahidden-1"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`ariaHidden`](#ariahidden-11)

<a id="attribution-1"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`attribution`](#attribution-11)

<a id="attributionstyle-1"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`attributionStyle`](#attributionstyle-11)

<a id="axispersist-1"></a>

##### axisPersist()

> **axisPersist**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2013](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2013)

Determines whether the x and y axes should have their scales persist while users filter the data, the timeline being the prime example (set this to `true` to make the axes stay consistent when the timeline changes).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`axisPersist`](#axispersist-5)

<a id="backconfig-1"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`backConfig`](#backconfig-11)

<a id="backgroundconfig-1"></a>

##### backgroundConfig()

> **backgroundConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2022](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2022)

A d3plus-shape configuration Object used for styling the background rectangle of the inner x/y plot (behind all of the shapes and gridlines).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`backgroundConfig`](#backgroundconfig-5)

<a id="barpadding-1"></a>

##### barPadding()

> **barPadding**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2031](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2031)

The pixel space between each bar in a group of bars.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`barPadding`](#barpadding-5)

<a id="baseline-1"></a>

##### baseline()

> **baseline**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2038](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2038)

The baseline for the x/y plot.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`baseline`](#baseline-5)

<a id="buffer-1"></a>

##### buffer()

> **buffer**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2045](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2045)

Determines whether or not to add additional padding at the ends of x or y scales. The most commone use for this is in Scatter Plots, so that the shapes do not appear directly on the axis itself. The value provided can either be `true` or `false` to toggle the behavior for all shape types, or a keyed Object for each shape type (ie. `{Bar: false, Circle: true, Line: false}`).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`buffer`](#buffer-5)

<a id="cache-1"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`cache`](#cache-11)

<a id="color-1"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`color`](#color-12)

<a id="colorscale-1"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`colorScale`](#colorscale-12)

<a id="colorscaleconfig-1"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`colorScaleConfig`](#colorscaleconfig-12)

<a id="colorscalemaxsize-1"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`colorScaleMaxSize`](#colorscalemaxsize-11)

<a id="colorscalepadding-1"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`colorScalePadding`](#colorscalepadding-12)

<a id="colorscaleposition-1"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| (() => `string` \| `boolean`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| (() => `string` \| `boolean`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`colorScalePosition`](#colorscaleposition-11)

<a id="confidence-1"></a>

##### confidence()

> **confidence**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2073](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2073)

The confidence interval as an array of [lower, upper] bounds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Example

```ts
var data = {id: "alpha", value: 10, lci: 9, hci: 11};
...
// Accessor functions
.confidence([function(d) { return d.lci }, function(d) { return d.hci }])

// Or static keys
.confidence(["lci", "hci"])
```

###### Inherited from

[`Plot`](#plot).[`confidence`](#confidence-5)

<a id="confidenceconfig-1"></a>

##### confidenceConfig()

> **confidenceConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2090](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2090)

Configuration object for shapes rendered as confidence intervals.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`confidenceConfig`](#confidenceconfig-5)

<a id="data-8"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): `DataPoint`[] \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

`DataPoint`[] \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`data`](#data-25)

<a id="datacutoff-1"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`dataCutoff`](#datacutoff-11)

<a id="depth-1"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`depth`](#depth-11)

<a id="destroy-1"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

###### Inherited from

[`Plot`](#plot).[`destroy`](#destroy-11)

<a id="detectresize-1"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`detectResize`](#detectresize-11)

<a id="detectresizedelay-1"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`detectResizeDelay`](#detectresizedelay-11)

<a id="detectvisible-1"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`detectVisible`](#detectvisible-11)

<a id="detectvisibleinterval-1"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`detectVisibleInterval`](#detectvisibleinterval-11)

<a id="discrete-3"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`discrete`](#discrete-16)

<a id="discretecutoff-1"></a>

##### discreteCutoff()

> **discreteCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2099](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2099)

When the width or height of the chart is less than or equal to this pixel value, the discrete axis will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`discreteCutoff`](#discretecutoff-5)

<a id="downloadbutton-1"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`downloadButton`](#downloadbutton-11)

<a id="downloadconfig-1"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`downloadConfig`](#downloadconfig-11)

<a id="downloadposition-1"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`downloadPosition`](#downloadposition-11)

<a id="duration-8"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`duration`](#duration-24)

<a id="filter-1"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`filter`](#filter-11)

<a id="fontfamily-1"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| `string`[] \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| `string`[] \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`fontFamily`](#fontfamily-11)

<a id="groupby-1"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

(`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`groupBy`](#groupby-11)

<a id="grouppadding-1"></a>

##### groupPadding()

> **groupPadding**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2108](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2108)

The pixel space between groups of bars.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`groupPadding`](#grouppadding-5)

<a id="height-7"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`height`](#height-20)

<a id="hiddencolor-1"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`hiddenColor`](#hiddencolor-11)

<a id="hiddenopacity-1"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`hiddenOpacity`](#hiddenopacity-11)

<a id="hover-3"></a>

##### hover()

> **hover**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `this`

Defined in: [charts/Viz.ts:1350](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1350)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`this`

###### Inherited from

[`Plot`](#plot).[`hover`](#hover-18)

<a id="label-3"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`label`](#label-17)

<a id="labelconnectorconfig-1"></a>

##### labelConnectorConfig()

> **labelConnectorConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2117](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2117)

The d3plus-shape config used on the Line shapes created to connect lineLabels to the end of their associated Line path.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`labelConnectorConfig`](#labelconnectorconfig-5)

<a id="labelposition-1"></a>

##### labelPosition()

> **labelPosition**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2127](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2127)

The behavior to be used when calculating the position and size of each shape's label(s). The value passed can either be the _String_ name of the behavior to be used for all shapes, or an accessor _Function_ that will be provided each data point and will be expected to return the behavior to be used for that data point. The availability and options for this method depend on the default logic for each Shape. As an example, the values "outside" or "inside" can be set for Bar shapes, whose "auto" default will calculate the best position dynamically based on the available space.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`labelPosition`](#labelposition-5)

<a id="legend-1"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`legend`](#legend-12)

<a id="legendconfig-1"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`legendConfig`](#legendconfig-13)

<a id="legendfilterinvert-1"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`legendFilterInvert`](#legendfilterinvert-11)

<a id="legendpadding-1"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`legendPadding`](#legendpadding-12)

<a id="legendposition-1"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| (() => `string`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| (() => `string`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`legendPosition`](#legendposition-11)

<a id="legendsort-1"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`legendSort`](#legendsort-11)

<a id="legendtooltip-1"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`legendTooltip`](#legendtooltip-11)

<a id="linelabels-1"></a>

##### lineLabels()

> **lineLabels**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2137](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2137)

Draws labels on the right side of any Line shapes that are drawn on the plot.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`lineLabels`](#linelabels-5)

<a id="linemarkerconfig-1"></a>

##### lineMarkerConfig()

> **lineMarkerConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2144](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2144)

Shape config for the Circle shapes drawn by the lineMarkers method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`lineMarkerConfig`](#linemarkerconfig-5)

<a id="linemarkers-1"></a>

##### lineMarkers()

> **lineMarkers**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2153](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2153)

Draws circle markers on each vertex of a Line.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`lineMarkers`](#linemarkers-5)

<a id="loadinghtml-1"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`loadingHTML`](#loadinghtml-11)

<a id="loadingmessage-1"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`loadingMessage`](#loadingmessage-11)

<a id="messagemask-1"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`messageMask`](#messagemask-11)

<a id="messagestyle-1"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`messageStyle`](#messagestyle-11)

<a id="nodatahtml-1"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`noDataHTML`](#nodatahtml-11)

<a id="nodatamessage-1"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`noDataMessage`](#nodatamessage-11)

<a id="render-8"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Plot`](#plot).[`render`](#render-25)

<a id="scrollcontainer-1"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| `HTMLElement` \| `Window` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| `HTMLElement` \| `Window` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`scrollContainer`](#scrollcontainer-11)

<a id="select-8"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

`Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`select`](#select-25)

<a id="shape-6"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`shape`](#shape-17)

<a id="shapeconfig-8"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`shapeConfig`](#shapeconfig-25)

<a id="shapesort-1"></a>

##### shapeSort()

> **shapeSort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2162](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2162)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) that receives each shape Class (ie. "Circle", "Line", etc) as it's comparator arguments. Shapes are drawn in groups based on their type, so you are defining the layering order for all shapes of said type.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`shapeSort`](#shapesort-5)

<a id="size-1"></a>

##### size()

> **size**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2169](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2169)

Sets the size of bubbles to the given Number, data key, or function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`size`](#size-7)

<a id="sizemax-1"></a>

##### sizeMax()

> **sizeMax**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2178)

Sets the size scale maximum to the specified number.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`sizeMax`](#sizemax-6)

<a id="sizemin-1"></a>

##### sizeMin()

> **sizeMin**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2185](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2185)

Sets the size scale minimum to the specified number.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`sizeMin`](#sizemin-6)

<a id="sizescale-1"></a>

##### sizeScale()

> **sizeScale**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2192](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2192)

Sets the size scale to the specified string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`sizeScale`](#sizescale-6)

<a id="stacked-1"></a>

##### stacked()

> **stacked**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2199](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2199)

If *value* is specified, toggles shape stacking. If *value* is not specified, returns the current stack value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`stacked`](#stacked-5)

<a id="stackoffset-1"></a>

##### stackOffset()

> **stackOffset**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2206](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2206)

Sets the stack offset. If *value* is not specified, returns the current stack offset function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`stackOffset`](#stackoffset-5)

<a id="stackorder-1"></a>

##### stackOrder()

> **stackOrder**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2219](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2219)

Sets the stack order. If *value* is not specified, returns the current stack order function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`stackOrder`](#stackorder-5)

<a id="subtitle-1"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`subtitle`](#subtitle-11)

<a id="subtitleconfig-1"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`subtitleConfig`](#subtitleconfig-11)

<a id="subtitlepadding-1"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`subtitlePadding`](#subtitlepadding-11)

<a id="svgdesc-1"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`svgDesc`](#svgdesc-11)

<a id="svgtitle-1"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`svgTitle`](#svgtitle-11)

<a id="threshold-1"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| ((`data`: `DataPoint`[]) => `number`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| ((`data`: `DataPoint`[]) => `number`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`threshold`](#threshold-11)

<a id="thresholdkey-1"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`thresholdKey`](#thresholdkey-11)

<a id="thresholdname-1"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`thresholdName`](#thresholdname-11)

<a id="time-1"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`time`](#time-11)

<a id="timefilter-1"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`timeFilter`](#timefilter-11)

<a id="timeline-1"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`timeline`](#timeline-11)

<a id="timelineconfig-1"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`timelineConfig`](#timelineconfig-11)

<a id="timelinedefault-1"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): `Date`[] \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

`Date`[] \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`timelineDefault`](#timelinedefault-11)

<a id="timelinepadding-1"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`timelinePadding`](#timelinepadding-11)

<a id="title-6"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`title`](#title-17)

<a id="titleconfig-6"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`titleConfig`](#titleconfig-17)

<a id="titlepadding-1"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`titlePadding`](#titlepadding-11)

<a id="tooltip-1"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`tooltip`](#tooltip-11)

<a id="tooltipconfig-1"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`tooltipConfig`](#tooltipconfig-11)

<a id="total-1"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`total`](#total-11)

<a id="totalconfig-1"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`totalConfig`](#totalconfig-11)

<a id="totalformat-1"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): ((`d`: `number`) => `string`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

((`d`: `number`) => `string`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`totalFormat`](#totalformat-11)

<a id="totalpadding-1"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`totalPadding`](#totalpadding-11)

<a id="width-7"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`width`](#width-20)

<a id="x-3"></a>

##### x()

> **x**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2236](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2236)

Accessor function or string key for the x-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x`](#x-13)

<a id="x2-1"></a>

##### x2()

> **x2**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2250)

Accessor function or string key for the secondary x-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x2`](#x2-5)

<a id="x2config-1"></a>

##### x2Config()

> **x2Config**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2280](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2280)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the secondary x-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x2Config`](#x2config-5)

<a id="x2domain-1"></a>

##### x2Domain()

> **x2Domain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2296](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2296)

The x2 domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x2Domain`](#x2domain-5)

<a id="x2sort-1"></a>

##### x2Sort()

> **x2Sort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2310](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2310)

Defines a custom sorting comparitor function to be used for discrete x2 axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x2Sort`](#x2sort-5)

<a id="xconfig-1"></a>

##### xConfig()

> **xConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2264](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2264)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the x-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`xConfig`](#xconfig-5)

<a id="xcutoff-1"></a>

##### xCutoff()

> **xCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2273](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2273)

When the width of the chart is less than or equal to this pixel value, and the x-axis is not the discrete axis, it will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`xCutoff`](#xcutoff-5)

<a id="xdomain-1"></a>

##### xDomain()

> **xDomain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2289](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2289)

The x domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`xDomain`](#xdomain-5)

<a id="xsort-1"></a>

##### xSort()

> **xSort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2303](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2303)

Defines a custom sorting comparitor function to be used for discrete x axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`xSort`](#xsort-5)

<a id="y-3"></a>

##### y()

> **y**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2317](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2317)

Accessor function or string key for the y-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y`](#y-13)

<a id="y2-1"></a>

##### y2()

> **y2**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2331](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2331)

Accessor function or string key for the secondary y-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y2`](#y2-5)

<a id="y2config-1"></a>

##### y2Config()

> **y2Config**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2366](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2366)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the secondary y-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y2Config`](#y2config-5)

<a id="y2domain-1"></a>

##### y2Domain()

> **y2Domain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2385](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2385)

The y2 domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y2Domain`](#y2domain-5)

<a id="y2sort-1"></a>

##### y2Sort()

> **y2Sort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2399](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2399)

Defines a custom sorting comparitor function to be used for discrete y2 axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y2Sort`](#y2sort-5)

<a id="yconfig-1"></a>

##### yConfig()

> **yConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2347](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2347)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the y-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

*Note:* If a "domain" array is passed to the y-axis config, it will be reversed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`yConfig`](#yconfig-5)

<a id="ycutoff-1"></a>

##### yCutoff()

> **yCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2359](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2359)

When the height of the chart is less than or equal to this pixel value, and the y-axis is not the discrete axis, it will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`yCutoff`](#ycutoff-5)

<a id="ydomain-1"></a>

##### yDomain()

> **yDomain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2378](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2378)

The y domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`yDomain`](#ydomain-5)

<a id="ysort-1"></a>

##### ySort()

> **ySort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2392](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2392)

Defines a custom sorting comparitor function to be used for discrete y axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`ySort`](#ysort-5)

<a id="zoom-1"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`zoom`](#zoom-11)

<a id="zoombrushhandlesize-1"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`zoomBrushHandleSize`](#zoombrushhandlesize-11)

<a id="zoombrushhandlestyle-1"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`zoomBrushHandleStyle`](#zoombrushhandlestyle-11)

<a id="zoombrushselectionstyle-1"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`zoomBrushSelectionStyle`](#zoombrushselectionstyle-11)

<a id="zoomcontrolstyle-1"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`zoomControlStyle`](#zoomcontrolstyle-11)

<a id="zoomcontrolstyleactive-1"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`zoomControlStyleActive`](#zoomcontrolstyleactive-11)

<a id="zoomcontrolstylehover-1"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`zoomControlStyleHover`](#zoomcontrolstylehover-11)

<a id="zoomfactor-1"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`zoomFactor`](#zoomfactor-11)

<a id="zoommax-1"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`zoomMax`](#zoommax-11)

<a id="zoompadding-1"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`zoomPadding`](#zoompadding-11)

<a id="zoompan-1"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`zoomPan`](#zoompan-11)

<a id="zoomscroll-1"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`BarChart`](#barchart)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BarChart`](#barchart)

###### Inherited from

[`Plot`](#plot).[`zoomScroll`](#zoomscroll-11)

***

<a id="baseclass"></a>

### BaseClass

Defined in: [utils/BaseClass.ts:63](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L63)

Provides shared configuration, event handling, and locale management inherited by all d3plus classes.

#### Extended by

- [`Axis`](#axis)
- [`ColorScale`](#colorscale-4)
- [`Legend`](#legend-6)
- [`TextBox`](#textbox)
- [`Tooltip`](#tooltip-18)
- [`Box`](#box)
- [`Shape`](#shape-23)
- [`Whisker`](#whisker)

#### Methods

<a id="config-7"></a>

##### config()

###### Call Signature

> **config**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L91)

Methods that correspond to the key/value pairs and returns this class.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Call Signature

> **config**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L92)

Methods that correspond to the key/value pairs and returns this class.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

<a id="locale-7"></a>

##### locale()

###### Call Signature

> **locale**(): `string`

Defined in: [utils/BaseClass.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L156)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Returns

`string`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Call Signature

> **locale**(`_`: `string` \| `object`): `this`

Defined in: [utils/BaseClass.ts:157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L157)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `object` |

###### Returns

`this`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

<a id="on-7"></a>

##### on()

###### Call Signature

> **on**(): `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

Defined in: [utils/BaseClass.ts:176](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L176)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Returns

`Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Call Signature

> **on**(`_`: `string`): ((...`args`: `unknown`[]) => `unknown`) \| `undefined`

Defined in: [utils/BaseClass.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L177)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

((...`args`: `unknown`[]) => `unknown`) \| `undefined`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Call Signature

> **on**(`_`: `string`, `f`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [utils/BaseClass.ts:178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L178)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |
| `f` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Call Signature

> **on**(`_`: `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:179](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L179)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

<a id="parent-7"></a>

##### parent()

###### Call Signature

> **parent**(): `Record`\<`string`, `unknown`\>

Defined in: [utils/BaseClass.ts:200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L200)

Parent config used by the wrapper.

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **parent**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L201)

Parent config used by the wrapper.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="shapeconfig-9"></a>

##### shapeConfig()

###### Call Signature

> **shapeConfig**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L225)

Configuration object with key/value pairs applied as method calls on each shape.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Call Signature

> **shapeConfig**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:226](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L226)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

<a id="translate-7"></a>

##### translate()

###### Call Signature

> **translate**(): (`d`: `string`, `locale?`: `string`) => `string`

Defined in: [utils/BaseClass.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L214)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Returns

(`d`: `string`, `locale?`: `string`) => `string`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Call Signature

> **translate**(`_`: (`d`: `string`, `locale?`: `string`) => `string`): `this`

Defined in: [utils/BaseClass.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L215)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `string`, `locale?`: `string`) => `string` |

###### Returns

`this`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="property-_configdefault-7"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | [utils/BaseClass.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L69) |
| <a id="property-_locale-7"></a> `_locale` | `string` | [utils/BaseClass.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L64) |
| <a id="property-_on-7"></a> `_on` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | [utils/BaseClass.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L65) |
| <a id="property-_parent-7"></a> `_parent` | `Record`\<`string`, `unknown`\> | [utils/BaseClass.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L66) |
| <a id="property-_shapeconfig-7"></a> `_shapeConfig?` | [`D3plusConfig`](#d3plusconfig) | [utils/BaseClass.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L70) |
| <a id="property-_translate-7"></a> `_translate` | (`d`: `string`, `locale?`: `string`) => `string` | [utils/BaseClass.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L67) |
| <a id="property-_uuid-7"></a> `_uuid` | `string` | [utils/BaseClass.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L68) |

***

<a id="box"></a>

### Box

Defined in: [shapes/Box.ts:20](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L20)

Creates SVG box based on an array of data.

#### Extends

- [`BaseClass`](#baseclass)

#### Methods

<a id="active-4"></a>

##### active()

> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `void`

Defined in: [shapes/Box.ts:321](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L321)

The active highlight state for all sub-shapes in this Box.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` |

###### Returns

`void`

<a id="config-8"></a>

##### config()

###### Call Signature

> **config**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L91)

Methods that correspond to the key/value pairs and returns this class.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`BaseClass`](#baseclass).[`config`](#config-7)

###### Call Signature

> **config**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L92)

Methods that correspond to the key/value pairs and returns this class.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`config`](#config-7)

<a id="data-9"></a>

##### data()

###### Call Signature

> **data**(): `DataPoint`[]

Defined in: [shapes/Box.ts:334](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L334)

The data array used to create shapes.

###### Returns

`DataPoint`[]

###### Call Signature

> **data**(`_`: `DataPoint`[]): `this`

Defined in: [shapes/Box.ts:335](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L335)

The data array used to create shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `DataPoint`[] |

###### Returns

`this`

<a id="hover-4"></a>

##### hover()

> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `void`

Defined in: [shapes/Box.ts:343](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L343)

The hover highlight state for all sub-shapes in this Box.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` |

###### Returns

`void`

<a id="locale-8"></a>

##### locale()

###### Call Signature

> **locale**(): `string`

Defined in: [utils/BaseClass.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L156)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Returns

`string`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`BaseClass`](#baseclass).[`locale`](#locale-7)

###### Call Signature

> **locale**(`_`: `string` \| `object`): `this`

Defined in: [utils/BaseClass.ts:157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L157)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `object` |

###### Returns

`this`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`BaseClass`](#baseclass).[`locale`](#locale-7)

<a id="medianconfig"></a>

##### medianConfig()

###### Call Signature

> **medianConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Box.ts:356](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L356)

Configuration object for the median line.

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **medianConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Box.ts:357](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L357)

Configuration object for the median line.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="on-8"></a>

##### on()

###### Call Signature

> **on**(): `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

Defined in: [utils/BaseClass.ts:176](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L176)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Returns

`Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `string`): ((...`args`: `unknown`[]) => `unknown`) \| `undefined`

Defined in: [utils/BaseClass.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L177)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

((...`args`: `unknown`[]) => `unknown`) \| `undefined`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `string`, `f`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [utils/BaseClass.ts:178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L178)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |
| `f` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:179](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L179)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

<a id="orient-5"></a>

##### orient()

###### Call Signature

> **orient**(): `AccessorFn`

Defined in: [shapes/Box.ts:367](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L367)

The orientation of the box shape.

###### Returns

`AccessorFn`

###### Call Signature

> **orient**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Box.ts:368](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L368)

The orientation of the box shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

<a id="outlier"></a>

##### outlier()

###### Call Signature

> **outlier**(): `AccessorFn`

Defined in: [shapes/Box.ts:378](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L378)

Whether to show outlier points.

###### Returns

`AccessorFn`

###### Call Signature

> **outlier**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Box.ts:379](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L379)

Whether to show outlier points.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

<a id="outlierconfig"></a>

##### outlierConfig()

###### Call Signature

> **outlierConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Box.ts:389](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L389)

Configuration object for each outlier point.

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **outlierConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Box.ts:390](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L390)

Configuration object for each outlier point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="parent-8"></a>

##### parent()

###### Call Signature

> **parent**(): `Record`\<`string`, `unknown`\>

Defined in: [utils/BaseClass.ts:200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L200)

Parent config used by the wrapper.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`BaseClass`](#baseclass).[`parent`](#parent-7)

###### Call Signature

> **parent**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L201)

Parent config used by the wrapper.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`parent`](#parent-7)

<a id="rectconfig"></a>

##### rectConfig()

###### Call Signature

> **rectConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Box.ts:400](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L400)

Configuration object for the rect shape.

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **rectConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Box.ts:401](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L401)

Configuration object for the rect shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="rectwidth"></a>

##### rectWidth()

###### Call Signature

> **rectWidth**(): `AccessorFn`

Defined in: [shapes/Box.ts:416](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L416)

The width accessor for each box.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.width;
}
```

###### Call Signature

> **rectWidth**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Box.ts:417](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L417)

The width accessor for each box.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.width;
}
```

<a id="render-9"></a>

##### render()

> **render**(): `this`

Defined in: [shapes/Box.ts:78](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L78)

Draws the Box.

###### Returns

`this`

<a id="select-9"></a>

##### select()

###### Call Signature

> **select**(): `Selection`

Defined in: [shapes/Box.ts:427](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L427)

The SVG container element for this visualization. 3 selector or DOM element.

###### Returns

`Selection`

###### Call Signature

> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`

Defined in: [shapes/Box.ts:428](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L428)

The SVG container element for this visualization. 3 selector or DOM element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `HTMLElement` \| `SVGElement` \| `null` |

###### Returns

`this`

<a id="shapeconfig-10"></a>

##### shapeConfig()

###### Call Signature

> **shapeConfig**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L225)

Configuration object with key/value pairs applied as method calls on each shape.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`BaseClass`](#baseclass).[`shapeConfig`](#shapeconfig-9)

###### Call Signature

> **shapeConfig**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:226](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L226)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`shapeConfig`](#shapeconfig-9)

<a id="translate-8"></a>

##### translate()

###### Call Signature

> **translate**(): (`d`: `string`, `locale?`: `string`) => `string`

Defined in: [utils/BaseClass.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L214)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Returns

(`d`: `string`, `locale?`: `string`) => `string`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`translate`](#translate-7)

###### Call Signature

> **translate**(`_`: (`d`: `string`, `locale?`: `string`) => `string`): `this`

Defined in: [utils/BaseClass.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L215)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `string`, `locale?`: `string`) => `string` |

###### Returns

`this`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`translate`](#translate-7)

<a id="whiskerconfig"></a>

##### whiskerConfig()

###### Call Signature

> **whiskerConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Box.ts:438](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L438)

Configuration object for the whisker.

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **whiskerConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Box.ts:439](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L439)

Configuration object for the whisker.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="whiskermode"></a>

##### whiskerMode()

###### Call Signature

> **whiskerMode**(): (`string` \| `number`)[]

Defined in: [shapes/Box.ts:449](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L449)

Determines the value used for each whisker. Can be passed a single value to apply for both whiskers, or an Array of 2 values for the lower and upper whiskers (in that order). Accepted values are `"tukey"`, `"extent"`, or a Number representing a quantile.

###### Returns

(`string` \| `number`)[]

###### Call Signature

> **whiskerMode**(`_`: `string` \| `number` \| (`string` \| `number`)[]): `this`

Defined in: [shapes/Box.ts:450](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L450)

Determines the value used for each whisker. Can be passed a single value to apply for both whiskers, or an Array of 2 values for the lower and upper whiskers (in that order). Accepted values are `"tukey"`, `"extent"`, or a Number representing a quantile.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `number` \| (`string` \| `number`)[] |

###### Returns

`this`

<a id="x-4"></a>

##### x()

###### Call Signature

> **x**(): `AccessorFn`

Defined in: [shapes/Box.ts:467](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L467)

The x position accessor for each box.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Call Signature

> **x**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Box.ts:468](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L468)

The x position accessor for each box.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.x;
}
```

<a id="y-4"></a>

##### y()

###### Call Signature

> **y**(): `AccessorFn`

Defined in: [shapes/Box.ts:485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L485)

The y position accessor for each box.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.y;
}
```

###### Call Signature

> **y**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Box.ts:486](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L486)

The y position accessor for each box.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.y;
}
```

#### Properties

| Property | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="property-_box"></a> `_box` | [`Rect`](#rect) | - | [shapes/Box.ts:33](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L33) |
| <a id="property-_configdefault-8"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | [`BaseClass`](#baseclass).[`_configDefault`](#property-_configdefault-7) | [utils/BaseClass.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L69) |
| <a id="property-_data-7"></a> `_data` | `DataPoint`[] | - | [shapes/Box.ts:31](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L31) |
| <a id="property-_duration-7"></a> `_duration` | `number` | - | [shapes/Box.ts:37](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L37) |
| <a id="property-_locale-8"></a> `_locale` | `string` | [`BaseClass`](#baseclass).[`_locale`](#property-_locale-7) | [utils/BaseClass.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L64) |
| <a id="property-_median"></a> `_median` | [`Rect`](#rect) | - | [shapes/Box.ts:34](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L34) |
| <a id="property-_medianconfig"></a> `_medianConfig` | `Record`\<`string`, `unknown`\> | - | [shapes/Box.ts:21](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L21) |
| <a id="property-_on-8"></a> `_on` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | [`BaseClass`](#baseclass).[`_on`](#property-_on-7) | [utils/BaseClass.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L65) |
| <a id="property-_orient-5"></a> `_orient` | `AccessorFn` | - | [shapes/Box.ts:22](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L22) |
| <a id="property-_outlier"></a> `_outlier` | `AccessorFn` | - | [shapes/Box.ts:23](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L23) |
| <a id="property-_outlierconfig"></a> `_outlierConfig` | `Record`\<`string`, `unknown`\> | - | [shapes/Box.ts:24](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L24) |
| <a id="property-_parent-8"></a> `_parent` | `Record`\<`string`, `unknown`\> | [`BaseClass`](#baseclass).[`_parent`](#property-_parent-7) | [utils/BaseClass.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L66) |
| <a id="property-_rectconfig"></a> `_rectConfig` | `Record`\<`string`, `unknown`\> | - | [shapes/Box.ts:25](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L25) |
| <a id="property-_rectwidth"></a> `_rectWidth` | `AccessorFn` | - | [shapes/Box.ts:26](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L26) |
| <a id="property-_select-7"></a> `_select` | `Selection` | - | [shapes/Box.ts:32](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L32) |
| <a id="property-_shapeconfig-8"></a> `_shapeConfig?` | [`D3plusConfig`](#d3plusconfig) | [`BaseClass`](#baseclass).[`_shapeConfig`](#property-_shapeconfig-7) | [utils/BaseClass.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L70) |
| <a id="property-_translate-8"></a> `_translate` | (`d`: `string`, `locale?`: `string`) => `string` | [`BaseClass`](#baseclass).[`_translate`](#property-_translate-7) | [utils/BaseClass.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L67) |
| <a id="property-_uuid-8"></a> `_uuid` | `string` | [`BaseClass`](#baseclass).[`_uuid`](#property-_uuid-7) | [utils/BaseClass.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L68) |
| <a id="property-_whisker"></a> `_whisker` | [`Whisker`](#whisker) | - | [shapes/Box.ts:35](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L35) |
| <a id="property-_whiskerconfig"></a> `_whiskerConfig` | `Record`\<`string`, `unknown`\> | - | [shapes/Box.ts:27](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L27) |
| <a id="property-_whiskerendpoint"></a> `_whiskerEndpoint` | ([`Rect`](#rect) \| [`Circle`](#circle))[] | - | [shapes/Box.ts:36](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L36) |
| <a id="property-_whiskermode"></a> `_whiskerMode` | (`string` \| `number`)[] | - | [shapes/Box.ts:28](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L28) |
| <a id="property-_x-2"></a> `_x` | `AccessorFn` | - | [shapes/Box.ts:29](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L29) |
| <a id="property-_y-2"></a> `_y` | `AccessorFn` | - | [shapes/Box.ts:30](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Box.ts#L30) |

***

<a id="boxwhisker"></a>

### BoxWhisker

Defined in: [charts/BoxWhisker.ts:10](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/BoxWhisker.ts#L10)

Creates a simple box and whisker based on an array of data.

#### Extends

- [`Plot`](#plot)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-5"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`active`](#active-18)

<a id="aggs-2"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`aggs`](#aggs-11)

<a id="annotations-2"></a>

##### annotations()

> **annotations**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2004](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2004)

Allows drawing custom shapes to be used as annotations in the provided x/y plot. This method accepts custom config objects for the [Shape](http://d3plus.org/docs/#Shape) class, either a single config object or an array of config objects. Each config object requires an additional parameter, the "shape", which denotes which [Shape](http://d3plus.org/docs/#Shape) sub-class to use ([Rect](http://d3plus.org/docs/#Rect), [Line](http://d3plus.org/docs/#Line), etc).

Additionally, each config object can also contain an optional "layer" key, which defines whether the annotations will be displayed in "front" or in "back" of the primary visualization shapes. This value defaults to "back" if not present.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`annotations`](#annotations-5)

<a id="ariahidden-2"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`ariaHidden`](#ariahidden-11)

<a id="attribution-2"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`attribution`](#attribution-11)

<a id="attributionstyle-2"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`attributionStyle`](#attributionstyle-11)

<a id="axispersist-2"></a>

##### axisPersist()

> **axisPersist**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2013](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2013)

Determines whether the x and y axes should have their scales persist while users filter the data, the timeline being the prime example (set this to `true` to make the axes stay consistent when the timeline changes).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`axisPersist`](#axispersist-5)

<a id="backconfig-2"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`backConfig`](#backconfig-11)

<a id="backgroundconfig-2"></a>

##### backgroundConfig()

> **backgroundConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2022](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2022)

A d3plus-shape configuration Object used for styling the background rectangle of the inner x/y plot (behind all of the shapes and gridlines).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`backgroundConfig`](#backgroundconfig-5)

<a id="barpadding-2"></a>

##### barPadding()

> **barPadding**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2031](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2031)

The pixel space between each bar in a group of bars.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`barPadding`](#barpadding-5)

<a id="baseline-2"></a>

##### baseline()

> **baseline**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2038](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2038)

The baseline for the x/y plot.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`baseline`](#baseline-5)

<a id="buffer-2"></a>

##### buffer()

> **buffer**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2045](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2045)

Determines whether or not to add additional padding at the ends of x or y scales. The most commone use for this is in Scatter Plots, so that the shapes do not appear directly on the axis itself. The value provided can either be `true` or `false` to toggle the behavior for all shape types, or a keyed Object for each shape type (ie. `{Bar: false, Circle: true, Line: false}`).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`buffer`](#buffer-5)

<a id="cache-2"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`cache`](#cache-11)

<a id="color-2"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`color`](#color-12)

<a id="colorscale-2"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`colorScale`](#colorscale-12)

<a id="colorscaleconfig-2"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`colorScaleConfig`](#colorscaleconfig-12)

<a id="colorscalemaxsize-2"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`colorScaleMaxSize`](#colorscalemaxsize-11)

<a id="colorscalepadding-2"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`colorScalePadding`](#colorscalepadding-12)

<a id="colorscaleposition-2"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| (() => `string` \| `boolean`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| (() => `string` \| `boolean`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`colorScalePosition`](#colorscaleposition-11)

<a id="confidence-2"></a>

##### confidence()

> **confidence**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2073](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2073)

The confidence interval as an array of [lower, upper] bounds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Example

```ts
var data = {id: "alpha", value: 10, lci: 9, hci: 11};
...
// Accessor functions
.confidence([function(d) { return d.lci }, function(d) { return d.hci }])

// Or static keys
.confidence(["lci", "hci"])
```

###### Inherited from

[`Plot`](#plot).[`confidence`](#confidence-5)

<a id="confidenceconfig-2"></a>

##### confidenceConfig()

> **confidenceConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2090](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2090)

Configuration object for shapes rendered as confidence intervals.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`confidenceConfig`](#confidenceconfig-5)

<a id="data-10"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): `DataPoint`[] \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

`DataPoint`[] \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`data`](#data-25)

<a id="datacutoff-2"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`dataCutoff`](#datacutoff-11)

<a id="depth-2"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`depth`](#depth-11)

<a id="destroy-2"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

###### Inherited from

[`Plot`](#plot).[`destroy`](#destroy-11)

<a id="detectresize-2"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`detectResize`](#detectresize-11)

<a id="detectresizedelay-2"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`detectResizeDelay`](#detectresizedelay-11)

<a id="detectvisible-2"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`detectVisible`](#detectvisible-11)

<a id="detectvisibleinterval-2"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`detectVisibleInterval`](#detectvisibleinterval-11)

<a id="discrete-4"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`discrete`](#discrete-16)

<a id="discretecutoff-2"></a>

##### discreteCutoff()

> **discreteCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2099](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2099)

When the width or height of the chart is less than or equal to this pixel value, the discrete axis will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`discreteCutoff`](#discretecutoff-5)

<a id="downloadbutton-2"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`downloadButton`](#downloadbutton-11)

<a id="downloadconfig-2"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`downloadConfig`](#downloadconfig-11)

<a id="downloadposition-2"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`downloadPosition`](#downloadposition-11)

<a id="duration-9"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`duration`](#duration-24)

<a id="filter-2"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`filter`](#filter-11)

<a id="fontfamily-2"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| `string`[] \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| `string`[] \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`fontFamily`](#fontfamily-11)

<a id="groupby-2"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

(`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`groupBy`](#groupby-11)

<a id="grouppadding-2"></a>

##### groupPadding()

> **groupPadding**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2108](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2108)

The pixel space between groups of bars.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`groupPadding`](#grouppadding-5)

<a id="height-8"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`height`](#height-20)

<a id="hiddencolor-2"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`hiddenColor`](#hiddencolor-11)

<a id="hiddenopacity-2"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`hiddenOpacity`](#hiddenopacity-11)

<a id="hover-5"></a>

##### hover()

> **hover**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `this`

Defined in: [charts/Viz.ts:1350](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1350)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`this`

###### Inherited from

[`Plot`](#plot).[`hover`](#hover-18)

<a id="label-4"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`label`](#label-17)

<a id="labelconnectorconfig-2"></a>

##### labelConnectorConfig()

> **labelConnectorConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2117](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2117)

The d3plus-shape config used on the Line shapes created to connect lineLabels to the end of their associated Line path.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`labelConnectorConfig`](#labelconnectorconfig-5)

<a id="labelposition-2"></a>

##### labelPosition()

> **labelPosition**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2127](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2127)

The behavior to be used when calculating the position and size of each shape's label(s). The value passed can either be the _String_ name of the behavior to be used for all shapes, or an accessor _Function_ that will be provided each data point and will be expected to return the behavior to be used for that data point. The availability and options for this method depend on the default logic for each Shape. As an example, the values "outside" or "inside" can be set for Bar shapes, whose "auto" default will calculate the best position dynamically based on the available space.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`labelPosition`](#labelposition-5)

<a id="legend-2"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`legend`](#legend-12)

<a id="legendconfig-2"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`legendConfig`](#legendconfig-13)

<a id="legendfilterinvert-2"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`legendFilterInvert`](#legendfilterinvert-11)

<a id="legendpadding-2"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`legendPadding`](#legendpadding-12)

<a id="legendposition-2"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| (() => `string`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| (() => `string`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`legendPosition`](#legendposition-11)

<a id="legendsort-2"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`legendSort`](#legendsort-11)

<a id="legendtooltip-2"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`legendTooltip`](#legendtooltip-11)

<a id="linelabels-2"></a>

##### lineLabels()

> **lineLabels**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2137](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2137)

Draws labels on the right side of any Line shapes that are drawn on the plot.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`lineLabels`](#linelabels-5)

<a id="linemarkerconfig-2"></a>

##### lineMarkerConfig()

> **lineMarkerConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2144](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2144)

Shape config for the Circle shapes drawn by the lineMarkers method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`lineMarkerConfig`](#linemarkerconfig-5)

<a id="linemarkers-2"></a>

##### lineMarkers()

> **lineMarkers**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2153](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2153)

Draws circle markers on each vertex of a Line.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`lineMarkers`](#linemarkers-5)

<a id="loadinghtml-2"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`loadingHTML`](#loadinghtml-11)

<a id="loadingmessage-2"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`loadingMessage`](#loadingmessage-11)

<a id="messagemask-2"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`messageMask`](#messagemask-11)

<a id="messagestyle-2"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`messageStyle`](#messagestyle-11)

<a id="nodatahtml-2"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`noDataHTML`](#nodatahtml-11)

<a id="nodatamessage-2"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`noDataMessage`](#nodatamessage-11)

<a id="render-10"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Plot`](#plot).[`render`](#render-25)

<a id="scrollcontainer-2"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| `HTMLElement` \| `Window` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| `HTMLElement` \| `Window` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`scrollContainer`](#scrollcontainer-11)

<a id="select-10"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

`Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`select`](#select-25)

<a id="shape-7"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`shape`](#shape-17)

<a id="shapeconfig-11"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`shapeConfig`](#shapeconfig-25)

<a id="shapesort-2"></a>

##### shapeSort()

> **shapeSort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2162](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2162)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) that receives each shape Class (ie. "Circle", "Line", etc) as it's comparator arguments. Shapes are drawn in groups based on their type, so you are defining the layering order for all shapes of said type.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`shapeSort`](#shapesort-5)

<a id="size-2"></a>

##### size()

> **size**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2169](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2169)

Sets the size of bubbles to the given Number, data key, or function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`size`](#size-7)

<a id="sizemax-2"></a>

##### sizeMax()

> **sizeMax**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2178)

Sets the size scale maximum to the specified number.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`sizeMax`](#sizemax-6)

<a id="sizemin-2"></a>

##### sizeMin()

> **sizeMin**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2185](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2185)

Sets the size scale minimum to the specified number.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`sizeMin`](#sizemin-6)

<a id="sizescale-2"></a>

##### sizeScale()

> **sizeScale**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2192](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2192)

Sets the size scale to the specified string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`sizeScale`](#sizescale-6)

<a id="stacked-2"></a>

##### stacked()

> **stacked**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2199](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2199)

If *value* is specified, toggles shape stacking. If *value* is not specified, returns the current stack value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`stacked`](#stacked-5)

<a id="stackoffset-2"></a>

##### stackOffset()

> **stackOffset**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2206](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2206)

Sets the stack offset. If *value* is not specified, returns the current stack offset function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`stackOffset`](#stackoffset-5)

<a id="stackorder-2"></a>

##### stackOrder()

> **stackOrder**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2219](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2219)

Sets the stack order. If *value* is not specified, returns the current stack order function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`stackOrder`](#stackorder-5)

<a id="subtitle-2"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`subtitle`](#subtitle-11)

<a id="subtitleconfig-2"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`subtitleConfig`](#subtitleconfig-11)

<a id="subtitlepadding-2"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`subtitlePadding`](#subtitlepadding-11)

<a id="svgdesc-2"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`svgDesc`](#svgdesc-11)

<a id="svgtitle-2"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`svgTitle`](#svgtitle-11)

<a id="threshold-2"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| ((`data`: `DataPoint`[]) => `number`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| ((`data`: `DataPoint`[]) => `number`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`threshold`](#threshold-11)

<a id="thresholdkey-2"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`thresholdKey`](#thresholdkey-11)

<a id="thresholdname-2"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`thresholdName`](#thresholdname-11)

<a id="time-2"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`time`](#time-11)

<a id="timefilter-2"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`timeFilter`](#timefilter-11)

<a id="timeline-2"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`timeline`](#timeline-11)

<a id="timelineconfig-2"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`timelineConfig`](#timelineconfig-11)

<a id="timelinedefault-2"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): `Date`[] \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

`Date`[] \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`timelineDefault`](#timelinedefault-11)

<a id="timelinepadding-2"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`timelinePadding`](#timelinepadding-11)

<a id="title-7"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`title`](#title-17)

<a id="titleconfig-7"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`titleConfig`](#titleconfig-17)

<a id="titlepadding-2"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`titlePadding`](#titlepadding-11)

<a id="tooltip-2"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`tooltip`](#tooltip-11)

<a id="tooltipconfig-2"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`tooltipConfig`](#tooltipconfig-11)

<a id="total-2"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`total`](#total-11)

<a id="totalconfig-2"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`totalConfig`](#totalconfig-11)

<a id="totalformat-2"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): ((`d`: `number`) => `string`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

((`d`: `number`) => `string`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`totalFormat`](#totalformat-11)

<a id="totalpadding-2"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`totalPadding`](#totalpadding-11)

<a id="width-8"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`width`](#width-20)

<a id="x-5"></a>

##### x()

> **x**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2236](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2236)

Accessor function or string key for the x-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x`](#x-13)

<a id="x2-2"></a>

##### x2()

> **x2**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2250)

Accessor function or string key for the secondary x-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x2`](#x2-5)

<a id="x2config-2"></a>

##### x2Config()

> **x2Config**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2280](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2280)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the secondary x-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x2Config`](#x2config-5)

<a id="x2domain-2"></a>

##### x2Domain()

> **x2Domain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2296](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2296)

The x2 domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x2Domain`](#x2domain-5)

<a id="x2sort-2"></a>

##### x2Sort()

> **x2Sort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2310](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2310)

Defines a custom sorting comparitor function to be used for discrete x2 axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x2Sort`](#x2sort-5)

<a id="xconfig-2"></a>

##### xConfig()

> **xConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2264](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2264)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the x-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`xConfig`](#xconfig-5)

<a id="xcutoff-2"></a>

##### xCutoff()

> **xCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2273](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2273)

When the width of the chart is less than or equal to this pixel value, and the x-axis is not the discrete axis, it will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`xCutoff`](#xcutoff-5)

<a id="xdomain-2"></a>

##### xDomain()

> **xDomain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2289](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2289)

The x domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`xDomain`](#xdomain-5)

<a id="xsort-2"></a>

##### xSort()

> **xSort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2303](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2303)

Defines a custom sorting comparitor function to be used for discrete x axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`xSort`](#xsort-5)

<a id="y-5"></a>

##### y()

> **y**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2317](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2317)

Accessor function or string key for the y-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y`](#y-13)

<a id="y2-2"></a>

##### y2()

> **y2**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2331](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2331)

Accessor function or string key for the secondary y-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y2`](#y2-5)

<a id="y2config-2"></a>

##### y2Config()

> **y2Config**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2366](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2366)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the secondary y-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y2Config`](#y2config-5)

<a id="y2domain-2"></a>

##### y2Domain()

> **y2Domain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2385](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2385)

The y2 domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y2Domain`](#y2domain-5)

<a id="y2sort-2"></a>

##### y2Sort()

> **y2Sort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2399](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2399)

Defines a custom sorting comparitor function to be used for discrete y2 axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y2Sort`](#y2sort-5)

<a id="yconfig-2"></a>

##### yConfig()

> **yConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2347](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2347)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the y-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

*Note:* If a "domain" array is passed to the y-axis config, it will be reversed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`yConfig`](#yconfig-5)

<a id="ycutoff-2"></a>

##### yCutoff()

> **yCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2359](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2359)

When the height of the chart is less than or equal to this pixel value, and the y-axis is not the discrete axis, it will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`yCutoff`](#ycutoff-5)

<a id="ydomain-2"></a>

##### yDomain()

> **yDomain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2378](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2378)

The y domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`yDomain`](#ydomain-5)

<a id="ysort-2"></a>

##### ySort()

> **ySort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2392](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2392)

Defines a custom sorting comparitor function to be used for discrete y axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`ySort`](#ysort-5)

<a id="zoom-2"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`zoom`](#zoom-11)

<a id="zoombrushhandlesize-2"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`zoomBrushHandleSize`](#zoombrushhandlesize-11)

<a id="zoombrushhandlestyle-2"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`zoomBrushHandleStyle`](#zoombrushhandlestyle-11)

<a id="zoombrushselectionstyle-2"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`zoomBrushSelectionStyle`](#zoombrushselectionstyle-11)

<a id="zoomcontrolstyle-2"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`zoomControlStyle`](#zoomcontrolstyle-11)

<a id="zoomcontrolstyleactive-2"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`zoomControlStyleActive`](#zoomcontrolstyleactive-11)

<a id="zoomcontrolstylehover-2"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`zoomControlStyleHover`](#zoomcontrolstylehover-11)

<a id="zoomfactor-2"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`zoomFactor`](#zoomfactor-11)

<a id="zoommax-2"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`zoomMax`](#zoommax-11)

<a id="zoompadding-2"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`zoomPadding`](#zoompadding-11)

<a id="zoompan-2"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`zoomPan`](#zoompan-11)

<a id="zoomscroll-2"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`BoxWhisker`](#boxwhisker)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BoxWhisker`](#boxwhisker)

###### Inherited from

[`Plot`](#plot).[`zoomScroll`](#zoomscroll-11)

***

<a id="bumpchart"></a>

### BumpChart

Defined in: [charts/BumpChart.ts:33](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/BumpChart.ts#L33)

Creates a bump chart based on an array of data.

#### Example

```ts
new d3plus.Plot()
.discrete("x")
.shape("Line")
.y2(d => this._y(d))
.yConfig({
tickFormat: val => {
  const data = this._formattedData;
  const xDomain = this._xDomain;
  const startData = data.filter(d => d.x === xDomain[0]);
  const d = startData.find(d => d.y === val);
  return this._drawLabel(d, d.i);
 }
})
.y2Config({
tickFormat: val => {
  const data = this._formattedData;
  const xDomain = this._xDomain;
  const endData = data.filter(d => d.x === xDomain[xDomain.length - 1]);
  const d = endData.find(d => d.y === val);
  return this._drawLabel(d, d.i);
 }
})
.ySort((a, b) => b.y - a.y)
.y2Sort((a, b) => b.y - a.y)
```

#### Extends

- [`Plot`](#plot)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-6"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`active`](#active-18)

<a id="aggs-3"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`aggs`](#aggs-11)

<a id="annotations-3"></a>

##### annotations()

> **annotations**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2004](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2004)

Allows drawing custom shapes to be used as annotations in the provided x/y plot. This method accepts custom config objects for the [Shape](http://d3plus.org/docs/#Shape) class, either a single config object or an array of config objects. Each config object requires an additional parameter, the "shape", which denotes which [Shape](http://d3plus.org/docs/#Shape) sub-class to use ([Rect](http://d3plus.org/docs/#Rect), [Line](http://d3plus.org/docs/#Line), etc).

Additionally, each config object can also contain an optional "layer" key, which defines whether the annotations will be displayed in "front" or in "back" of the primary visualization shapes. This value defaults to "back" if not present.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`annotations`](#annotations-5)

<a id="ariahidden-3"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`ariaHidden`](#ariahidden-11)

<a id="attribution-3"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`attribution`](#attribution-11)

<a id="attributionstyle-3"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`attributionStyle`](#attributionstyle-11)

<a id="axispersist-3"></a>

##### axisPersist()

> **axisPersist**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2013](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2013)

Determines whether the x and y axes should have their scales persist while users filter the data, the timeline being the prime example (set this to `true` to make the axes stay consistent when the timeline changes).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`axisPersist`](#axispersist-5)

<a id="backconfig-3"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`backConfig`](#backconfig-11)

<a id="backgroundconfig-3"></a>

##### backgroundConfig()

> **backgroundConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2022](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2022)

A d3plus-shape configuration Object used for styling the background rectangle of the inner x/y plot (behind all of the shapes and gridlines).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`backgroundConfig`](#backgroundconfig-5)

<a id="barpadding-3"></a>

##### barPadding()

> **barPadding**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2031](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2031)

The pixel space between each bar in a group of bars.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`barPadding`](#barpadding-5)

<a id="baseline-3"></a>

##### baseline()

> **baseline**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2038](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2038)

The baseline for the x/y plot.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`baseline`](#baseline-5)

<a id="buffer-3"></a>

##### buffer()

> **buffer**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2045](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2045)

Determines whether or not to add additional padding at the ends of x or y scales. The most commone use for this is in Scatter Plots, so that the shapes do not appear directly on the axis itself. The value provided can either be `true` or `false` to toggle the behavior for all shape types, or a keyed Object for each shape type (ie. `{Bar: false, Circle: true, Line: false}`).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`buffer`](#buffer-5)

<a id="cache-3"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`cache`](#cache-11)

<a id="color-3"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`color`](#color-12)

<a id="colorscale-3"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`colorScale`](#colorscale-12)

<a id="colorscaleconfig-3"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`colorScaleConfig`](#colorscaleconfig-12)

<a id="colorscalemaxsize-3"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`colorScaleMaxSize`](#colorscalemaxsize-11)

<a id="colorscalepadding-3"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`colorScalePadding`](#colorscalepadding-12)

<a id="colorscaleposition-3"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| (() => `string` \| `boolean`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| (() => `string` \| `boolean`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`colorScalePosition`](#colorscaleposition-11)

<a id="confidence-3"></a>

##### confidence()

> **confidence**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2073](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2073)

The confidence interval as an array of [lower, upper] bounds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Example

```ts
var data = {id: "alpha", value: 10, lci: 9, hci: 11};
...
// Accessor functions
.confidence([function(d) { return d.lci }, function(d) { return d.hci }])

// Or static keys
.confidence(["lci", "hci"])
```

###### Inherited from

[`Plot`](#plot).[`confidence`](#confidence-5)

<a id="confidenceconfig-3"></a>

##### confidenceConfig()

> **confidenceConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2090](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2090)

Configuration object for shapes rendered as confidence intervals.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`confidenceConfig`](#confidenceconfig-5)

<a id="data-11"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): `DataPoint`[] \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

`DataPoint`[] \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`data`](#data-25)

<a id="datacutoff-3"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`dataCutoff`](#datacutoff-11)

<a id="depth-3"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`depth`](#depth-11)

<a id="destroy-3"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

###### Inherited from

[`Plot`](#plot).[`destroy`](#destroy-11)

<a id="detectresize-3"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`detectResize`](#detectresize-11)

<a id="detectresizedelay-3"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`detectResizeDelay`](#detectresizedelay-11)

<a id="detectvisible-3"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`detectVisible`](#detectvisible-11)

<a id="detectvisibleinterval-3"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`detectVisibleInterval`](#detectvisibleinterval-11)

<a id="discrete-5"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`discrete`](#discrete-16)

<a id="discretecutoff-3"></a>

##### discreteCutoff()

> **discreteCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2099](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2099)

When the width or height of the chart is less than or equal to this pixel value, the discrete axis will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`discreteCutoff`](#discretecutoff-5)

<a id="downloadbutton-3"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`downloadButton`](#downloadbutton-11)

<a id="downloadconfig-3"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`downloadConfig`](#downloadconfig-11)

<a id="downloadposition-3"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`downloadPosition`](#downloadposition-11)

<a id="duration-10"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`duration`](#duration-24)

<a id="filter-3"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`filter`](#filter-11)

<a id="fontfamily-3"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| `string`[] \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| `string`[] \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`fontFamily`](#fontfamily-11)

<a id="groupby-3"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

(`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`groupBy`](#groupby-11)

<a id="grouppadding-3"></a>

##### groupPadding()

> **groupPadding**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2108](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2108)

The pixel space between groups of bars.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`groupPadding`](#grouppadding-5)

<a id="height-9"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`height`](#height-20)

<a id="hiddencolor-3"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`hiddenColor`](#hiddencolor-11)

<a id="hiddenopacity-3"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`hiddenOpacity`](#hiddenopacity-11)

<a id="hover-6"></a>

##### hover()

> **hover**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `this`

Defined in: [charts/Viz.ts:1350](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1350)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`this`

###### Inherited from

[`Plot`](#plot).[`hover`](#hover-18)

<a id="label-5"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`label`](#label-17)

<a id="labelconnectorconfig-3"></a>

##### labelConnectorConfig()

> **labelConnectorConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2117](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2117)

The d3plus-shape config used on the Line shapes created to connect lineLabels to the end of their associated Line path.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`labelConnectorConfig`](#labelconnectorconfig-5)

<a id="labelposition-3"></a>

##### labelPosition()

> **labelPosition**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2127](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2127)

The behavior to be used when calculating the position and size of each shape's label(s). The value passed can either be the _String_ name of the behavior to be used for all shapes, or an accessor _Function_ that will be provided each data point and will be expected to return the behavior to be used for that data point. The availability and options for this method depend on the default logic for each Shape. As an example, the values "outside" or "inside" can be set for Bar shapes, whose "auto" default will calculate the best position dynamically based on the available space.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`labelPosition`](#labelposition-5)

<a id="legend-3"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`legend`](#legend-12)

<a id="legendconfig-3"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`legendConfig`](#legendconfig-13)

<a id="legendfilterinvert-3"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`legendFilterInvert`](#legendfilterinvert-11)

<a id="legendpadding-3"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`legendPadding`](#legendpadding-12)

<a id="legendposition-3"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| (() => `string`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| (() => `string`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`legendPosition`](#legendposition-11)

<a id="legendsort-3"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`legendSort`](#legendsort-11)

<a id="legendtooltip-3"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`legendTooltip`](#legendtooltip-11)

<a id="linelabels-3"></a>

##### lineLabels()

> **lineLabels**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2137](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2137)

Draws labels on the right side of any Line shapes that are drawn on the plot.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`lineLabels`](#linelabels-5)

<a id="linemarkerconfig-3"></a>

##### lineMarkerConfig()

> **lineMarkerConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2144](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2144)

Shape config for the Circle shapes drawn by the lineMarkers method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`lineMarkerConfig`](#linemarkerconfig-5)

<a id="linemarkers-3"></a>

##### lineMarkers()

> **lineMarkers**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2153](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2153)

Draws circle markers on each vertex of a Line.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`lineMarkers`](#linemarkers-5)

<a id="loadinghtml-3"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`loadingHTML`](#loadinghtml-11)

<a id="loadingmessage-3"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`loadingMessage`](#loadingmessage-11)

<a id="messagemask-3"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`messageMask`](#messagemask-11)

<a id="messagestyle-3"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`messageStyle`](#messagestyle-11)

<a id="nodatahtml-3"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`noDataHTML`](#nodatahtml-11)

<a id="nodatamessage-3"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`noDataMessage`](#nodatamessage-11)

<a id="render-11"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Plot`](#plot).[`render`](#render-25)

<a id="scrollcontainer-3"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| `HTMLElement` \| `Window` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| `HTMLElement` \| `Window` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`scrollContainer`](#scrollcontainer-11)

<a id="select-11"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

`Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`select`](#select-25)

<a id="shape-8"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`shape`](#shape-17)

<a id="shapeconfig-12"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`shapeConfig`](#shapeconfig-25)

<a id="shapesort-3"></a>

##### shapeSort()

> **shapeSort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2162](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2162)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) that receives each shape Class (ie. "Circle", "Line", etc) as it's comparator arguments. Shapes are drawn in groups based on their type, so you are defining the layering order for all shapes of said type.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`shapeSort`](#shapesort-5)

<a id="size-3"></a>

##### size()

> **size**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2169](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2169)

Sets the size of bubbles to the given Number, data key, or function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`size`](#size-7)

<a id="sizemax-3"></a>

##### sizeMax()

> **sizeMax**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2178)

Sets the size scale maximum to the specified number.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`sizeMax`](#sizemax-6)

<a id="sizemin-3"></a>

##### sizeMin()

> **sizeMin**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2185](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2185)

Sets the size scale minimum to the specified number.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`sizeMin`](#sizemin-6)

<a id="sizescale-3"></a>

##### sizeScale()

> **sizeScale**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2192](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2192)

Sets the size scale to the specified string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`sizeScale`](#sizescale-6)

<a id="stacked-3"></a>

##### stacked()

> **stacked**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2199](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2199)

If *value* is specified, toggles shape stacking. If *value* is not specified, returns the current stack value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`stacked`](#stacked-5)

<a id="stackoffset-3"></a>

##### stackOffset()

> **stackOffset**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2206](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2206)

Sets the stack offset. If *value* is not specified, returns the current stack offset function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`stackOffset`](#stackoffset-5)

<a id="stackorder-3"></a>

##### stackOrder()

> **stackOrder**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2219](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2219)

Sets the stack order. If *value* is not specified, returns the current stack order function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`stackOrder`](#stackorder-5)

<a id="subtitle-3"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`subtitle`](#subtitle-11)

<a id="subtitleconfig-3"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`subtitleConfig`](#subtitleconfig-11)

<a id="subtitlepadding-3"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`subtitlePadding`](#subtitlepadding-11)

<a id="svgdesc-3"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`svgDesc`](#svgdesc-11)

<a id="svgtitle-3"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`svgTitle`](#svgtitle-11)

<a id="threshold-3"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| ((`data`: `DataPoint`[]) => `number`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| ((`data`: `DataPoint`[]) => `number`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`threshold`](#threshold-11)

<a id="thresholdkey-3"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`thresholdKey`](#thresholdkey-11)

<a id="thresholdname-3"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`thresholdName`](#thresholdname-11)

<a id="time-3"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`time`](#time-11)

<a id="timefilter-3"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`timeFilter`](#timefilter-11)

<a id="timeline-3"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`timeline`](#timeline-11)

<a id="timelineconfig-3"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`timelineConfig`](#timelineconfig-11)

<a id="timelinedefault-3"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): `Date`[] \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

`Date`[] \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`timelineDefault`](#timelinedefault-11)

<a id="timelinepadding-3"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`timelinePadding`](#timelinepadding-11)

<a id="title-8"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`title`](#title-17)

<a id="titleconfig-8"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`titleConfig`](#titleconfig-17)

<a id="titlepadding-3"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`titlePadding`](#titlepadding-11)

<a id="tooltip-3"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`tooltip`](#tooltip-11)

<a id="tooltipconfig-3"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`tooltipConfig`](#tooltipconfig-11)

<a id="total-3"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`total`](#total-11)

<a id="totalconfig-3"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`totalConfig`](#totalconfig-11)

<a id="totalformat-3"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): ((`d`: `number`) => `string`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

((`d`: `number`) => `string`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`totalFormat`](#totalformat-11)

<a id="totalpadding-3"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`totalPadding`](#totalpadding-11)

<a id="width-9"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`width`](#width-20)

<a id="x-6"></a>

##### x()

> **x**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2236](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2236)

Accessor function or string key for the x-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x`](#x-13)

<a id="x2-3"></a>

##### x2()

> **x2**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2250)

Accessor function or string key for the secondary x-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x2`](#x2-5)

<a id="x2config-3"></a>

##### x2Config()

> **x2Config**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2280](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2280)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the secondary x-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x2Config`](#x2config-5)

<a id="x2domain-3"></a>

##### x2Domain()

> **x2Domain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2296](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2296)

The x2 domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x2Domain`](#x2domain-5)

<a id="x2sort-3"></a>

##### x2Sort()

> **x2Sort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2310](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2310)

Defines a custom sorting comparitor function to be used for discrete x2 axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x2Sort`](#x2sort-5)

<a id="xconfig-3"></a>

##### xConfig()

> **xConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2264](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2264)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the x-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`xConfig`](#xconfig-5)

<a id="xcutoff-3"></a>

##### xCutoff()

> **xCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2273](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2273)

When the width of the chart is less than or equal to this pixel value, and the x-axis is not the discrete axis, it will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`xCutoff`](#xcutoff-5)

<a id="xdomain-3"></a>

##### xDomain()

> **xDomain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2289](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2289)

The x domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`xDomain`](#xdomain-5)

<a id="xsort-3"></a>

##### xSort()

> **xSort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2303](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2303)

Defines a custom sorting comparitor function to be used for discrete x axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`xSort`](#xsort-5)

<a id="y-6"></a>

##### y()

> **y**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2317](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2317)

Accessor function or string key for the y-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y`](#y-13)

<a id="y2-3"></a>

##### y2()

> **y2**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2331](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2331)

Accessor function or string key for the secondary y-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y2`](#y2-5)

<a id="y2config-3"></a>

##### y2Config()

> **y2Config**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2366](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2366)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the secondary y-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y2Config`](#y2config-5)

<a id="y2domain-3"></a>

##### y2Domain()

> **y2Domain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2385](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2385)

The y2 domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y2Domain`](#y2domain-5)

<a id="y2sort-3"></a>

##### y2Sort()

> **y2Sort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2399](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2399)

Defines a custom sorting comparitor function to be used for discrete y2 axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y2Sort`](#y2sort-5)

<a id="yconfig-3"></a>

##### yConfig()

> **yConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2347](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2347)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the y-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

*Note:* If a "domain" array is passed to the y-axis config, it will be reversed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`yConfig`](#yconfig-5)

<a id="ycutoff-3"></a>

##### yCutoff()

> **yCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2359](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2359)

When the height of the chart is less than or equal to this pixel value, and the y-axis is not the discrete axis, it will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`yCutoff`](#ycutoff-5)

<a id="ydomain-3"></a>

##### yDomain()

> **yDomain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2378](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2378)

The y domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`yDomain`](#ydomain-5)

<a id="ysort-3"></a>

##### ySort()

> **ySort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2392](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2392)

Defines a custom sorting comparitor function to be used for discrete y axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`ySort`](#ysort-5)

<a id="zoom-3"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`zoom`](#zoom-11)

<a id="zoombrushhandlesize-3"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`zoomBrushHandleSize`](#zoombrushhandlesize-11)

<a id="zoombrushhandlestyle-3"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`zoomBrushHandleStyle`](#zoombrushhandlestyle-11)

<a id="zoombrushselectionstyle-3"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`zoomBrushSelectionStyle`](#zoombrushselectionstyle-11)

<a id="zoomcontrolstyle-3"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`zoomControlStyle`](#zoomcontrolstyle-11)

<a id="zoomcontrolstyleactive-3"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`zoomControlStyleActive`](#zoomcontrolstyleactive-11)

<a id="zoomcontrolstylehover-3"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`zoomControlStyleHover`](#zoomcontrolstylehover-11)

<a id="zoomfactor-3"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`zoomFactor`](#zoomfactor-11)

<a id="zoommax-3"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`zoomMax`](#zoommax-11)

<a id="zoompadding-3"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`zoomPadding`](#zoompadding-11)

<a id="zoompan-3"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`zoomPan`](#zoompan-11)

<a id="zoomscroll-3"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`BumpChart`](#bumpchart)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`BumpChart`](#bumpchart)

###### Inherited from

[`Plot`](#plot).[`zoomScroll`](#zoomscroll-11)

***

<a id="circle"></a>

### Circle

Defined in: [shapes/Circle.ts:12](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Circle.ts#L12)

Creates SVG circles based on an array of data.

#### Extends

- [`Shape`](#shape-23)

#### Methods

<a id="_datafilter-1"></a>

##### \_dataFilter()?

> `optional` **\_dataFilter**(`data`: `DataPoint`[]): `DataPoint`[]

Defined in: [shapes/Shape.ts:105](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L105)

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `data` | `DataPoint`[] | The raw data array to filter. |

###### Returns

`DataPoint`[]

###### Inherited from

[`Shape`](#shape-23).[`_dataFilter`](#_datafilter-4)

<a id="active-7"></a>

##### active()

###### Call Signature

> **active**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

Defined in: [shapes/Shape.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1019)

The active callback function for highlighting shapes.

###### Returns

((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

###### Inherited from

[`Shape`](#shape-23).[`active`](#active-25)

###### Call Signature

> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1020](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1020)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`active`](#active-25)

<a id="activeopacity-2"></a>

##### activeOpacity()

###### Call Signature

> **activeOpacity**(): `number`

Defined in: [shapes/Shape.ts:1037](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1037)

When shapes are active, this is the opacity of any shape that is not active.

###### Returns

`number`

###### Inherited from

[`Shape`](#shape-23).[`activeOpacity`](#activeopacity-6)

###### Call Signature

> **activeOpacity**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1038](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1038)

When shapes are active, this is the opacity of any shape that is not active.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`activeOpacity`](#activeopacity-6)

<a id="activestyle-2"></a>

##### activeStyle()

###### Call Signature

> **activeStyle**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1048](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1048)

The style to apply to active shapes.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`activeStyle`](#activestyle-6)

###### Call Signature

> **activeStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1049](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1049)

The style to apply to active shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`activeStyle`](#activestyle-6)

<a id="arialabel-2"></a>

##### ariaLabel()

###### Call Signature

> **ariaLabel**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1059](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1059)

The aria-label attribute for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`ariaLabel`](#arialabel-6)

###### Call Signature

> **ariaLabel**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1060](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1060)

The aria-label attribute for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`ariaLabel`](#arialabel-6)

<a id="backgroundimage-2"></a>

##### backgroundImage()

###### Call Signature

> **backgroundImage**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1070](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1070)

The background-image accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`backgroundImage`](#backgroundimage-6)

###### Call Signature

> **backgroundImage**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1071](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1071)

The background-image accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`backgroundImage`](#backgroundimage-6)

<a id="config-9"></a>

##### config()

###### Call Signature

> **config**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L91)

Methods that correspond to the key/value pairs and returns this class.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`Shape`](#shape-23).[`config`](#config-15)

###### Call Signature

> **config**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L92)

Methods that correspond to the key/value pairs and returns this class.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`config`](#config-15)

<a id="data-12"></a>

##### data()

###### Call Signature

> **data**(): `DataPoint`[]

Defined in: [shapes/Shape.ts:1082](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1082)

The data array used to create shapes. A shape will be drawn for each object in the array.

###### Returns

`DataPoint`[]

###### Inherited from

[`Shape`](#shape-23).[`data`](#data-32)

###### Call Signature

> **data**(`_`: `DataPoint`[]): `this`

Defined in: [shapes/Shape.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1083)

The data array used to create shapes. A shape will be drawn for each object in the array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `DataPoint`[] |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`data`](#data-32)

<a id="discrete-6"></a>

##### discrete()

###### Call Signature

> **discrete**(): `string` \| `undefined`

Defined in: [shapes/Shape.ts:1091](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1091)

Determines if either the X or Y position is discrete along a Line, which helps in determining the nearest data point on a line for a hit area event.

###### Returns

`string` \| `undefined`

###### Inherited from

[`Shape`](#shape-23).[`discrete`](#discrete-23)

###### Call Signature

> **discrete**(`_`: `string`): `this`

Defined in: [shapes/Shape.ts:1092](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1092)

Determines if either the X or Y position is discrete along a Line, which helps in determining the nearest data point on a line for a hit area event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`discrete`](#discrete-23)

<a id="duration-11"></a>

##### duration()

###### Call Signature

> **duration**(): `number`

Defined in: [shapes/Shape.ts:1100](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1100)

The animation duration in milliseconds.

###### Returns

`number`

###### Inherited from

[`Shape`](#shape-23).[`duration`](#duration-31)

###### Call Signature

> **duration**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1101](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1101)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`duration`](#duration-31)

<a id="fill-2"></a>

##### fill()

###### Call Signature

> **fill**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1109](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1109)

The fill color accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`fill`](#fill-6)

###### Call Signature

> **fill**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1110](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1110)

The fill color accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`fill`](#fill-6)

<a id="fillopacity-2"></a>

##### fillOpacity()

###### Call Signature

> **fillOpacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1120](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1120)

Defines the "fill-opacity" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`fillOpacity`](#fillopacity-6)

###### Call Signature

> **fillOpacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1121](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1121)

Defines the "fill-opacity" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`fillOpacity`](#fillopacity-6)

<a id="hitarea-2"></a>

##### hitArea()

###### Call Signature

> **hitArea**(): ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) \| `null`

Defined in: [shapes/Shape.ts:1180](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1180)

The mouse hit area accessor function.

###### Returns

((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) \| `null`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`hitArea`](#hitarea-6)

###### Call Signature

> **hitArea**(`_`: `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>)): `this`

Defined in: [shapes/Shape.ts:1187](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1187)

The mouse hit area accessor function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) |

###### Returns

`this`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`hitArea`](#hitarea-6)

<a id="hover-7"></a>

##### hover()

###### Call Signature

> **hover**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

Defined in: [shapes/Shape.ts:1131](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1131)

The hover callback function for highlighting shapes on mouseover.

###### Returns

((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

###### Inherited from

[`Shape`](#shape-23).[`hover`](#hover-25)

###### Call Signature

> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1132](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1132)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`hover`](#hover-25)

<a id="hoveropacity-2"></a>

##### hoverOpacity()

###### Call Signature

> **hoverOpacity**(): `number`

Defined in: [shapes/Shape.ts:1160](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1160)

The opacity of non-hovered shapes when any shape is hovered.

###### Returns

`number`

###### Inherited from

[`Shape`](#shape-23).[`hoverOpacity`](#hoveropacity-6)

###### Call Signature

> **hoverOpacity**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1161](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1161)

The opacity of non-hovered shapes when any shape is hovered.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`hoverOpacity`](#hoveropacity-6)

<a id="hoverstyle-2"></a>

##### hoverStyle()

###### Call Signature

> **hoverStyle**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1149](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1149)

The style to apply to hovered shapes.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`hoverStyle`](#hoverstyle-6)

###### Call Signature

> **hoverStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1150)

The style to apply to hovered shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`hoverStyle`](#hoverstyle-6)

<a id="id-2"></a>

##### id()

###### Call Signature

> **id**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1220](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1220)

The unique id accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`id`](#id-8)

###### Call Signature

> **id**(`_`: `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1221](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1221)

The unique id accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`id`](#id-8)

<a id="label-6"></a>

##### label()

###### Call Signature

> **label**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1229](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1229)

The text label accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`label`](#label-24)

###### Call Signature

> **label**(`_`: `string` \| `string`[] \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1230](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1230)

The text label accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `string`[] \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`label`](#label-24)

<a id="labelbounds-2"></a>

##### labelBounds()

###### Call Signature

> **labelBounds**(): ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null`

Defined in: [shapes/Shape.ts:1251](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1251)

The label bounds accessor function.

###### Returns

((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`labelBounds`](#labelbounds-6)

###### Call Signature

> **labelBounds**(`_`: `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`)): `this`

Defined in: [shapes/Shape.ts:1258](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1258)

The label bounds accessor function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) |

###### Returns

`this`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`labelBounds`](#labelbounds-6)

<a id="labelconfig-2"></a>

##### labelConfig()

###### Call Signature

> **labelConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1291](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1291)

A pass-through to the config method of the TextBox class used to create a shape's labels.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`labelConfig`](#labelconfig-7)

###### Call Signature

> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1292](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1292)

A pass-through to the config method of the TextBox class used to create a shape's labels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`labelConfig`](#labelconfig-7)

<a id="locale-9"></a>

##### locale()

###### Call Signature

> **locale**(): `string`

Defined in: [utils/BaseClass.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L156)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Returns

`string`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Shape`](#shape-23).[`locale`](#locale-15)

###### Call Signature

> **locale**(`_`: `string` \| `object`): `this`

Defined in: [utils/BaseClass.ts:157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L157)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `object` |

###### Returns

`this`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Shape`](#shape-23).[`locale`](#locale-15)

<a id="on-9"></a>

##### on()

###### Call Signature

> **on**(): `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

Defined in: [utils/BaseClass.ts:176](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L176)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Returns

`Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

###### Call Signature

> **on**(`_`: `string`): ((...`args`: `unknown`[]) => `unknown`) \| `undefined`

Defined in: [utils/BaseClass.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L177)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

((...`args`: `unknown`[]) => `unknown`) \| `undefined`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

###### Call Signature

> **on**(`_`: `string`, `f`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [utils/BaseClass.ts:178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L178)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |
| `f` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

###### Call Signature

> **on**(`_`: `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:179](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L179)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

<a id="opacity-2"></a>

##### opacity()

###### Call Signature

> **opacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1302](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1302)

The opacity accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`opacity`](#opacity-7)

###### Call Signature

> **opacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1303](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1303)

The opacity accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`opacity`](#opacity-7)

<a id="parent-9"></a>

##### parent()

###### Call Signature

> **parent**(): `Record`\<`string`, `unknown`\>

Defined in: [utils/BaseClass.ts:200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L200)

Parent config used by the wrapper.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`parent`](#parent-15)

###### Call Signature

> **parent**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L201)

Parent config used by the wrapper.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`parent`](#parent-15)

<a id="pointerevents-2"></a>

##### pointerEvents()

###### Call Signature

> **pointerEvents**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1313](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1313)

The pointer-events CSS property for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`pointerEvents`](#pointerevents-7)

###### Call Signature

> **pointerEvents**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1314](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1314)

The pointer-events CSS property for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`pointerEvents`](#pointerevents-7)

<a id="r"></a>

##### r()

###### Call Signature

> **r**(): `AccessorFn`

Defined in: [shapes/Circle.ts:113](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Circle.ts#L113)

The radius accessor for each circle.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.r;
}
```

###### Call Signature

> **r**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Circle.ts:114](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Circle.ts#L114)

The radius accessor for each circle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.r;
}
```

<a id="render-12"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [shapes/Circle.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Circle.ts#L64)

Draws the circles.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Overrides

[`Shape`](#shape-23).[`render`](#render-32)

<a id="role-2"></a>

##### role()

###### Call Signature

> **role**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1325](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1325)

The role attribute.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`role`](#role-6)

###### Call Signature

> **role**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1326](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1326)

The role attribute.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`role`](#role-6)

<a id="rotate-2"></a>

##### rotate()

###### Call Signature

> **rotate**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1336](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1336)

The rotation angle in degrees for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`rotate`](#rotate-6)

###### Call Signature

> **rotate**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1337](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1337)

The rotation angle in degrees for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`rotate`](#rotate-6)

<a id="rx-2"></a>

##### rx()

###### Call Signature

> **rx**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1347](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1347)

Defines the "rx" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`rx`](#rx-6)

###### Call Signature

> **rx**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1348](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1348)

Defines the "rx" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`rx`](#rx-6)

<a id="ry-2"></a>

##### ry()

###### Call Signature

> **ry**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1358](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1358)

Defines the "rx" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`ry`](#ry-6)

###### Call Signature

> **ry**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1359](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1359)

Defines the "rx" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`ry`](#ry-6)

<a id="scale-7"></a>

##### scale()

###### Call Signature

> **scale**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1369](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1369)

The scale transform accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`scale`](#scale-12)

###### Call Signature

> **scale**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1370](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1370)

The scale transform accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`scale`](#scale-12)

<a id="select-12"></a>

##### select()

###### Call Signature

> **select**(): `Selection`

Defined in: [shapes/Shape.ts:1380](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1380)

The SVG container element as a d3 selector or DOM element.

###### Returns

`Selection`

###### Inherited from

[`Shape`](#shape-23).[`select`](#select-32)

###### Call Signature

> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`

Defined in: [shapes/Shape.ts:1381](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1381)

The SVG container element as a d3 selector or DOM element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `HTMLElement` \| `SVGElement` \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`select`](#select-32)

<a id="shapeconfig-13"></a>

##### shapeConfig()

###### Call Signature

> **shapeConfig**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L225)

Configuration object with key/value pairs applied as method calls on each shape.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`Shape`](#shape-23).[`shapeConfig`](#shapeconfig-33)

###### Call Signature

> **shapeConfig**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:226](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L226)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`shapeConfig`](#shapeconfig-33)

<a id="shaperendering-2"></a>

##### shapeRendering()

###### Call Signature

> **shapeRendering**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1396](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1396)

The shape-rendering.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`shapeRendering`](#shaperendering-6)

###### Call Signature

> **shapeRendering**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1397)

The shape-rendering.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`shapeRendering`](#shaperendering-6)

<a id="sort-2"></a>

##### sort()

###### Call Signature

> **sort**(): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`

Defined in: [shapes/Shape.ts:1408](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1408)

A comparator function used to sort shapes for layering order.

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`

###### Inherited from

[`Shape`](#shape-23).[`sort`](#sort-9)

###### Call Signature

> **sort**(`_`: ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1409](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1409)

A comparator function used to sort shapes for layering order.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`sort`](#sort-9)

<a id="stroke-2"></a>

##### stroke()

###### Call Signature

> **stroke**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1419](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1419)

The stroke color accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`stroke`](#stroke-6)

###### Call Signature

> **stroke**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1420](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1420)

The stroke color accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`stroke`](#stroke-6)

<a id="strokedasharray-2"></a>

##### strokeDasharray()

###### Call Signature

> **strokeDasharray**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1430](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1430)

Defines the "stroke-dasharray" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeDasharray`](#strokedasharray-6)

###### Call Signature

> **strokeDasharray**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1431](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1431)

Defines the "stroke-dasharray" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeDasharray`](#strokedasharray-6)

<a id="strokelinecap-2"></a>

##### strokeLinecap()

###### Call Signature

> **strokeLinecap**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1442](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1442)

Defines the "stroke-linecap" attribute for the shapes. Accepted values are `"butt"`, `"round"`, and `"square"`.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeLinecap`](#strokelinecap-6)

###### Call Signature

> **strokeLinecap**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1443](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1443)

Defines the "stroke-linecap" attribute for the shapes. Accepted values are `"butt"`, `"round"`, and `"square"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeLinecap`](#strokelinecap-6)

<a id="strokeopacity-2"></a>

##### strokeOpacity()

###### Call Signature

> **strokeOpacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1454](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1454)

Defines the "stroke-opacity" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeOpacity`](#strokeopacity-6)

###### Call Signature

> **strokeOpacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1455](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1455)

Defines the "stroke-opacity" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeOpacity`](#strokeopacity-6)

<a id="strokewidth-2"></a>

##### strokeWidth()

###### Call Signature

> **strokeWidth**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1466](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1466)

The stroke-width.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeWidth`](#strokewidth-6)

###### Call Signature

> **strokeWidth**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1467](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1467)

The stroke-width.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeWidth`](#strokewidth-6)

<a id="textanchor-2"></a>

##### textAnchor()

###### Call Signature

> **textAnchor**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1477](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1477)

The text-anchor.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`textAnchor`](#textanchor-6)

###### Call Signature

> **textAnchor**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1478](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1478)

The text-anchor.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`textAnchor`](#textanchor-6)

<a id="texture-2"></a>

##### texture()

###### Call Signature

> **texture**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1488](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1488)

Defines the texture used inside of each shape. This uses the [textures.js](https://riccardoscalco.it/textures/) package, and expects either a simple string (`"lines"` or `"circles"`) or a more complex Object containing the various properties of the texture (ie. `{texture: "lines", orientation: "3/8", stroke: "darkorange"}`). If multiple textures are necessary, provide an accsesor Function that returns the correct String/Object for each given data point and index.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`texture`](#texture-6)

###### Call Signature

> **texture**(`_`: `string` \| `Record`\<`string`, `unknown`\> \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1489](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1489)

Defines the texture used inside of each shape. This uses the [textures.js](https://riccardoscalco.it/textures/) package, and expects either a simple string (`"lines"` or `"circles"`) or a more complex Object containing the various properties of the texture (ie. `{texture: "lines", orientation: "3/8", stroke: "darkorange"}`). If multiple textures are necessary, provide an accsesor Function that returns the correct String/Object for each given data point and index.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `Record`\<`string`, `unknown`\> \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`texture`](#texture-6)

<a id="texturedefault-2"></a>

##### textureDefault()

###### Call Signature

> **textureDefault**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1503)

A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`textureDefault`](#texturedefault-6)

###### Call Signature

> **textureDefault**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1504](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1504)

A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`textureDefault`](#texturedefault-6)

<a id="translate-9"></a>

##### translate()

###### Call Signature

> **translate**(): (`d`: `string`, `locale?`: `string`) => `string`

Defined in: [utils/BaseClass.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L214)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Returns

(`d`: `string`, `locale?`: `string`) => `string`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Shape`](#shape-23).[`translate`](#translate-15)

###### Call Signature

> **translate**(`_`: (`d`: `string`, `locale?`: `string`) => `string`): `this`

Defined in: [utils/BaseClass.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L215)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `string`, `locale?`: `string`) => `string` |

###### Returns

`this`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Shape`](#shape-23).[`translate`](#translate-15)

<a id="vectoreffect-2"></a>

##### vectorEffect()

###### Call Signature

> **vectorEffect**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1514](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1514)

The vector-effect.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`vectorEffect`](#vectoreffect-6)

###### Call Signature

> **vectorEffect**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1515](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1515)

The vector-effect.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`vectorEffect`](#vectoreffect-6)

<a id="verticalalign-2"></a>

##### verticalAlign()

###### Call Signature

> **verticalAlign**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1525](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1525)

The vertical alignment.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`verticalAlign`](#verticalalign-7)

###### Call Signature

> **verticalAlign**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1526](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1526)

The vertical alignment.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`verticalAlign`](#verticalalign-7)

<a id="x-7"></a>

##### x()

###### Call Signature

> **x**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1542](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1542)

The x position accessor for each shape.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`x`](#x-15)

###### Call Signature

> **x**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1543)

The x position accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`x`](#x-15)

<a id="y-7"></a>

##### y()

###### Call Signature

> **y**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1558](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1558)

The y position accessor for each shape.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.y;
}
```

###### Inherited from

[`Shape`](#shape-23).[`y`](#y-15)

###### Call Signature

> **y**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1559](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1559)

The y position accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.y;
}
```

###### Inherited from

[`Shape`](#shape-23).[`y`](#y-15)

#### Properties

| Property | Type | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="property-_active-2"></a> `_active` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | - | [`Shape`](#shape-23).[`_active`](#property-_active-6) | [shapes/Shape.ts:116](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L116) |
| <a id="property-_activegroup-2"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-23).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:112](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L112) |
| <a id="property-_activeopacity-2"></a> `_activeOpacity` | `number` | - | [`Shape`](#shape-23).[`_activeOpacity`](#property-_activeopacity-6) | [shapes/Shape.ts:57](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L57) |
| <a id="property-_activestyle-2"></a> `_activeStyle` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_activeStyle`](#property-_activestyle-6) | [shapes/Shape.ts:58](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L58) |
| <a id="property-_arialabel-2"></a> `_ariaLabel` | `AccessorFn` | - | [`Shape`](#shape-23).[`_ariaLabel`](#property-_arialabel-6) | [shapes/Shape.ts:59](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L59) |
| <a id="property-_backgroundimage-2"></a> `_backgroundImage` | `AccessorFn` | - | [`Shape`](#shape-23).[`_backgroundImage`](#property-_backgroundimage-6) | [shapes/Shape.ts:60](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L60) |
| <a id="property-_backgroundimageclass-2"></a> `_backgroundImageClass` | [`Image`](#image) | - | [`Shape`](#shape-23).[`_backgroundImageClass`](#property-_backgroundimageclass-6) | [shapes/Shape.ts:61](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L61) |
| <a id="property-_configdefault-9"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | - | [`Shape`](#shape-23).[`_configDefault`](#property-_configdefault-15) | [utils/BaseClass.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L69) |
| <a id="property-_curve-2"></a> `_curve` | `AccessorFn` | - | [`Shape`](#shape-23).[`_curve`](#property-_curve-6) | [shapes/Shape.ts:121](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L121) |
| <a id="property-_data-8"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-23).[`_data`](#property-_data-15) | [shapes/Shape.ts:62](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L62) |
| <a id="property-_defined-2"></a> `_defined` | `AccessorFn` | - | [`Shape`](#shape-23).[`_defined`](#property-_defined-6) | [shapes/Shape.ts:120](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L120) |
| <a id="property-_discrete-2"></a> `_discrete` | `string` \| *required* | - | [`Shape`](#shape-23).[`_discrete`](#property-_discrete-6) | [shapes/Shape.ts:118](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L118) |
| <a id="property-_duration-8"></a> `_duration` | `number` | - | [`Shape`](#shape-23).[`_duration`](#property-_duration-15) | [shapes/Shape.ts:63](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L63) |
| <a id="property-_enter-2"></a> `_enter` | `Selection` | - | [`Shape`](#shape-23).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:109](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L109) |
| <a id="property-_exit-2"></a> `_exit` | `Selection` | - | [`Shape`](#shape-23).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:110](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L110) |
| <a id="property-_fill-2"></a> `_fill` | `AccessorFn` | - | [`Shape`](#shape-23).[`_fill`](#property-_fill-6) | [shapes/Shape.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L64) |
| <a id="property-_fillopacity-2"></a> `_fillOpacity` | `AccessorFn` | - | [`Shape`](#shape-23).[`_fillOpacity`](#property-_fillopacity-6) | [shapes/Shape.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L65) |
| <a id="property-_group-7"></a> `_group` | `Selection` | - | [`Shape`](#shape-23).[`_group`](#property-_group-13) | [shapes/Shape.ts:107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L107) |
| <a id="property-_hitarea-2"></a> `_hitArea` | ((`d`: `DataPoint`, `i`: `number`, `aes`: `ShapeAes`) => `Record`\<`string`, `unknown`\>) \| `null` | - | [`Shape`](#shape-23).[`_hitArea`](#property-_hitarea-6) | [shapes/Shape.ts:113](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L113) |
| <a id="property-_hover-2"></a> `_hover` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | - | [`Shape`](#shape-23).[`_hover`](#property-_hover-6) | [shapes/Shape.ts:117](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L117) |
| <a id="property-_hovergroup-2"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-23).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:111](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L111) |
| <a id="property-_hoveropacity-2"></a> `_hoverOpacity` | `number` | - | [`Shape`](#shape-23).[`_hoverOpacity`](#property-_hoveropacity-6) | [shapes/Shape.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L66) |
| <a id="property-_hoverstyle-2"></a> `_hoverStyle` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_hoverStyle`](#property-_hoverstyle-6) | [shapes/Shape.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L67) |
| <a id="property-_id-2"></a> `_id` | `AccessorFn` | - | [`Shape`](#shape-23).[`_id`](#property-_id-8) | [shapes/Shape.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L68) |
| <a id="property-_label-2"></a> `_label` | `AccessorFn` | - | [`Shape`](#shape-23).[`_label`](#property-_label-7) | [shapes/Shape.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L69) |
| <a id="property-_labelbounds-2"></a> `_labelBounds` | ((`d`: `DataPoint`, `i`: `number`, `aes`: `ShapeAes`) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null` | [`Shape`](#shape-23).[`_labelBounds`](#property-_labelbounds-6) | - | [shapes/Circle.ts:13](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Circle.ts#L13) |
| <a id="property-_labelclass-2"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-23).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L70) |
| <a id="property-_labelconfig-2"></a> `_labelConfig` | `Record`\<`string`, `unknown`\> | [`Shape`](#shape-23).[`_labelConfig`](#property-_labelconfig-7) | - | [shapes/Circle.ts:20](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Circle.ts#L20) |
| <a id="property-_locale-9"></a> `_locale` | `string` | - | [`Shape`](#shape-23).[`_locale`](#property-_locale-15) | [utils/BaseClass.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L64) |
| <a id="property-_name-2"></a> `_name` | `string` | [`Shape`](#shape-23).[`_name`](#property-_name-6) | - | [shapes/Circle.ts:21](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Circle.ts#L21) |
| <a id="property-_on-9"></a> `_on` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | - | [`Shape`](#shape-23).[`_on`](#property-_on-15) | [utils/BaseClass.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L65) |
| <a id="property-_opacity-2"></a> `_opacity` | `AccessorFn` | - | [`Shape`](#shape-23).[`_opacity`](#property-_opacity-7) | [shapes/Shape.ts:80](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L80) |
| <a id="property-_parent-9"></a> `_parent` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_parent`](#property-_parent-15) | [utils/BaseClass.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L66) |
| <a id="property-_path-2"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_path`](#property-_path-6) | [shapes/Shape.ts:119](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L119) |
| <a id="property-_pointerevents-2"></a> `_pointerEvents` | `AccessorFn` | - | [`Shape`](#shape-23).[`_pointerEvents`](#property-_pointerevents-7) | [shapes/Shape.ts:81](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L81) |
| <a id="property-_r"></a> `_r` | `AccessorFn` | - | - | [shapes/Circle.ts:22](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Circle.ts#L22) |
| <a id="property-_role-2"></a> `_role` | `AccessorFn` | - | [`Shape`](#shape-23).[`_role`](#property-_role-6) | [shapes/Shape.ts:82](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L82) |
| <a id="property-_rotate-2"></a> `_rotate` | `AccessorFn` | - | [`Shape`](#shape-23).[`_rotate`](#property-_rotate-6) | [shapes/Shape.ts:83](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L83) |
| <a id="property-_rx-2"></a> `_rx` | `AccessorFn` | - | [`Shape`](#shape-23).[`_rx`](#property-_rx-6) | [shapes/Shape.ts:84](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L84) |
| <a id="property-_ry-2"></a> `_ry` | `AccessorFn` | - | [`Shape`](#shape-23).[`_ry`](#property-_ry-6) | [shapes/Shape.ts:85](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L85) |
| <a id="property-_scale-7"></a> `_scale` | `AccessorFn` | - | [`Shape`](#shape-23).[`_scale`](#property-_scale-12) | [shapes/Shape.ts:86](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L86) |
| <a id="property-_select-8"></a> `_select` | `Selection` | - | [`Shape`](#shape-23).[`_select`](#property-_select-15) | [shapes/Shape.ts:102](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L102) |
| <a id="property-_shapeconfig-9"></a> `_shapeConfig?` | [`D3plusConfig`](#d3plusconfig) | - | [`Shape`](#shape-23).[`_shapeConfig`](#property-_shapeconfig-15) | [utils/BaseClass.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L70) |
| <a id="property-_shaperendering-2"></a> `_shapeRendering` | `AccessorFn` | - | [`Shape`](#shape-23).[`_shapeRendering`](#property-_shaperendering-6) | [shapes/Shape.ts:87](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L87) |
| <a id="property-_sort-2"></a> `_sort` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | - | [`Shape`](#shape-23).[`_sort`](#property-_sort-6) | [shapes/Shape.ts:106](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L106) |
| <a id="property-_stroke-2"></a> `_stroke` | `AccessorFn` | - | [`Shape`](#shape-23).[`_stroke`](#property-_stroke-6) | [shapes/Shape.ts:88](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L88) |
| <a id="property-_strokedasharray-2"></a> `_strokeDasharray` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeDasharray`](#property-_strokedasharray-6) | [shapes/Shape.ts:89](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L89) |
| <a id="property-_strokelinecap-2"></a> `_strokeLinecap` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeLinecap`](#property-_strokelinecap-6) | [shapes/Shape.ts:90](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L90) |
| <a id="property-_strokeopacity-2"></a> `_strokeOpacity` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeOpacity`](#property-_strokeopacity-6) | [shapes/Shape.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L91) |
| <a id="property-_strokewidth-2"></a> `_strokeWidth` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeWidth`](#property-_strokewidth-6) | [shapes/Shape.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L92) |
| <a id="property-_tagname-2"></a> `_tagName` | `string` | - | [`Shape`](#shape-23).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:93](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L93) |
| <a id="property-_textanchor-2"></a> `_textAnchor` | `AccessorFn` | - | [`Shape`](#shape-23).[`_textAnchor`](#property-_textanchor-6) | [shapes/Shape.ts:94](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L94) |
| <a id="property-_texture-2"></a> `_texture` | `AccessorFn` | - | [`Shape`](#shape-23).[`_texture`](#property-_texture-6) | [shapes/Shape.ts:95](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L95) |
| <a id="property-_texturedefault-2"></a> `_textureDefault` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_textureDefault`](#property-_texturedefault-6) | [shapes/Shape.ts:96](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L96) |
| <a id="property-_texturedefs-2"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-23).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:97](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L97) |
| <a id="property-_transition-7"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-23).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:103](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L103) |
| <a id="property-_translate-9"></a> `_translate` | (`d`: `string`, `locale?`: `string`) => `string` | - | [`Shape`](#shape-23).[`_translate`](#property-_translate-15) | [utils/BaseClass.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L67) |
| <a id="property-_update-2"></a> `_update` | `Selection` | - | [`Shape`](#shape-23).[`_update`](#property-_update-6) | [shapes/Shape.ts:108](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L108) |
| <a id="property-_uuid-9"></a> `_uuid` | `string` | - | [`Shape`](#shape-23).[`_uuid`](#property-_uuid-15) | [utils/BaseClass.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L68) |
| <a id="property-_vectoreffect-2"></a> `_vectorEffect` | `AccessorFn` | - | [`Shape`](#shape-23).[`_vectorEffect`](#property-_vectoreffect-6) | [shapes/Shape.ts:98](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L98) |
| <a id="property-_verticalalign-2"></a> `_verticalAlign` | `AccessorFn` | - | [`Shape`](#shape-23).[`_verticalAlign`](#property-_verticalalign-7) | [shapes/Shape.ts:99](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L99) |
| <a id="property-_x-3"></a> `_x` | `AccessorFn` | - | [`Shape`](#shape-23).[`_x`](#property-_x-8) | [shapes/Shape.ts:100](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L100) |
| <a id="property-_y-3"></a> `_y` | `AccessorFn` | - | [`Shape`](#shape-23).[`_y`](#property-_y-8) | [shapes/Shape.ts:101](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L101) |

***

<a id="colorscale-4"></a>

### ColorScale

Defined in: [components/ColorScale.ts:25](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L25)

Creates an SVG color scale based on an array of data.

#### Extends

- [`BaseClass`](#baseclass)

#### Methods

<a id="align-5"></a>

##### align()

###### Call Signature

> **align**(): `string`

Defined in: [components/ColorScale.ts:802](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L802)

The horizontal alignment.

###### Returns

`string`

###### Call Signature

> **align**(`_`: `string`): `this`

Defined in: [components/ColorScale.ts:803](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L803)

The horizontal alignment.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="axisconfig-1"></a>

##### axisConfig()

###### Call Signature

> **axisConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/ColorScale.ts:791](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L791)

The [ColorScale](http://d3plus.org/docs/#ColorScale) is constructed by combining an [Axis](http://d3plus.org/docs/#Axis) for the ticks/labels and a [Rect](http://d3plus.org/docs/#Rect) for the actual color box (or multiple boxes, as in a jenks scale). Because of this, there are separate configs for the [Axis](http://d3plus.org/docs/#Axis) class used to display the text ([axisConfig](http://d3plus.org/docs/#ColorScale.axisConfig)) and the [Rect](http://d3plus.org/docs/#Rect) class used to draw the color breaks ([rectConfig](http://d3plus.org/docs/#ColorScale.rectConfig)). This method acts as a pass-through to the config method of the [Axis](http://d3plus.org/docs/#Axis). An example usage of this method can be seen [here](http://d3plus.org/examples/d3plus-legend/colorScale-dark/).

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **axisConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/ColorScale.ts:792](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L792)

The [ColorScale](http://d3plus.org/docs/#ColorScale) is constructed by combining an [Axis](http://d3plus.org/docs/#Axis) for the ticks/labels and a [Rect](http://d3plus.org/docs/#Rect) for the actual color box (or multiple boxes, as in a jenks scale). Because of this, there are separate configs for the [Axis](http://d3plus.org/docs/#Axis) class used to display the text ([axisConfig](http://d3plus.org/docs/#ColorScale.axisConfig)) and the [Rect](http://d3plus.org/docs/#Rect) class used to draw the color breaks ([rectConfig](http://d3plus.org/docs/#ColorScale.rectConfig)). This method acts as a pass-through to the config method of the [Axis](http://d3plus.org/docs/#Axis). An example usage of this method can be seen [here](http://d3plus.org/examples/d3plus-legend/colorScale-dark/).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="bucketaxis"></a>

##### bucketAxis()

###### Call Signature

> **bucketAxis**(): `boolean`

Defined in: [components/ColorScale.ts:820](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L820)

Determines whether or not to use an Axis to display bucket scales (both "buckets" and "jenks"). When set to `false`, bucketed scales will use the `Legend` class to display squares for each range of data. When set to `true`, bucketed scales will be displayed on an `Axis`, similar to "linear" scales.

###### Returns

`boolean`

###### Call Signature

> **bucketAxis**(`_`: `boolean`): `this`

Defined in: [components/ColorScale.ts:821](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L821)

Determines whether or not to use an Axis to display bucket scales (both "buckets" and "jenks"). When set to `false`, bucketed scales will use the `Legend` class to display squares for each range of data. When set to `true`, bucketed scales will be displayed on an `Axis`, similar to "linear" scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

<a id="bucketformat"></a>

##### bucketFormat()

###### Call Signature

> **bucketFormat**(): (`tick`: `number`, `i`: `number`, `ticks`: `number`[], `allValues`: `number`[]) => `string`

Defined in: [components/ColorScale.ts:831](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L831)

A function for formatting the labels associated to each bucket in a bucket-type scale ("jenks", "quantile", etc). The function is passed four arguments: the start value of the current bucket, it's index in the full Array of buckets, the full Array of buckets, and an Array of every value present in the data used to construct the buckets. Keep in mind that the end value for the bucket is not actually the next bucket in the list, but includes every value up until that next bucket value (less than, but not equal to). By default, d3plus will make the end value slightly less than it's current value, so that it does not overlap with the start label for the next bucket.

###### Returns

(`tick`: `number`, `i`: `number`, `ticks`: `number`[], `allValues`: `number`[]) => `string`

###### Call Signature

> **bucketFormat**(`_`: (`tick`: `number`, `i`: `number`, `ticks`: `number`[], `allValues`: `number`[]) => `string`): `this`

Defined in: [components/ColorScale.ts:837](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L837)

A function for formatting the labels associated to each bucket in a bucket-type scale ("jenks", "quantile", etc). The function is passed four arguments: the start value of the current bucket, it's index in the full Array of buckets, the full Array of buckets, and an Array of every value present in the data used to construct the buckets. Keep in mind that the end value for the bucket is not actually the next bucket in the list, but includes every value up until that next bucket value (less than, but not equal to). By default, d3plus will make the end value slightly less than it's current value, so that it does not overlap with the start label for the next bucket.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`tick`: `number`, `i`: `number`, `ticks`: `number`[], `allValues`: `number`[]) => `string` |

###### Returns

`this`

<a id="bucketjoiner"></a>

##### bucketJoiner()

###### Call Signature

> **bucketJoiner**(): (`a`: `string`, `b`: `string`) => `string`

Defined in: [components/ColorScale.ts:861](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L861)

A function that receives the minimum and maximum values of a bucket, and is expected to return the full label.

###### Returns

(`a`: `string`, `b`: `string`) => `string`

###### Call Signature

> **bucketJoiner**(`_`: (`a`: `string`, `b`: `string`) => `string`): `this`

Defined in: [components/ColorScale.ts:862](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L862)

A function that receives the minimum and maximum values of a bucket, and is expected to return the full label.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`a`: `string`, `b`: `string`) => `string` |

###### Returns

`this`

<a id="buckets"></a>

##### buckets()

###### Call Signature

> **buckets**(): `number` \| `number`[]

Defined in: [components/ColorScale.ts:811](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L811)

The number of discrete buckets to create in a bucketed color scale. Will be overridden by any custom Array of colors passed to the `color` method. Optionally, users can supply an Array of values used to separate buckets, such as `[0, 10, 25, 50, 90]` for a percentage scale. This value would create 4 buckets, with each value representing the break point between each bucket (so 5 values makes 4 buckets).

###### Returns

`number` \| `number`[]

###### Call Signature

> **buckets**(`_`: `number` \| `number`[]): `this`

Defined in: [components/ColorScale.ts:812](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L812)

The number of discrete buckets to create in a bucketed color scale. Will be overridden by any custom Array of colors passed to the `color` method. Optionally, users can supply an Array of values used to separate buckets, such as `[0, 10, 25, 50, 90]` for a percentage scale. This value would create 4 buckets, with each value representing the break point between each bucket (so 5 values makes 4 buckets).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `number`[] |

###### Returns

`this`

<a id="centered"></a>

##### centered()

###### Call Signature

> **centered**(): `boolean`

Defined in: [components/ColorScale.ts:872](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L872)

Determines whether or not to display a midpoint centered Axis. Does not apply to quantile scales.

###### Returns

`boolean`

###### Call Signature

> **centered**(`_`: `boolean`): `this`

Defined in: [components/ColorScale.ts:873](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L873)

Determines whether or not to display a midpoint centered Axis. Does not apply to quantile scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

<a id="color-4"></a>

##### color()

###### Call Signature

> **color**(): `string` \| `string`[]

Defined in: [components/ColorScale.ts:881](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L881)

Overrides the default internal logic of `colorMin`, `colorMid`, and `colorMax` to only use just this specified color. If a single color is given as a String, then the scale is interpolated by lightening that color. Otherwise, the function expects an Array of color values to be used in order for the scale.

###### Returns

`string` \| `string`[]

###### Call Signature

> **color**(`_`: `string` \| `string`[]): `this`

Defined in: [components/ColorScale.ts:882](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L882)

Overrides the default internal logic of `colorMin`, `colorMid`, and `colorMax` to only use just this specified color. If a single color is given as a String, then the scale is interpolated by lightening that color. Otherwise, the function expects an Array of color values to be used in order for the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `string`[] |

###### Returns

`this`

<a id="colormax"></a>

##### colorMax()

###### Call Signature

> **colorMax**(): `string`

Defined in: [components/ColorScale.ts:890](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L890)

Defines the color to be used for numbers greater than the value of the `midpoint` on the scale (defaults to `0`). Colors in between this value and the value of `colorMid` will be interpolated, unless a custom Array of colors has been specified using the `color` method.

###### Returns

`string`

###### Call Signature

> **colorMax**(`_`: `string`): `this`

Defined in: [components/ColorScale.ts:891](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L891)

Defines the color to be used for numbers greater than the value of the `midpoint` on the scale (defaults to `0`). Colors in between this value and the value of `colorMid` will be interpolated, unless a custom Array of colors has been specified using the `color` method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="colormid"></a>

##### colorMid()

###### Call Signature

> **colorMid**(): `string`

Defined in: [components/ColorScale.ts:899](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L899)

Defines the color to be used for the midpoint of a diverging scale, based on the current value of the `midpoint` method (defaults to `0`). Colors in between this value and the values of `colorMin` and `colorMax` will be interpolated, unless a custom Array of colors has been specified using the `color` method.

###### Returns

`string`

###### Call Signature

> **colorMid**(`_`: `string`): `this`

Defined in: [components/ColorScale.ts:900](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L900)

Defines the color to be used for the midpoint of a diverging scale, based on the current value of the `midpoint` method (defaults to `0`). Colors in between this value and the values of `colorMin` and `colorMax` will be interpolated, unless a custom Array of colors has been specified using the `color` method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="colormin"></a>

##### colorMin()

###### Call Signature

> **colorMin**(): `string`

Defined in: [components/ColorScale.ts:908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L908)

Defines the color to be used for numbers less than the value of the `midpoint` on the scale (defaults to `0`). Colors in between this value and the value of `colorMid` will be interpolated, unless a custom Array of colors has been specified using the `color` method.

###### Returns

`string`

###### Call Signature

> **colorMin**(`_`: `string`): `this`

Defined in: [components/ColorScale.ts:909](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L909)

Defines the color to be used for numbers less than the value of the `midpoint` on the scale (defaults to `0`). Colors in between this value and the value of `colorMid` will be interpolated, unless a custom Array of colors has been specified using the `color` method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="config-10"></a>

##### config()

###### Call Signature

> **config**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L91)

Methods that correspond to the key/value pairs and returns this class.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`BaseClass`](#baseclass).[`config`](#config-7)

###### Call Signature

> **config**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L92)

Methods that correspond to the key/value pairs and returns this class.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`config`](#config-7)

<a id="data-13"></a>

##### data()

###### Call Signature

> **data**(): `DataPoint`[]

Defined in: [components/ColorScale.ts:917](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L917)

The data array used to create shapes. A shape key will be drawn for each object in the array.

###### Returns

`DataPoint`[]

###### Call Signature

> **data**(`_`: `DataPoint`[]): `this`

Defined in: [components/ColorScale.ts:918](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L918)

The data array used to create shapes. A shape key will be drawn for each object in the array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `DataPoint`[] |

###### Returns

`this`

<a id="domain-5"></a>

##### domain()

###### Call Signature

> **domain**(): `number`[] \| `undefined`

Defined in: [components/ColorScale.ts:926](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L926)

In a linear scale, this Array of 2 values defines the min and max values used in the color scale. Any values outside of this range will be mapped to the nearest color value.

###### Returns

`number`[] \| `undefined`

###### Call Signature

> **domain**(`_`: `number`[]): `this`

Defined in: [components/ColorScale.ts:927](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L927)

In a linear scale, this Array of 2 values defines the min and max values used in the color scale. Any values outside of this range will be mapped to the nearest color value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number`[] |

###### Returns

`this`

<a id="duration-12"></a>

##### duration()

###### Call Signature

> **duration**(): `number`

Defined in: [components/ColorScale.ts:935](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L935)

Transition duration of the ColorScale.

###### Returns

`number`

###### Call Signature

> **duration**(`_`: `number`): `this`

Defined in: [components/ColorScale.ts:936](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L936)

Transition duration of the ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="height-10"></a>

##### height()

###### Call Signature

> **height**(): `number`

Defined in: [components/ColorScale.ts:944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L944)

Overall height of the ColorScale.

###### Returns

`number`

###### Call Signature

> **height**(`_`: `number`): `this`

Defined in: [components/ColorScale.ts:945](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L945)

Overall height of the ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="labelconfig-3"></a>

##### labelConfig()

###### Call Signature

> **labelConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/ColorScale.ts:953](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L953)

A pass-through for the [TextBox](http://d3plus.org/docs/#TextBox) class used to style the labelMin and labelMax text.

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/ColorScale.ts:954](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L954)

A pass-through for the [TextBox](http://d3plus.org/docs/#TextBox) class used to style the labelMin and labelMax text.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="labelmax"></a>

##### labelMax()

###### Call Signature

> **labelMax**(): `string` \| `undefined`

Defined in: [components/ColorScale.ts:973](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L973)

Defines a text label to be displayed off of the end of the maximum point in the scale (currently only available in horizontal orientation).

###### Returns

`string` \| `undefined`

###### Call Signature

> **labelMax**(`_`: `string`): `this`

Defined in: [components/ColorScale.ts:974](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L974)

Defines a text label to be displayed off of the end of the maximum point in the scale (currently only available in horizontal orientation).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="labelmin"></a>

##### labelMin()

###### Call Signature

> **labelMin**(): `string` \| `undefined`

Defined in: [components/ColorScale.ts:964](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L964)

Defines a text label to be displayed off of the end of the minimum point in the scale (currently only available in horizontal orientation).

###### Returns

`string` \| `undefined`

###### Call Signature

> **labelMin**(`_`: `string`): `this`

Defined in: [components/ColorScale.ts:965](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L965)

Defines a text label to be displayed off of the end of the minimum point in the scale (currently only available in horizontal orientation).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="legendconfig-4"></a>

##### legendConfig()

###### Call Signature

> **legendConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/ColorScale.ts:982](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L982)

The [ColorScale](http://d3plus.org/docs/#ColorScale) is constructed by combining an [Axis](http://d3plus.org/docs/#Axis) for the ticks/labels and a [Rect](http://d3plus.org/docs/#Rect) for the actual color box (or multiple boxes, as in a jenks scale). Because of this, there are separate configs for the [Axis](http://d3plus.org/docs/#Axis) class used to display the text ([axisConfig](http://d3plus.org/docs/#ColorScale.axisConfig)) and the [Rect](http://d3plus.org/docs/#Rect) class used to draw the color breaks ([rectConfig](http://d3plus.org/docs/#ColorScale.rectConfig)). This method acts as a pass-through to the config method of the [Axis](http://d3plus.org/docs/#Axis). An example usage of this method can be seen [here](http://d3plus.org/examples/d3plus-legend/colorScale-dark/).

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **legendConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/ColorScale.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L983)

The [ColorScale](http://d3plus.org/docs/#ColorScale) is constructed by combining an [Axis](http://d3plus.org/docs/#Axis) for the ticks/labels and a [Rect](http://d3plus.org/docs/#Rect) for the actual color box (or multiple boxes, as in a jenks scale). Because of this, there are separate configs for the [Axis](http://d3plus.org/docs/#Axis) class used to display the text ([axisConfig](http://d3plus.org/docs/#ColorScale.axisConfig)) and the [Rect](http://d3plus.org/docs/#Rect) class used to draw the color breaks ([rectConfig](http://d3plus.org/docs/#ColorScale.rectConfig)). This method acts as a pass-through to the config method of the [Axis](http://d3plus.org/docs/#Axis). An example usage of this method can be seen [here](http://d3plus.org/examples/d3plus-legend/colorScale-dark/).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="locale-10"></a>

##### locale()

###### Call Signature

> **locale**(): `string`

Defined in: [utils/BaseClass.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L156)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Returns

`string`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`BaseClass`](#baseclass).[`locale`](#locale-7)

###### Call Signature

> **locale**(`_`: `string` \| `object`): `this`

Defined in: [utils/BaseClass.ts:157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L157)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `object` |

###### Returns

`this`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`BaseClass`](#baseclass).[`locale`](#locale-7)

<a id="midpoint"></a>

##### midpoint()

###### Call Signature

> **midpoint**(): `number`

Defined in: [components/ColorScale.ts:993](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L993)

The number value to be used as the anchor for `colorMid`, and defines the center point of the diverging color scale.

###### Returns

`number`

###### Call Signature

> **midpoint**(`_`: `number`): `this`

Defined in: [components/ColorScale.ts:994](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L994)

The number value to be used as the anchor for `colorMid`, and defines the center point of the diverging color scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="on-10"></a>

##### on()

###### Call Signature

> **on**(): `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

Defined in: [utils/BaseClass.ts:176](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L176)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Returns

`Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `string`): ((...`args`: `unknown`[]) => `unknown`) \| `undefined`

Defined in: [utils/BaseClass.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L177)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

((...`args`: `unknown`[]) => `unknown`) \| `undefined`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `string`, `f`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [utils/BaseClass.ts:178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L178)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |
| `f` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:179](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L179)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

<a id="orient-6"></a>

##### orient()

###### Call Signature

> **orient**(): `string`

Defined in: [components/ColorScale.ts:1002](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L1002)

The flow orientation of the ColorScale items.

###### Returns

`string`

###### Call Signature

> **orient**(`_`: `string`): `this`

Defined in: [components/ColorScale.ts:1003](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L1003)

The flow orientation of the ColorScale items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="outerbounds-5"></a>

##### outerBounds()

> **outerBounds**(): `Record`\<`string`, `number`\>

Defined in: [components/ColorScale.ts:1013](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L1013)

Returns the outer bounds of the ColorScale content. Must be called after rendering.

###### Returns

`Record`\<`string`, `number`\>

###### Example

```ts
{"width": 180, "height": 24, "x": 10, "y": 20}
```

<a id="padding-5"></a>

##### padding()

###### Call Signature

> **padding**(): `number`

Defined in: [components/ColorScale.ts:1020](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L1020)

The padding between each key.

###### Returns

`number`

###### Call Signature

> **padding**(`_`: `number`): `this`

Defined in: [components/ColorScale.ts:1021](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L1021)

The padding between each key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="parent-10"></a>

##### parent()

###### Call Signature

> **parent**(): `Record`\<`string`, `unknown`\>

Defined in: [utils/BaseClass.ts:200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L200)

Parent config used by the wrapper.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`BaseClass`](#baseclass).[`parent`](#parent-7)

###### Call Signature

> **parent**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L201)

Parent config used by the wrapper.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`parent`](#parent-7)

<a id="rectconfig-1"></a>

##### rectConfig()

###### Call Signature

> **rectConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/ColorScale.ts:1029](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L1029)

The [ColorScale](http://d3plus.org/docs/#ColorScale) is constructed by combining an [Axis](http://d3plus.org/docs/#Axis) for the ticks/labels and a [Rect](http://d3plus.org/docs/#Rect) for the actual color box (or multiple boxes, as in a jenks scale). Because of this, there are separate configs for the [Axis](http://d3plus.org/docs/#Axis) class used to display the text ([axisConfig](http://d3plus.org/docs/#ColorScale.axisConfig)) and the [Rect](http://d3plus.org/docs/#Rect) class used to draw the color breaks ([rectConfig](http://d3plus.org/docs/#ColorScale.rectConfig)). This method acts as a pass-through to the config method of the [Rect](http://d3plus.org/docs/#Rect). An example usage of this method can be seen [here](http://d3plus.org/examples/d3plus-legend/colorScale-dark/).

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **rectConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/ColorScale.ts:1030](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L1030)

The [ColorScale](http://d3plus.org/docs/#ColorScale) is constructed by combining an [Axis](http://d3plus.org/docs/#Axis) for the ticks/labels and a [Rect](http://d3plus.org/docs/#Rect) for the actual color box (or multiple boxes, as in a jenks scale). Because of this, there are separate configs for the [Axis](http://d3plus.org/docs/#Axis) class used to display the text ([axisConfig](http://d3plus.org/docs/#ColorScale.axisConfig)) and the [Rect](http://d3plus.org/docs/#Rect) class used to draw the color breaks ([rectConfig](http://d3plus.org/docs/#ColorScale.rectConfig)). This method acts as a pass-through to the config method of the [Rect](http://d3plus.org/docs/#Rect). An example usage of this method can be seen [here](http://d3plus.org/examples/d3plus-legend/colorScale-dark/).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="render-13"></a>

##### render()

> **render**(`callback?`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [components/ColorScale.ts:187](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L187)

Renders the current ColorScale to the page.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | (...`args`: `unknown`[]) => `unknown` | Optional callback invoked after rendering completes. |

###### Returns

`this`

<a id="scale-8"></a>

##### scale()

###### Call Signature

> **scale**(): `string`

Defined in: [components/ColorScale.ts:1040](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L1040)

Scale of the ColorScale.

###### Returns

`string`

###### Call Signature

> **scale**(`_`: `string`): `this`

Defined in: [components/ColorScale.ts:1041](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L1041)

Scale of the ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="select-13"></a>

##### select()

###### Call Signature

> **select**(): `Selection`

Defined in: [components/ColorScale.ts:1049](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L1049)

The SVG container element for this visualization. 3 selector or DOM element.

###### Returns

`Selection`

###### Call Signature

> **select**(`_`: `string` \| `HTMLElement`): `this`

Defined in: [components/ColorScale.ts:1050](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L1050)

The SVG container element for this visualization. 3 selector or DOM element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `HTMLElement` |

###### Returns

`this`

<a id="shapeconfig-14"></a>

##### shapeConfig()

###### Call Signature

> **shapeConfig**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L225)

Configuration object with key/value pairs applied as method calls on each shape.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`BaseClass`](#baseclass).[`shapeConfig`](#shapeconfig-9)

###### Call Signature

> **shapeConfig**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:226](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L226)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`shapeConfig`](#shapeconfig-9)

<a id="size-4"></a>

##### size()

###### Call Signature

> **size**(): `number`

Defined in: [components/ColorScale.ts:1060](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L1060)

The height of horizontal color scales, and width when positioned vertical.

###### Returns

`number`

###### Call Signature

> **size**(`_`: `number`): `this`

Defined in: [components/ColorScale.ts:1061](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L1061)

The height of horizontal color scales, and width when positioned vertical.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="translate-10"></a>

##### translate()

###### Call Signature

> **translate**(): (`d`: `string`, `locale?`: `string`) => `string`

Defined in: [utils/BaseClass.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L214)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Returns

(`d`: `string`, `locale?`: `string`) => `string`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`translate`](#translate-7)

###### Call Signature

> **translate**(`_`: (`d`: `string`, `locale?`: `string`) => `string`): `this`

Defined in: [utils/BaseClass.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L215)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `string`, `locale?`: `string`) => `string` |

###### Returns

`this`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`translate`](#translate-7)

<a id="value"></a>

##### value()

###### Call Signature

> **value**(): (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

Defined in: [components/ColorScale.ts:1074](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L1074)

The value accessor used to determine each data point's position on the color scale.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

###### Example

```ts
function value(d) {
return d.value;
}
```

###### Call Signature

> **value**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `this`

Defined in: [components/ColorScale.ts:1075](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L1075)

The value accessor used to determine each data point's position on the color scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`this`

###### Example

```ts
function value(d) {
return d.value;
}
```

<a id="width-10"></a>

##### width()

###### Call Signature

> **width**(): `number`

Defined in: [components/ColorScale.ts:1089](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L1089)

Overall width of the ColorScale.

###### Returns

`number`

###### Call Signature

> **width**(`_`: `number`): `this`

Defined in: [components/ColorScale.ts:1090](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L1090)

Overall width of the ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

#### Properties

| Property | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="property-_align-5"></a> `_align` | `string` | - | [components/ColorScale.ts:31](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L31) |
| <a id="property-_axisclass"></a> `_axisClass` | [`Axis`](#axis) | - | [components/ColorScale.ts:27](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L27) |
| <a id="property-_axisconfig"></a> `_axisConfig` | `Record`\<`string`, `unknown`\> | - | [components/ColorScale.ts:29](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L29) |
| <a id="property-_axistest"></a> `_axisTest` | [`Axis`](#axis) | - | [components/ColorScale.ts:30](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L30) |
| <a id="property-_bucketaxis"></a> `_bucketAxis` | `boolean` | - | [components/ColorScale.ts:33](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L33) |
| <a id="property-_bucketformat"></a> `_bucketFormat` | (`tick`: `number`, `i`: `number`, `ticks`: `number`[], `allValues`: `number`[]) => `string` | - | [components/ColorScale.ts:34](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L34) |
| <a id="property-_bucketjoiner"></a> `_bucketJoiner` | (`a`: `string`, `b`: `string`) => `string` | - | [components/ColorScale.ts:40](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L40) |
| <a id="property-_buckets"></a> `_buckets` | `number` \| `number`[] | - | [components/ColorScale.ts:32](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L32) |
| <a id="property-_centered"></a> `_centered` | `boolean` | - | [components/ColorScale.ts:41](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L41) |
| <a id="property-_color"></a> `_color` | `string` \| `string`[] | - | [components/ColorScale.ts:42](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L42) |
| <a id="property-_colormax"></a> `_colorMax` | `string` | - | [components/ColorScale.ts:43](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L43) |
| <a id="property-_colormid"></a> `_colorMid` | `string` | - | [components/ColorScale.ts:44](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L44) |
| <a id="property-_colormin"></a> `_colorMin` | `string` | - | [components/ColorScale.ts:45](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L45) |
| <a id="property-_colorscale"></a> `_colorScale` | `any` | - | [components/ColorScale.ts:48](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L48) |
| <a id="property-_configdefault-10"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | [`BaseClass`](#baseclass).[`_configDefault`](#property-_configdefault-7) | [utils/BaseClass.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L69) |
| <a id="property-_data-9"></a> `_data` | `DataPoint`[] | - | [components/ColorScale.ts:49](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L49) |
| <a id="property-_domain-5"></a> `_domain` | `number`[] \| *required* | - | [components/ColorScale.ts:50](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L50) |
| <a id="property-_duration-9"></a> `_duration` | `number` | - | [components/ColorScale.ts:51](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L51) |
| <a id="property-_group-8"></a> `_group` | `Selection` | - | [components/ColorScale.ts:52](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L52) |
| <a id="property-_height-6"></a> `_height` | `number` | - | [components/ColorScale.ts:53](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L53) |
| <a id="property-_labelclass-3"></a> `_labelClass` | [`TextBox`](#textbox) | - | [components/ColorScale.ts:54](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L54) |
| <a id="property-_labelconfig-3"></a> `_labelConfig` | `Record`\<`string`, `unknown`\> | - | [components/ColorScale.ts:56](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L56) |
| <a id="property-_labelmax"></a> `_labelMax` | `string` \| *required* | - | [components/ColorScale.ts:58](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L58) |
| <a id="property-_labelmin"></a> `_labelMin` | `string` \| *required* | - | [components/ColorScale.ts:57](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L57) |
| <a id="property-_legendclass"></a> `_legendClass` | [`Legend`](#legend-6) | - | [components/ColorScale.ts:59](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L59) |
| <a id="property-_legendconfig"></a> `_legendConfig` | `Record`\<`string`, `unknown`\> | - | [components/ColorScale.ts:61](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L61) |
| <a id="property-_locale-10"></a> `_locale` | `string` | [`BaseClass`](#baseclass).[`_locale`](#property-_locale-7) | [utils/BaseClass.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L64) |
| <a id="property-_midpoint"></a> `_midpoint` | `number` | - | [components/ColorScale.ts:62](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L62) |
| <a id="property-_on-10"></a> `_on` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | [`BaseClass`](#baseclass).[`_on`](#property-_on-7) | [utils/BaseClass.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L65) |
| <a id="property-_orient-6"></a> `_orient` | `string` | - | [components/ColorScale.ts:63](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L63) |
| <a id="property-_outerbounds-5"></a> `_outerBounds` | `Record`\<`string`, `number`\> | - | [components/ColorScale.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L64) |
| <a id="property-_padding-5"></a> `_padding` | `number` | - | [components/ColorScale.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L65) |
| <a id="property-_parent-10"></a> `_parent` | `Record`\<`string`, `unknown`\> | [`BaseClass`](#baseclass).[`_parent`](#property-_parent-7) | [utils/BaseClass.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L66) |
| <a id="property-_rectclass"></a> `_rectClass` | [`Rect`](#rect) | - | [components/ColorScale.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L66) |
| <a id="property-_rectconfig-1"></a> `_rectConfig` | `Record`\<`string`, `unknown`\> | - | [components/ColorScale.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L68) |
| <a id="property-_scale-8"></a> `_scale` | `string` | - | [components/ColorScale.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L69) |
| <a id="property-_select-9"></a> `_select` | `Selection` | - | [components/ColorScale.ts:26](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L26) |
| <a id="property-_shapeconfig-10"></a> `_shapeConfig?` | [`D3plusConfig`](#d3plusconfig) | [`BaseClass`](#baseclass).[`_shapeConfig`](#property-_shapeconfig-7) | [utils/BaseClass.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L70) |
| <a id="property-_size"></a> `_size` | `number` | - | [components/ColorScale.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L70) |
| <a id="property-_translate-10"></a> `_translate` | (`d`: `string`, `locale?`: `string`) => `string` | [`BaseClass`](#baseclass).[`_translate`](#property-_translate-7) | [utils/BaseClass.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L67) |
| <a id="property-_uuid-10"></a> `_uuid` | `string` | [`BaseClass`](#baseclass).[`_uuid`](#property-_uuid-7) | [utils/BaseClass.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L68) |
| <a id="property-_value"></a> `_value` | (`d`: `DataPoint`, `i?`: `number`) => `unknown` | - | [components/ColorScale.ts:72](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L72) |
| <a id="property-_width-6"></a> `_width` | `number` | - | [components/ColorScale.ts:73](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/ColorScale.ts#L73) |

***

<a id="donut"></a>

### Donut

Defined in: [charts/Donut.ts:7](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Donut.ts#L7)

Extends the Pie visualization to create a donut chart.

#### Extends

- [`Pie`](#pie)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-8"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`active`](#active-17)

<a id="aggs-4"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`aggs`](#aggs-10)

<a id="ariahidden-4"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`ariaHidden`](#ariahidden-10)

<a id="attribution-4"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`attribution`](#attribution-10)

<a id="attributionstyle-4"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`attributionStyle`](#attributionstyle-10)

<a id="backconfig-4"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`backConfig`](#backconfig-10)

<a id="cache-4"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`cache`](#cache-10)

<a id="color-5"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`color`](#color-11)

<a id="colorscale-5"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`colorScale`](#colorscale-11)

<a id="colorscaleconfig-5"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`colorScaleConfig`](#colorscaleconfig-11)

<a id="colorscalemaxsize-4"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`colorScaleMaxSize`](#colorscalemaxsize-10)

<a id="colorscalepadding-5"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`colorScalePadding`](#colorscalepadding-11)

<a id="colorscaleposition-4"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`colorScalePosition`](#colorscaleposition-10)

<a id="data-14"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): `DataPoint`[] \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

`DataPoint`[] \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`data`](#data-24)

<a id="datacutoff-4"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`dataCutoff`](#datacutoff-10)

<a id="depth-4"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`depth`](#depth-10)

<a id="destroy-4"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

###### Inherited from

[`Pie`](#pie).[`destroy`](#destroy-10)

<a id="detectresize-4"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`detectResize`](#detectresize-10)

<a id="detectresizedelay-4"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`detectResizeDelay`](#detectresizedelay-10)

<a id="detectvisible-4"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`detectVisible`](#detectvisible-10)

<a id="detectvisibleinterval-4"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`detectVisibleInterval`](#detectvisibleinterval-10)

<a id="discrete-7"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`discrete`](#discrete-15)

<a id="downloadbutton-4"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`downloadButton`](#downloadbutton-10)

<a id="downloadconfig-4"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`downloadConfig`](#downloadconfig-10)

<a id="downloadposition-4"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`downloadPosition`](#downloadposition-10)

<a id="duration-13"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`duration`](#duration-23)

<a id="filter-4"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`filter`](#filter-10)

<a id="fontfamily-4"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| `string`[] \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| `string`[] \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`fontFamily`](#fontfamily-10)

<a id="groupby-4"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

(`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`groupBy`](#groupby-10)

<a id="height-11"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`height`](#height-19)

<a id="hiddencolor-4"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`hiddenColor`](#hiddencolor-10)

<a id="hiddenopacity-4"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`hiddenOpacity`](#hiddenopacity-10)

<a id="hover-8"></a>

##### hover()

> **hover**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `this`

Defined in: [charts/Viz.ts:1350](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1350)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`this`

###### Inherited from

[`Pie`](#pie).[`hover`](#hover-17)

<a id="innerradius"></a>

##### innerRadius()

> **innerRadius**(`_?`: `number` \| (() => `number`)): `number` \| [`Donut`](#donut) \| (() => `number`)

Defined in: [charts/Pie.ts:107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Pie.ts#L107)

The pixel value, or function that returns a pixel value, that is used as the inner radius of the Pie (creating a Donut).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| (() => `number`) |

###### Returns

`number` \| [`Donut`](#donut) \| (() => `number`)

###### Inherited from

[`Pie`](#pie).[`innerRadius`](#innerradius-1)

<a id="label-7"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`label`](#label-16)

<a id="legend-4"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`legend`](#legend-11)

<a id="legendconfig-5"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`legendConfig`](#legendconfig-12)

<a id="legendfilterinvert-4"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`legendFilterInvert`](#legendfilterinvert-10)

<a id="legendpadding-4"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`legendPadding`](#legendpadding-11)

<a id="legendposition-4"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| (() => `string`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| (() => `string`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`legendPosition`](#legendposition-10)

<a id="legendsort-4"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`legendSort`](#legendsort-10)

<a id="legendtooltip-4"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`legendTooltip`](#legendtooltip-10)

<a id="loadinghtml-4"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`loadingHTML`](#loadinghtml-10)

<a id="loadingmessage-4"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`loadingMessage`](#loadingmessage-10)

<a id="messagemask-4"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`messageMask`](#messagemask-10)

<a id="messagestyle-4"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`messageStyle`](#messagestyle-10)

<a id="nodatahtml-4"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`noDataHTML`](#nodatahtml-10)

<a id="nodatamessage-4"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`noDataMessage`](#nodatamessage-10)

<a id="padangle"></a>

##### padAngle()

> **padAngle**(`_?`: `number`): `number` \| [`Donut`](#donut)

Defined in: [charts/Pie.ts:118](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Pie.ts#L118)

The padding between each arc, set as a radian value between `0` and `1`.

If set, this will override any previously set padPixel value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`padAngle`](#padangle-1)

<a id="padpixel"></a>

##### padPixel()

> **padPixel**(`_?`: `number`): `number` \| [`Donut`](#donut)

Defined in: [charts/Pie.ts:129](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Pie.ts#L129)

The padding between each arc, set as a pixel number value.

By default the value is `0`, which shows no padding between each arc.

If `padAngle` is defined, the `padPixel` value will not be considered.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`padPixel`](#padpixel-1)

<a id="render-14"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Pie`](#pie).[`render`](#render-24)

<a id="scrollcontainer-4"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| `HTMLElement` \| `Window` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| `HTMLElement` \| `Window` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`scrollContainer`](#scrollcontainer-10)

<a id="select-14"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

`Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`select`](#select-24)

<a id="shape-9"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`shape`](#shape-16)

<a id="shapeconfig-15"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`shapeConfig`](#shapeconfig-24)

<a id="sort-3"></a>

##### sort()

> **sort**(`_?`: (...`args`: `unknown`[]) => `unknown`): [`Donut`](#donut) \| ((...`args`: `unknown`[]) => `unknown`)

Defined in: [charts/Pie.ts:136](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Pie.ts#L136)

A comparator function that sorts the Pie slices.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

[`Donut`](#donut) \| ((...`args`: `unknown`[]) => `unknown`)

###### Inherited from

[`Pie`](#pie).[`sort`](#sort-7)

<a id="subtitle-4"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`subtitle`](#subtitle-10)

<a id="subtitleconfig-4"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`subtitleConfig`](#subtitleconfig-10)

<a id="subtitlepadding-4"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`subtitlePadding`](#subtitlepadding-10)

<a id="svgdesc-4"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`svgDesc`](#svgdesc-10)

<a id="svgtitle-4"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`svgTitle`](#svgtitle-10)

<a id="threshold-4"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`threshold`](#threshold-10)

<a id="thresholdkey-4"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`thresholdKey`](#thresholdkey-10)

<a id="thresholdname-4"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`thresholdName`](#thresholdname-10)

<a id="time-4"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`time`](#time-10)

<a id="timefilter-4"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`timeFilter`](#timefilter-10)

<a id="timeline-4"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`timeline`](#timeline-10)

<a id="timelineconfig-4"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`timelineConfig`](#timelineconfig-10)

<a id="timelinedefault-4"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): `Date`[] \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

`Date`[] \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`timelineDefault`](#timelinedefault-10)

<a id="timelinepadding-4"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`timelinePadding`](#timelinepadding-10)

<a id="title-9"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`title`](#title-16)

<a id="titleconfig-9"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`titleConfig`](#titleconfig-16)

<a id="titlepadding-4"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`titlePadding`](#titlepadding-10)

<a id="tooltip-4"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`tooltip`](#tooltip-10)

<a id="tooltipconfig-4"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`tooltipConfig`](#tooltipconfig-10)

<a id="total-4"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`total`](#total-10)

<a id="totalconfig-4"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`totalConfig`](#totalconfig-10)

<a id="totalformat-4"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): ((`d`: `number`) => `string`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

((`d`: `number`) => `string`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`totalFormat`](#totalformat-10)

<a id="totalpadding-4"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`totalPadding`](#totalpadding-10)

<a id="value-1"></a>

##### value()

> **value**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| [`Donut`](#donut) \| ((`d`: `DataPoint`, `i`: `number`) => `number`)

Defined in: [charts/Pie.ts:143](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Pie.ts#L143)

The accessor key for each data point used to calculate the size of each Pie section.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| [`Donut`](#donut) \| ((`d`: `DataPoint`, `i`: `number`) => `number`)

###### Inherited from

[`Pie`](#pie).[`value`](#value-2)

<a id="width-11"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`width`](#width-19)

<a id="zoom-4"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`zoom`](#zoom-10)

<a id="zoombrushhandlesize-4"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`zoomBrushHandleSize`](#zoombrushhandlesize-10)

<a id="zoombrushhandlestyle-4"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`zoomBrushHandleStyle`](#zoombrushhandlestyle-10)

<a id="zoombrushselectionstyle-4"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`zoomBrushSelectionStyle`](#zoombrushselectionstyle-10)

<a id="zoomcontrolstyle-4"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`zoomControlStyle`](#zoomcontrolstyle-10)

<a id="zoomcontrolstyleactive-4"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`zoomControlStyleActive`](#zoomcontrolstyleactive-10)

<a id="zoomcontrolstylehover-4"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`zoomControlStyleHover`](#zoomcontrolstylehover-10)

<a id="zoomfactor-4"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`zoomFactor`](#zoomfactor-10)

<a id="zoommax-4"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`zoomMax`](#zoommax-10)

<a id="zoompadding-4"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`zoomPadding`](#zoompadding-10)

<a id="zoompan-4"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`zoomPan`](#zoompan-10)

<a id="zoomscroll-4"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`Donut`](#donut)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Donut`](#donut)

###### Inherited from

[`Pie`](#pie).[`zoomScroll`](#zoomscroll-10)

***

<a id="geomap"></a>

### Geomap

Defined in: [charts/Geomap.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Geomap.ts#L65)

Creates a geographical map with zooming, panning, image tiles, and the ability to layer choropleth paths and coordinate points. See [this example](https://d3plus.org/examples/d3plus-geomap/getting-started/) for help getting started.

#### Extends

- [`Viz`](#viz)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-9"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`active`](#active-29)

<a id="aggs-5"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`aggs`](#aggs-20)

<a id="ariahidden-5"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`ariaHidden`](#ariahidden-21)

<a id="attribution-5"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`attribution`](#attribution-20)

<a id="attributionstyle-5"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`attributionStyle`](#attributionstyle-20)

<a id="backconfig-5"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`backConfig`](#backconfig-20)

<a id="cache-5"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`cache`](#cache-20)

<a id="color-6"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`color`](#color-21)

<a id="colorscale-6"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`colorScale`](#colorscale-21)

<a id="colorscaleconfig-6"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`colorScaleConfig`](#colorscaleconfig-21)

<a id="colorscalemaxsize-5"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`colorScaleMaxSize`](#colorscalemaxsize-20)

<a id="colorscalepadding-6"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`colorScalePadding`](#colorscalepadding-21)

<a id="colorscaleposition-5"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`colorScalePosition`](#colorscaleposition-20)

<a id="data-15"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): `DataPoint`[] \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

`DataPoint`[] \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`data`](#data-39)

<a id="datacutoff-5"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`dataCutoff`](#datacutoff-20)

<a id="depth-5"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`depth`](#depth-20)

<a id="destroy-5"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`destroy`](#destroy-20)

<a id="detectresize-5"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`detectResize`](#detectresize-20)

<a id="detectresizedelay-5"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`detectResizeDelay`](#detectresizedelay-20)

<a id="detectvisible-5"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`detectVisible`](#detectvisible-20)

<a id="detectvisibleinterval-5"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`detectVisibleInterval`](#detectvisibleinterval-20)

<a id="discrete-8"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`discrete`](#discrete-27)

<a id="downloadbutton-5"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`downloadButton`](#downloadbutton-20)

<a id="downloadconfig-5"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`downloadConfig`](#downloadconfig-20)

<a id="downloadposition-5"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`downloadPosition`](#downloadposition-20)

<a id="duration-14"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`duration`](#duration-37)

<a id="filter-5"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`filter`](#filter-20)

<a id="fitfilter"></a>

##### fitFilter()

> **fitFilter**(`_?`: `string` \| `string`[] \| ((`d`: `Record`\<`string`, `unknown`\>) => `boolean`)): [`Geomap`](#geomap) \| ((`d`: `Record`\<`string`, `unknown`\>) => `boolean`)

Defined in: [charts/Geomap.ts:570](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Geomap.ts#L570)

Topojson files sometimes include small geographies that negatively impact how the library determines the default zoom level (for example, a small island or territory far off the coast that is barely visible to the eye). The fitFilter method can be used to remove specific geographies from the logic used to determine the zooming.

The *value* passed can be a single id to remove, an array of ids, or a filter function. Take a look at the [Choropleth Example](http://d3plus.org/examples/d3plus-geomap/getting-started/) to see it in action.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] \| ((`d`: `Record`\<`string`, `unknown`\>) => `boolean`) |

###### Returns

[`Geomap`](#geomap) \| ((`d`: `Record`\<`string`, `unknown`\>) => `boolean`)

<a id="fitkey"></a>

##### fitKey()

> **fitKey**(`_?`: `string`): `string` \| [`Geomap`](#geomap)

Defined in: [charts/Geomap.ts:591](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Geomap.ts#L591)

If the topojson being used to determine the zoom fit (either the main [topojson](#Geomap.topojson) object or the [fitObject](#Geomap.fitObject)) contains multiple geographical sets (for example, a file containing state and county boundaries), use this method to indentify which set to use for the zoom fit.

If not specified, the first key in the *Array* returned from using `Object.keys` on the topojson will be used.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Geomap`](#geomap)

<a id="fitobject"></a>

##### fitObject()

> **fitObject**(`_?`: `string` \| `Record`\<`string`, `unknown`\>, `f?`: (`data`: `unknown`) => `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Geomap.ts:607](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Geomap.ts#L607)

The topojson to be used for the initial projection [fit extent](https://github.com/d3/d3-geo#projection_fitExtent). The value passed should either be a valid Topojson *Object* or a *String* representing a filepath or URL to be loaded.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function needs to return the final Topojson *Object*.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `Record`\<`string`, `unknown`\> | *required* |
| `f?` | (`data`: `unknown`) => `Record`\<`string`, `unknown`\> | Topojson data or a URL to load. |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

<a id="fontfamily-5"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| `string`[] \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| `string`[] \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`fontFamily`](#fontfamily-21)

<a id="groupby-5"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

(`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`groupBy`](#groupby-20)

<a id="height-12"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`height`](#height-33)

<a id="hiddencolor-5"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`hiddenColor`](#hiddencolor-20)

<a id="hiddenopacity-5"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`hiddenOpacity`](#hiddenopacity-20)

<a id="hover-9"></a>

##### hover()

> **hover**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `this`

Defined in: [charts/Viz.ts:1350](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1350)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`hover`](#hover-29)

<a id="label-8"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`label`](#label-28)

<a id="legend-5"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`legend`](#legend-21)

<a id="legendconfig-6"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`legendConfig`](#legendconfig-22)

<a id="legendfilterinvert-5"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`legendFilterInvert`](#legendfilterinvert-20)

<a id="legendpadding-5"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`legendPadding`](#legendpadding-21)

<a id="legendposition-5"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| (() => `string`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| (() => `string`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`legendPosition`](#legendposition-20)

<a id="legendsort-5"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`legendSort`](#legendsort-20)

<a id="legendtooltip-5"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`legendTooltip`](#legendtooltip-20)

<a id="loadinghtml-5"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`loadingHTML`](#loadinghtml-20)

<a id="loadingmessage-5"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`loadingMessage`](#loadingmessage-20)

<a id="messagemask-5"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`messageMask`](#messagemask-20)

<a id="messagestyle-5"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`messageStyle`](#messagestyle-20)

<a id="nodatahtml-5"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`noDataHTML`](#nodatahtml-20)

<a id="nodatamessage-5"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`noDataMessage`](#nodatamessage-20)

<a id="ocean"></a>

##### ocean()

> **ocean**(`_?`: `string`): `string` \| [`Geomap`](#geomap)

Defined in: [charts/Geomap.ts:623](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Geomap.ts#L623)

The color visible behind any shapes drawn on the map projection. By default, a color value matching the color used in the map tiles is used to help mask the loading time needed to render the tiles. Any value CSS color value may be used, including hexidecimal, rgb, rgba, and color strings like `"blue"` and `"transparent"`.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` | "#d4dadc"] |

###### Returns

`string` \| [`Geomap`](#geomap)

<a id="point"></a>

##### point()

> **point**(`_?`: ((`d`: `DataPoint`, `i`: `number`) => `number`[]) \| `number`[]): [`Geomap`](#geomap) \| ((`d`: `DataPoint`, `i`: `number`) => `number`[])

Defined in: [charts/Geomap.ts:630](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Geomap.ts#L630)

The accessor to be used when detecting coordinate points in the objects passed to the [data](https://d3plus.org/docs/#Viz.data) method. Values are expected to be in the format `[longitude, latitude]`, which is in-line with d3's expected coordinate mapping.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | ((`d`: `DataPoint`, `i`: `number`) => `number`[]) \| `number`[] |

###### Returns

[`Geomap`](#geomap) \| ((`d`: `DataPoint`, `i`: `number`) => `number`[])

<a id="pointsize"></a>

##### pointSize()

> **pointSize**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| [`Geomap`](#geomap) \| ((`d`: `DataPoint`, `i`: `number`) => `number`)

Defined in: [charts/Geomap.ts:641](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Geomap.ts#L641)

The accessor or static value to be used for sizing coordinate points.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| [`Geomap`](#geomap) \| ((`d`: `DataPoint`, `i`: `number`) => `number`)

<a id="pointsizemax"></a>

##### pointSizeMax()

> **pointSizeMax**(`_?`: `number`): `number` \| [`Geomap`](#geomap)

Defined in: [charts/Geomap.ts:653](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Geomap.ts#L653)

The maximum pixel radius used in the scale for sizing coordinate points.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `number` | 10] |

###### Returns

`number` \| [`Geomap`](#geomap)

<a id="pointsizemin"></a>

##### pointSizeMin()

> **pointSizeMin**(`_?`: `number`): `number` \| [`Geomap`](#geomap)

Defined in: [charts/Geomap.ts:663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Geomap.ts#L663)

The minimum pixel radius used in the scale for sizing coordinate points.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `number` | 5] |

###### Returns

`number` \| [`Geomap`](#geomap)

<a id="projection"></a>

##### projection()

> **projection**(`_?`: `string` \| ((...`args`: `unknown`[]) => `unknown`)): [`Geomap`](#geomap) \| ((...`args`: `unknown`[]) => `unknown`)

Defined in: [charts/Geomap.ts:673](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Geomap.ts#L673)

The map projection used when displaying topojson and coordinate points. All projections from [d3-geo](https://github.com/d3/d3-geo#projections), [d3-geo-projection](https://github.com/d3/d3-geo-projection#api-reference), and [d3-composite-projections](http://geoexamples.com/d3-composite-projections/) are accepted, either as the string name (ie. "geoMercator") or the generator function itself. Map tiles are only usable when the projection is set to Mercator (the default).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| ((...`args`: `unknown`[]) => `unknown`) | "geoMercator" |

###### Returns

[`Geomap`](#geomap) \| ((...`args`: `unknown`[]) => `unknown`)

<a id="projectionpadding"></a>

##### projectionPadding()

> **projectionPadding**(`_?`: `string` \| `number`): [`Geomap`](#geomap) \| `Record`\<`string`, `number`\>

Defined in: [charts/Geomap.ts:690](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Geomap.ts#L690)

The outer padding between the edge of the visualization and the shapes drawn. The value passed can be either a single number to be used on all sides, or a CSS string pattern (ie. `"20px 0 10px"`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `number` | 20] |

###### Returns

[`Geomap`](#geomap) \| `Record`\<`string`, `number`\>

<a id="projectionrotate"></a>

##### projectionRotate()

> **projectionRotate**(`_?`: `number`[]): [`Geomap`](#geomap) \| `number`[]

Defined in: [charts/Geomap.ts:700](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Geomap.ts#L700)

An array that corresponds to the value passed to the projection's [rotate](https://github.com/d3/d3-geo#projection_rotate) function. Use this method to shift the centerpoint of a map.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `number`[] | [0, 0]] |

###### Returns

[`Geomap`](#geomap) \| `number`[]

<a id="render-15"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`render`](#render-38)

<a id="scrollcontainer-5"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| `HTMLElement` \| `Window` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| `HTMLElement` \| `Window` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`scrollContainer`](#scrollcontainer-20)

<a id="select-15"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

`Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`select`](#select-38)

<a id="shape-10"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`shape`](#shape-28)

<a id="shapeconfig-16"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`shapeConfig`](#shapeconfig-40)

<a id="subtitle-5"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`subtitle`](#subtitle-20)

<a id="subtitleconfig-5"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`subtitleConfig`](#subtitleconfig-20)

<a id="subtitlepadding-5"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`subtitlePadding`](#subtitlepadding-20)

<a id="svgdesc-5"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`svgDesc`](#svgdesc-20)

<a id="svgtitle-5"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`svgTitle`](#svgtitle-20)

<a id="threshold-5"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`threshold`](#threshold-20)

<a id="thresholdkey-5"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`thresholdKey`](#thresholdkey-20)

<a id="thresholdname-5"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`thresholdName`](#thresholdname-20)

<a id="tiles"></a>

##### tiles()

> **tiles**(`_?`: `boolean`): `boolean` \| [`Geomap`](#geomap)

Defined in: [charts/Geomap.ts:715](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Geomap.ts#L715)

Toggles the visibility of the map tiles.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `boolean` | true] |

###### Returns

`boolean` \| [`Geomap`](#geomap)

<a id="tileurl"></a>

##### tileUrl()

> **tileUrl**(`_?`: `string`): `string` \| [`Geomap`](#geomap)

Defined in: [charts/Geomap.ts:731](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Geomap.ts#L731)

By default, d3plus uses the `light_all` style provided by [CARTO](https://carto.com/location-data-services/basemaps/) for it's map tiles. The [tileUrl](https://d3plus.org/docs/#Geomap.tileUrl) method changes the base URL used for fetching the tiles, as long as the string passed contains `{x}`, `{y}`, and `{z}` variables enclosed in curly brackets for the zoom logic to load the correct tiles.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` | "https://cartodb-basemaps-{s}.global.ssl.fastly.net/light_all/{z}/{x}/{y}.png"] |

###### Returns

`string` \| [`Geomap`](#geomap)

<a id="time-5"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`time`](#time-20)

<a id="timefilter-5"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`timeFilter`](#timefilter-20)

<a id="timeline-5"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`timeline`](#timeline-21)

<a id="timelineconfig-5"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`timelineConfig`](#timelineconfig-21)

<a id="timelinedefault-5"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): `Date`[] \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

`Date`[] \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`timelineDefault`](#timelinedefault-20)

<a id="timelinepadding-5"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`timelinePadding`](#timelinepadding-21)

<a id="title-10"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`title`](#title-28)

<a id="titleconfig-10"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`titleConfig`](#titleconfig-27)

<a id="titlepadding-5"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`titlePadding`](#titlepadding-20)

<a id="tooltip-5"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`tooltip`](#tooltip-21)

<a id="tooltipconfig-5"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`tooltipConfig`](#tooltipconfig-21)

<a id="topojson"></a>

##### topojson()

> **topojson**(`_?`: `string` \| `Record`\<`string`, `unknown`\>, `f?`: (`data`: `unknown`) => `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Geomap.ts:748](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Geomap.ts#L748)

The topojson to be used for drawing geographical paths. The value passed should either be a valid Topojson *Object* or a *String* representing a filepath or URL to be loaded.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final Topojson *Obejct*.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `Record`\<`string`, `unknown`\> | [] |
| `f?` | (`data`: `unknown`) => `Record`\<`string`, `unknown`\> | Topojson data or a URL to load. |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

<a id="topojsonfill"></a>

##### topojsonFill()

> **topojsonFill**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| [`Geomap`](#geomap) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

Defined in: [charts/Geomap.ts:764](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Geomap.ts#L764)

The function is used to set default color of the map.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) | string |

###### Returns

`string` \| [`Geomap`](#geomap) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

<a id="topojsonfilter"></a>

##### topojsonFilter()

> **topojsonFilter**(`_?`: `string` \| `string`[] \| ((`d`: `Record`\<`string`, `unknown`\>) => `boolean`)): [`Geomap`](#geomap) \| ((`d`: `Record`\<`string`, `unknown`\>) => `boolean`)

Defined in: [charts/Geomap.ts:777](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Geomap.ts#L777)

If the [topojson](#Geomap.topojson) being used contains boundaries that should not be shown, this method can be used to filter them out of the final output. The *value* passed can be a single id to remove, an array of ids, or a filter function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] \| ((`d`: `Record`\<`string`, `unknown`\>) => `boolean`) |

###### Returns

[`Geomap`](#geomap) \| ((`d`: `Record`\<`string`, `unknown`\>) => `boolean`)

<a id="topojsonid"></a>

##### topojsonId()

> **topojsonId**(`_?`: `string` \| ((`d`: `Record`\<`string`, `unknown`\>) => `string`)): [`Geomap`](#geomap) \| ((`d`: `Record`\<`string`, `unknown`\>) => `string`)

Defined in: [charts/Geomap.ts:811](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Geomap.ts#L811)

The accessor used to map each topojson geometry to it's corresponding [data](https://d3plus.org/docs/#Viz.data) point.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| ((`d`: `Record`\<`string`, `unknown`\>) => `string`) | "id" |

###### Returns

[`Geomap`](#geomap) \| ((`d`: `Record`\<`string`, `unknown`\>) => `string`)

<a id="topojsonkey"></a>

##### topojsonKey()

> **topojsonKey**(`_?`: `string`): `string` \| [`Geomap`](#geomap)

Defined in: [charts/Geomap.ts:798](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Geomap.ts#L798)

If the [topojson](#Geomap.topojson) contains multiple geographical sets (for example, a file containing state and county boundaries), use this method to indentify which set to use.

If not specified, the first key in the *Array* returned from using `Object.keys` on the topojson will be used.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Geomap`](#geomap)

<a id="total-5"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`total`](#total-20)

<a id="totalconfig-5"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`totalConfig`](#totalconfig-20)

<a id="totalformat-5"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): ((`d`: `number`) => `string`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

((`d`: `number`) => `string`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`totalFormat`](#totalformat-20)

<a id="totalpadding-5"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`totalPadding`](#totalpadding-20)

<a id="width-12"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`width`](#width-33)

<a id="zoom-5"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`zoom`](#zoom-20)

<a id="zoombrushhandlesize-5"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleSize`](#zoombrushhandlesize-20)

<a id="zoombrushhandlestyle-5"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleStyle`](#zoombrushhandlestyle-20)

<a id="zoombrushselectionstyle-5"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`zoomBrushSelectionStyle`](#zoombrushselectionstyle-20)

<a id="zoomcontrolstyle-5"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyle`](#zoomcontrolstyle-20)

<a id="zoomcontrolstyleactive-5"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleActive`](#zoomcontrolstyleactive-20)

<a id="zoomcontrolstylehover-5"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleHover`](#zoomcontrolstylehover-20)

<a id="zoomfactor-5"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`zoomFactor`](#zoomfactor-20)

<a id="zoommax-5"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`zoomMax`](#zoommax-20)

<a id="zoompadding-5"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`zoomPadding`](#zoompadding-20)

<a id="zoompan-5"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`zoomPan`](#zoompan-20)

<a id="zoomscroll-5"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`Geomap`](#geomap)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Geomap`](#geomap)

###### Inherited from

[`Viz`](#viz).[`zoomScroll`](#zoomscroll-20)

***

<a id="image"></a>

### Image

Defined in: [shapes/Image.ts:22](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L22)

Creates SVG images based on an array of data.

#### Examples

```ts
var data = {"url": "file.png", "width": "100", "height": "50"};
```

```ts
new Image().data([data]).render();
```

```ts
<image class="d3plus-Image" opacity="1" href="file.png" width="100" height="50" x="0" y="0"></image>
```

```ts
image().data([data])();
```

```ts
image().data([data])(function() { alert("draw complete!"); })
```

#### Methods

<a id="data-16"></a>

##### data()

###### Call Signature

> **data**(): `DataPoint`[]

Defined in: [shapes/Image.ts:144](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L144)

The data array used to create image shapes. An <image> tag will be drawn for each object in the array.

###### Returns

`DataPoint`[]

###### Call Signature

> **data**(`_`: `DataPoint`[]): `this`

Defined in: [shapes/Image.ts:145](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L145)

The data array used to create image shapes. An <image> tag will be drawn for each object in the array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `DataPoint`[] |

###### Returns

`this`

<a id="duration-15"></a>

##### duration()

###### Call Signature

> **duration**(): `number`

Defined in: [shapes/Image.ts:153](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L153)

The animation duration in milliseconds.

###### Returns

`number`

###### Call Signature

> **duration**(`_`: `number`): `this`

Defined in: [shapes/Image.ts:154](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L154)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="height-13"></a>

##### height()

###### Call Signature

> **height**(): `AccessorFn`

Defined in: [shapes/Image.ts:167](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L167)

The height accessor for each image.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.height;
}
```

###### Call Signature

> **height**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Image.ts:168](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L168)

The height accessor for each image.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.height;
}
```

<a id="id-3"></a>

##### id()

###### Call Signature

> **id**(): `AccessorFn`

Defined in: [shapes/Image.ts:183](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L183)

The unique id accessor for each image.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.id;
}
```

###### Call Signature

> **id**(`_`: `AccessorFn`): `this`

Defined in: [shapes/Image.ts:184](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L184)

The unique id accessor for each image.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.id;
}
```

<a id="opacity-3"></a>

##### opacity()

###### Call Signature

> **opacity**(): `AccessorFn`

Defined in: [shapes/Image.ts:192](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L192)

The opacity of each image.

###### Returns

`AccessorFn`

###### Call Signature

> **opacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Image.ts:193](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L193)

The opacity of each image.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

<a id="pointerevents-3"></a>

##### pointerEvents()

###### Call Signature

> **pointerEvents**(): `AccessorFn`

Defined in: [shapes/Image.ts:203](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L203)

The pointer-events.

###### Returns

`AccessorFn`

###### Call Signature

> **pointerEvents**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Image.ts:204](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L204)

The pointer-events.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

<a id="render-16"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [shapes/Image.ts:55](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L55)

Renders the current Image to the page. If a *callback* is specified, it will be called once the images are done drawing.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

<a id="select-16"></a>

##### select()

###### Call Signature

> **select**(): `Selection`

Defined in: [shapes/Image.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L215)

The SVG container element as a d3 selector or DOM element.

###### Returns

`Selection`

###### Call Signature

> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`

Defined in: [shapes/Image.ts:216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L216)

The SVG container element as a d3 selector or DOM element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `HTMLElement` \| `SVGElement` \| `null` |

###### Returns

`this`

<a id="url"></a>

##### url()

###### Call Signature

> **url**(): `AccessorFn`

Defined in: [shapes/Image.ts:231](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L231)

Accessor function for the URL of each image.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.url;
}
```

###### Call Signature

> **url**(`_`: `AccessorFn`): `this`

Defined in: [shapes/Image.ts:232](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L232)

Accessor function for the URL of each image.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.url;
}
```

<a id="width-13"></a>

##### width()

###### Call Signature

> **width**(): `AccessorFn`

Defined in: [shapes/Image.ts:245](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L245)

The width accessor for each image.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.width;
}
```

###### Call Signature

> **width**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Image.ts:246](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L246)

The width accessor for each image.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.width;
}
```

<a id="x-8"></a>

##### x()

###### Call Signature

> **x**(): `AccessorFn`

Defined in: [shapes/Image.ts:261](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L261)

The x position accessor for each image.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.x || 0;
}
```

###### Call Signature

> **x**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Image.ts:262](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L262)

The x position accessor for each image.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.x || 0;
}
```

<a id="y-8"></a>

##### y()

###### Call Signature

> **y**(): `AccessorFn`

Defined in: [shapes/Image.ts:277](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L277)

The y position accessor for each image.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.y || 0;
}
```

###### Call Signature

> **y**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Image.ts:278](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L278)

The y position accessor for each image.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.y || 0;
}
```

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="property-_data-10"></a> `_data` | `DataPoint`[] | [shapes/Image.ts:33](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L33) |
| <a id="property-_duration-10"></a> `_duration` | `number` | [shapes/Image.ts:23](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L23) |
| <a id="property-_height-7"></a> `_height` | `AccessorFn` | [shapes/Image.ts:24](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L24) |
| <a id="property-_id-3"></a> `_id` | `AccessorFn` | [shapes/Image.ts:25](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L25) |
| <a id="property-_opacity-3"></a> `_opacity` | `AccessorFn` | [shapes/Image.ts:26](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L26) |
| <a id="property-_pointerevents-3"></a> `_pointerEvents` | `AccessorFn` | [shapes/Image.ts:27](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L27) |
| <a id="property-_select-10"></a> `_select` | `Selection` | [shapes/Image.ts:28](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L28) |
| <a id="property-_url"></a> `_url` | `AccessorFn` | [shapes/Image.ts:29](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L29) |
| <a id="property-_width-7"></a> `_width` | `AccessorFn` | [shapes/Image.ts:30](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L30) |
| <a id="property-_x-4"></a> `_x` | `AccessorFn` | [shapes/Image.ts:31](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L31) |
| <a id="property-_y-4"></a> `_y` | `AccessorFn` | [shapes/Image.ts:32](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Image.ts#L32) |

***

<a id="legend-6"></a>

### Legend

Defined in: [components/Legend.ts:19](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L19)

Creates an SVG legend based on an array of data.

#### Extends

- [`BaseClass`](#baseclass)

#### Methods

<a id="active-10"></a>

##### active()

> **active**(`_`: `unknown`): `this`

Defined in: [components/Legend.ts:547](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L547)

The active method for all shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown` |

###### Returns

`this`

<a id="align-6"></a>

##### align()

###### Call Signature

> **align**(): `string`

Defined in: [components/Legend.ts:557](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L557)

The horizontal alignment.

###### Returns

`string`

###### Call Signature

> **align**(`_`: `string`): `this`

Defined in: [components/Legend.ts:558](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L558)

The horizontal alignment.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="config-11"></a>

##### config()

###### Call Signature

> **config**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L91)

Methods that correspond to the key/value pairs and returns this class.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`BaseClass`](#baseclass).[`config`](#config-7)

###### Call Signature

> **config**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L92)

Methods that correspond to the key/value pairs and returns this class.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`config`](#config-7)

<a id="data-17"></a>

##### data()

###### Call Signature

> **data**(): `DataPoint`[]

Defined in: [components/Legend.ts:566](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L566)

The data array used to create shapes. A shape key will be drawn for each object in the array.

###### Returns

`DataPoint`[]

###### Call Signature

> **data**(`_`: `DataPoint`[]): `this`

Defined in: [components/Legend.ts:567](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L567)

The data array used to create shapes. A shape key will be drawn for each object in the array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `DataPoint`[] |

###### Returns

`this`

<a id="direction"></a>

##### direction()

###### Call Signature

> **direction**(): `string`

Defined in: [components/Legend.ts:575](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L575)

The flow direction of the legend items.

###### Returns

`string`

###### Call Signature

> **direction**(`_`: `string`): `this`

Defined in: [components/Legend.ts:576](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L576)

The flow direction of the legend items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="duration-16"></a>

##### duration()

###### Call Signature

> **duration**(): `number`

Defined in: [components/Legend.ts:584](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L584)

Transition duration of the legend.

###### Returns

`number`

###### Call Signature

> **duration**(`_`: `number`): `this`

Defined in: [components/Legend.ts:585](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L585)

Transition duration of the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="height-14"></a>

##### height()

###### Call Signature

> **height**(): `number`

Defined in: [components/Legend.ts:593](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L593)

Overall height of the legend.

###### Returns

`number`

###### Call Signature

> **height**(`_`: `number`): `this`

Defined in: [components/Legend.ts:594](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L594)

Overall height of the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="hover-10"></a>

##### hover()

> **hover**(`_`: `unknown`): `this`

Defined in: [components/Legend.ts:602](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L602)

The hover method for all shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown` |

###### Returns

`this`

<a id="id-4"></a>

##### id()

###### Call Signature

> **id**(): (`d`: `DataPoint`, `i?`: `number`) => `unknown`

Defined in: [components/Legend.ts:617](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L617)

The unique id accessor for each legend entry.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `unknown`

###### Example

```ts
function value(d) {
return d.id;
}
```

###### Call Signature

> **id**(`_`: (`d`: `DataPoint`, `i?`: `number`) => `unknown`): `this`

Defined in: [components/Legend.ts:618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L618)

The unique id accessor for each legend entry.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `DataPoint`, `i?`: `number`) => `unknown` |

###### Returns

`this`

###### Example

```ts
function value(d) {
return d.id;
}
```

<a id="label-9"></a>

##### label()

###### Call Signature

> **label**(): (`d`: `DataPoint`, `i?`: `number`) => `unknown`

Defined in: [components/Legend.ts:626](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L626)

The label accessor for each legend entry. Uses the id accessor by default.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `unknown`

###### Call Signature

> **label**(`_`: `unknown`): `this`

Defined in: [components/Legend.ts:627](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L627)

The label accessor for each legend entry. Uses the id accessor by default.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown` |

###### Returns

`this`

<a id="locale-11"></a>

##### locale()

###### Call Signature

> **locale**(): `string`

Defined in: [utils/BaseClass.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L156)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Returns

`string`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`BaseClass`](#baseclass).[`locale`](#locale-7)

###### Call Signature

> **locale**(`_`: `string` \| `object`): `this`

Defined in: [utils/BaseClass.ts:157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L157)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `object` |

###### Returns

`this`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`BaseClass`](#baseclass).[`locale`](#locale-7)

<a id="on-11"></a>

##### on()

###### Call Signature

> **on**(): `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

Defined in: [utils/BaseClass.ts:176](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L176)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Returns

`Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `string`): ((...`args`: `unknown`[]) => `unknown`) \| `undefined`

Defined in: [utils/BaseClass.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L177)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

((...`args`: `unknown`[]) => `unknown`) \| `undefined`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `string`, `f`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [utils/BaseClass.ts:178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L178)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |
| `f` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:179](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L179)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

<a id="outerbounds-6"></a>

##### outerBounds()

> **outerBounds**(): `Record`\<`string`, `number`\>

Defined in: [components/Legend.ts:639](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L639)

Returns the outer bounds of the legend content. Must be called after rendering.

###### Returns

`Record`\<`string`, `number`\>

###### Example

```ts
{"width": 180, "height": 24, "x": 10, "y": 20}
```

<a id="padding-6"></a>

##### padding()

###### Call Signature

> **padding**(): `number`

Defined in: [components/Legend.ts:646](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L646)

The padding between each key.

###### Returns

`number`

###### Call Signature

> **padding**(`_`: `number`): `this`

Defined in: [components/Legend.ts:647](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L647)

The padding between each key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="parent-11"></a>

##### parent()

###### Call Signature

> **parent**(): `Record`\<`string`, `unknown`\>

Defined in: [utils/BaseClass.ts:200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L200)

Parent config used by the wrapper.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`BaseClass`](#baseclass).[`parent`](#parent-7)

###### Call Signature

> **parent**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L201)

Parent config used by the wrapper.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`parent`](#parent-7)

<a id="render-17"></a>

##### render()

> **render**(`callback?`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [components/Legend.ts:221](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L221)

Renders the current Legend to the page.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | (...`args`: `unknown`[]) => `unknown` | Optional callback invoked after rendering completes. |

###### Returns

`this`

<a id="select-17"></a>

##### select()

###### Call Signature

> **select**(): `Selection`

Defined in: [components/Legend.ts:655](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L655)

The SVG container element as a d3 selector or DOM element.

###### Returns

`Selection`

###### Call Signature

> **select**(`_`: `any`): `this`

Defined in: [components/Legend.ts:657](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L657)

The SVG container element as a d3 selector or DOM element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`this`

<a id="shape-11"></a>

##### shape()

###### Call Signature

> **shape**(): (`d`: `DataPoint`, `i?`: `number`) => `unknown`

Defined in: [components/Legend.ts:671](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L671)

The shape type used for each legend entry.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `unknown`

###### Call Signature

> **shape**(`_`: `unknown`): `this`

Defined in: [components/Legend.ts:672](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L672)

The shape type used for each legend entry.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown` |

###### Returns

`this`

<a id="shapeconfig-17"></a>

##### shapeConfig()

###### Call Signature

> **shapeConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Legend.ts:682](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L682)

Methods that correspond to the key/value pairs for each shape.

###### Returns

`Record`\<`string`, `unknown`\>

###### Overrides

[`BaseClass`](#baseclass).[`shapeConfig`](#shapeconfig-9)

###### Call Signature

> **shapeConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Legend.ts:683](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L683)

Methods that correspond to the key/value pairs for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Overrides

[`BaseClass`](#baseclass).[`shapeConfig`](#shapeconfig-9)

<a id="title-11"></a>

##### title()

###### Call Signature

> **title**(): `string` \| `undefined`

Defined in: [components/Legend.ts:693](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L693)

Title of the legend.

###### Returns

`string` \| `undefined`

###### Call Signature

> **title**(`_`: `string`): `this`

Defined in: [components/Legend.ts:694](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L694)

Title of the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="titleconfig-11"></a>

##### titleConfig()

###### Call Signature

> **titleConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Legend.ts:702](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L702)

Title configuration of the legend.

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **titleConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Legend.ts:703](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L703)

Title configuration of the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="translate-11"></a>

##### translate()

###### Call Signature

> **translate**(): (`d`: `string`, `locale?`: `string`) => `string`

Defined in: [utils/BaseClass.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L214)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Returns

(`d`: `string`, `locale?`: `string`) => `string`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`translate`](#translate-7)

###### Call Signature

> **translate**(`_`: (`d`: `string`, `locale?`: `string`) => `string`): `this`

Defined in: [utils/BaseClass.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L215)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `string`, `locale?`: `string`) => `string` |

###### Returns

`this`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`translate`](#translate-7)

<a id="verticalalign-3"></a>

##### verticalAlign()

###### Call Signature

> **verticalAlign**(): `string`

Defined in: [components/Legend.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L713)

The vertical alignment.

###### Returns

`string`

###### Call Signature

> **verticalAlign**(`_`: `string`): `this`

Defined in: [components/Legend.ts:714](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L714)

The vertical alignment.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="width-14"></a>

##### width()

###### Call Signature

> **width**(): `number`

Defined in: [components/Legend.ts:724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L724)

Overall width of the legend.

###### Returns

`number`

###### Call Signature

> **width**(`_`: `number`): `this`

Defined in: [components/Legend.ts:725](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L725)

Overall width of the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

#### Properties

| Property | Type | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="property-_align-6"></a> `_align` | `string` | - | - | [components/Legend.ts:21](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L21) |
| <a id="property-_configdefault-11"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | - | [`BaseClass`](#baseclass).[`_configDefault`](#property-_configdefault-7) | [utils/BaseClass.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L69) |
| <a id="property-_data-11"></a> `_data` | `DataPoint`[] | - | - | [components/Legend.ts:22](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L22) |
| <a id="property-_direction"></a> `_direction` | `string` | - | - | [components/Legend.ts:23](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L23) |
| <a id="property-_duration-11"></a> `_duration` | `number` | - | - | [components/Legend.ts:24](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L24) |
| <a id="property-_group-9"></a> `_group` | `Selection` | - | - | [components/Legend.ts:40](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L40) |
| <a id="property-_height-8"></a> `_height` | `number` | - | - | [components/Legend.ts:25](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L25) |
| <a id="property-_id-4"></a> `_id` | (`d`: `DataPoint`, `i?`: `number`) => `unknown` | - | - | [components/Legend.ts:27](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L27) |
| <a id="property-_label-3"></a> `_label` | (`d`: `DataPoint`, `i?`: `number`) => `unknown` | - | - | [components/Legend.ts:28](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L28) |
| <a id="property-_linedata"></a> `_lineData` | `Record`\<`string`, `unknown`\>[] | - | - | [components/Legend.ts:29](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L29) |
| <a id="property-_locale-11"></a> `_locale` | `string` | - | [`BaseClass`](#baseclass).[`_locale`](#property-_locale-7) | [utils/BaseClass.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L64) |
| <a id="property-_on-11"></a> `_on` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | - | [`BaseClass`](#baseclass).[`_on`](#property-_on-7) | [utils/BaseClass.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L65) |
| <a id="property-_outerbounds-6"></a> `_outerBounds` | `Record`\<`string`, `number`\> | - | - | [components/Legend.ts:30](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L30) |
| <a id="property-_padding-6"></a> `_padding` | `number` | - | - | [components/Legend.ts:31](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L31) |
| <a id="property-_parent-11"></a> `_parent` | `Record`\<`string`, `unknown`\> | - | [`BaseClass`](#baseclass).[`_parent`](#property-_parent-7) | [utils/BaseClass.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L66) |
| <a id="property-_rtl"></a> `_rtl` | `boolean` | - | - | [components/Legend.ts:39](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L39) |
| <a id="property-_select-11"></a> `_select` | `Selection` | - | - | [components/Legend.ts:33](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L33) |
| <a id="property-_shape-5"></a> `_shape` | (`d`: `DataPoint`, `i?`: `number`) => `unknown` | - | - | [components/Legend.ts:32](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L32) |
| <a id="property-_shapeconfig-11"></a> `_shapeConfig` | `Record`\<`string`, `unknown`\> | [`BaseClass`](#baseclass).[`_shapeConfig`](#property-_shapeconfig-7) | - | [components/Legend.ts:35](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L35) |
| <a id="property-_shapegroup"></a> `_shapeGroup` | `Selection` | - | - | [components/Legend.ts:42](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L42) |
| <a id="property-_shapes"></a> `_shapes` | `unknown`[] | - | - | [components/Legend.ts:34](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L34) |
| <a id="property-_title-5"></a> `_title` | `string` \| *required* | - | - | [components/Legend.ts:45](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L45) |
| <a id="property-_titleclass-5"></a> `_titleClass` | [`TextBox`](#textbox) | - | - | [components/Legend.ts:20](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L20) |
| <a id="property-_titleconfig-5"></a> `_titleConfig` | `Record`\<`string`, `unknown`\> | - | - | [components/Legend.ts:36](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L36) |
| <a id="property-_titlegroup"></a> `_titleGroup` | `Selection` | - | - | [components/Legend.ts:41](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L41) |
| <a id="property-_titleheight"></a> `_titleHeight` | `number` | - | - | [components/Legend.ts:43](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L43) |
| <a id="property-_titlewidth"></a> `_titleWidth` | `number` | - | - | [components/Legend.ts:44](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L44) |
| <a id="property-_translate-11"></a> `_translate` | (`d`: `string`, `locale?`: `string`) => `string` | - | [`BaseClass`](#baseclass).[`_translate`](#property-_translate-7) | [utils/BaseClass.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L67) |
| <a id="property-_uuid-11"></a> `_uuid` | `string` | - | [`BaseClass`](#baseclass).[`_uuid`](#property-_uuid-7) | [utils/BaseClass.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L68) |
| <a id="property-_verticalalign-3"></a> `_verticalAlign` | `string` | - | - | [components/Legend.ts:37](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L37) |
| <a id="property-_width-8"></a> `_width` | `number` | - | - | [components/Legend.ts:38](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L38) |
| <a id="property-_wraplines"></a> `_wrapLines` | (() => `void`) \| *required* | - | - | [components/Legend.ts:46](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L46) |
| <a id="property-_wraprows"></a> `_wrapRows` | (() => `void`) \| *required* | - | - | [components/Legend.ts:47](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Legend.ts#L47) |

***

<a id="line"></a>

### Line

Defined in: [shapes/Line.ts:17](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Line.ts#L17)

Creates SVG lines based on an array of data.

#### Extends

- [`Shape`](#shape-23)

#### Methods

<a id="active-11"></a>

##### active()

###### Call Signature

> **active**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

Defined in: [shapes/Shape.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1019)

The active callback function for highlighting shapes.

###### Returns

((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

###### Inherited from

[`Shape`](#shape-23).[`active`](#active-25)

###### Call Signature

> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1020](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1020)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`active`](#active-25)

<a id="activeopacity-3"></a>

##### activeOpacity()

###### Call Signature

> **activeOpacity**(): `number`

Defined in: [shapes/Shape.ts:1037](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1037)

When shapes are active, this is the opacity of any shape that is not active.

###### Returns

`number`

###### Inherited from

[`Shape`](#shape-23).[`activeOpacity`](#activeopacity-6)

###### Call Signature

> **activeOpacity**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1038](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1038)

When shapes are active, this is the opacity of any shape that is not active.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`activeOpacity`](#activeopacity-6)

<a id="activestyle-3"></a>

##### activeStyle()

###### Call Signature

> **activeStyle**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1048](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1048)

The style to apply to active shapes.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`activeStyle`](#activestyle-6)

###### Call Signature

> **activeStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1049](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1049)

The style to apply to active shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`activeStyle`](#activestyle-6)

<a id="arialabel-3"></a>

##### ariaLabel()

###### Call Signature

> **ariaLabel**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1059](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1059)

The aria-label attribute for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`ariaLabel`](#arialabel-6)

###### Call Signature

> **ariaLabel**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1060](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1060)

The aria-label attribute for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`ariaLabel`](#arialabel-6)

<a id="backgroundimage-3"></a>

##### backgroundImage()

###### Call Signature

> **backgroundImage**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1070](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1070)

The background-image accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`backgroundImage`](#backgroundimage-6)

###### Call Signature

> **backgroundImage**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1071](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1071)

The background-image accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`backgroundImage`](#backgroundimage-6)

<a id="config-12"></a>

##### config()

###### Call Signature

> **config**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L91)

Methods that correspond to the key/value pairs and returns this class.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`Shape`](#shape-23).[`config`](#config-15)

###### Call Signature

> **config**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L92)

Methods that correspond to the key/value pairs and returns this class.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`config`](#config-15)

<a id="curve-1"></a>

##### curve()

###### Call Signature

> **curve**(): `AccessorFn`

Defined in: [shapes/Line.ts:279](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Line.ts#L279)

The d3 curve function used to interpolate the line.

###### Returns

`AccessorFn`

###### Call Signature

> **curve**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Line.ts:280](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Line.ts#L280)

The d3 curve function used to interpolate the line.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

<a id="data-18"></a>

##### data()

###### Call Signature

> **data**(): `DataPoint`[]

Defined in: [shapes/Shape.ts:1082](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1082)

The data array used to create shapes. A shape will be drawn for each object in the array.

###### Returns

`DataPoint`[]

###### Inherited from

[`Shape`](#shape-23).[`data`](#data-32)

###### Call Signature

> **data**(`_`: `DataPoint`[]): `this`

Defined in: [shapes/Shape.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1083)

The data array used to create shapes. A shape will be drawn for each object in the array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `DataPoint`[] |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`data`](#data-32)

<a id="defined-1"></a>

##### defined()

###### Call Signature

> **defined**(): `AccessorFn`

Defined in: [shapes/Line.ts:290](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Line.ts#L290)

An accessor function that determines whether a data point is defined (not a gap in the line).

###### Returns

`AccessorFn`

###### Call Signature

> **defined**(`_`: `AccessorFn`): `this`

Defined in: [shapes/Line.ts:291](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Line.ts#L291)

An accessor function that determines whether a data point is defined (not a gap in the line).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `AccessorFn` |

###### Returns

`this`

<a id="discrete-9"></a>

##### discrete()

###### Call Signature

> **discrete**(): `string` \| `undefined`

Defined in: [shapes/Shape.ts:1091](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1091)

Determines if either the X or Y position is discrete along a Line, which helps in determining the nearest data point on a line for a hit area event.

###### Returns

`string` \| `undefined`

###### Inherited from

[`Shape`](#shape-23).[`discrete`](#discrete-23)

###### Call Signature

> **discrete**(`_`: `string`): `this`

Defined in: [shapes/Shape.ts:1092](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1092)

Determines if either the X or Y position is discrete along a Line, which helps in determining the nearest data point on a line for a hit area event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`discrete`](#discrete-23)

<a id="duration-17"></a>

##### duration()

###### Call Signature

> **duration**(): `number`

Defined in: [shapes/Shape.ts:1100](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1100)

The animation duration in milliseconds.

###### Returns

`number`

###### Inherited from

[`Shape`](#shape-23).[`duration`](#duration-31)

###### Call Signature

> **duration**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1101](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1101)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`duration`](#duration-31)

<a id="fill-3"></a>

##### fill()

###### Call Signature

> **fill**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1109](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1109)

The fill color accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`fill`](#fill-6)

###### Call Signature

> **fill**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1110](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1110)

The fill color accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`fill`](#fill-6)

<a id="fillopacity-3"></a>

##### fillOpacity()

###### Call Signature

> **fillOpacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1120](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1120)

Defines the "fill-opacity" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`fillOpacity`](#fillopacity-6)

###### Call Signature

> **fillOpacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1121](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1121)

Defines the "fill-opacity" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`fillOpacity`](#fillopacity-6)

<a id="hitarea-3"></a>

##### hitArea()

###### Call Signature

> **hitArea**(): ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) \| `null`

Defined in: [shapes/Shape.ts:1180](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1180)

The mouse hit area accessor function.

###### Returns

((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) \| `null`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`hitArea`](#hitarea-6)

###### Call Signature

> **hitArea**(`_`: `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>)): `this`

Defined in: [shapes/Shape.ts:1187](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1187)

The mouse hit area accessor function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) |

###### Returns

`this`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`hitArea`](#hitarea-6)

<a id="hover-11"></a>

##### hover()

###### Call Signature

> **hover**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

Defined in: [shapes/Shape.ts:1131](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1131)

The hover callback function for highlighting shapes on mouseover.

###### Returns

((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

###### Inherited from

[`Shape`](#shape-23).[`hover`](#hover-25)

###### Call Signature

> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1132](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1132)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`hover`](#hover-25)

<a id="hoveropacity-3"></a>

##### hoverOpacity()

###### Call Signature

> **hoverOpacity**(): `number`

Defined in: [shapes/Shape.ts:1160](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1160)

The opacity of non-hovered shapes when any shape is hovered.

###### Returns

`number`

###### Inherited from

[`Shape`](#shape-23).[`hoverOpacity`](#hoveropacity-6)

###### Call Signature

> **hoverOpacity**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1161](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1161)

The opacity of non-hovered shapes when any shape is hovered.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`hoverOpacity`](#hoveropacity-6)

<a id="hoverstyle-3"></a>

##### hoverStyle()

###### Call Signature

> **hoverStyle**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1149](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1149)

The style to apply to hovered shapes.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`hoverStyle`](#hoverstyle-6)

###### Call Signature

> **hoverStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1150)

The style to apply to hovered shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`hoverStyle`](#hoverstyle-6)

<a id="id-5"></a>

##### id()

###### Call Signature

> **id**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1220](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1220)

The unique id accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`id`](#id-8)

###### Call Signature

> **id**(`_`: `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1221](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1221)

The unique id accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`id`](#id-8)

<a id="label-10"></a>

##### label()

###### Call Signature

> **label**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1229](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1229)

The text label accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`label`](#label-24)

###### Call Signature

> **label**(`_`: `string` \| `string`[] \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1230](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1230)

The text label accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `string`[] \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`label`](#label-24)

<a id="labelbounds-3"></a>

##### labelBounds()

###### Call Signature

> **labelBounds**(): ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null`

Defined in: [shapes/Shape.ts:1251](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1251)

The label bounds accessor function.

###### Returns

((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`labelBounds`](#labelbounds-6)

###### Call Signature

> **labelBounds**(`_`: `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`)): `this`

Defined in: [shapes/Shape.ts:1258](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1258)

The label bounds accessor function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) |

###### Returns

`this`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`labelBounds`](#labelbounds-6)

<a id="labelconfig-4"></a>

##### labelConfig()

###### Call Signature

> **labelConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1291](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1291)

A pass-through to the config method of the TextBox class used to create a shape's labels.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`labelConfig`](#labelconfig-7)

###### Call Signature

> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1292](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1292)

A pass-through to the config method of the TextBox class used to create a shape's labels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`labelConfig`](#labelconfig-7)

<a id="locale-12"></a>

##### locale()

###### Call Signature

> **locale**(): `string`

Defined in: [utils/BaseClass.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L156)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Returns

`string`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Shape`](#shape-23).[`locale`](#locale-15)

###### Call Signature

> **locale**(`_`: `string` \| `object`): `this`

Defined in: [utils/BaseClass.ts:157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L157)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `object` |

###### Returns

`this`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Shape`](#shape-23).[`locale`](#locale-15)

<a id="on-12"></a>

##### on()

###### Call Signature

> **on**(): `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

Defined in: [utils/BaseClass.ts:176](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L176)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Returns

`Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

###### Call Signature

> **on**(`_`: `string`): ((...`args`: `unknown`[]) => `unknown`) \| `undefined`

Defined in: [utils/BaseClass.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L177)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

((...`args`: `unknown`[]) => `unknown`) \| `undefined`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

###### Call Signature

> **on**(`_`: `string`, `f`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [utils/BaseClass.ts:178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L178)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |
| `f` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

###### Call Signature

> **on**(`_`: `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:179](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L179)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

<a id="opacity-4"></a>

##### opacity()

###### Call Signature

> **opacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1302](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1302)

The opacity accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`opacity`](#opacity-7)

###### Call Signature

> **opacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1303](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1303)

The opacity accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`opacity`](#opacity-7)

<a id="parent-12"></a>

##### parent()

###### Call Signature

> **parent**(): `Record`\<`string`, `unknown`\>

Defined in: [utils/BaseClass.ts:200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L200)

Parent config used by the wrapper.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`parent`](#parent-15)

###### Call Signature

> **parent**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L201)

Parent config used by the wrapper.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`parent`](#parent-15)

<a id="pointerevents-4"></a>

##### pointerEvents()

###### Call Signature

> **pointerEvents**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1313](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1313)

The pointer-events CSS property for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`pointerEvents`](#pointerevents-7)

###### Call Signature

> **pointerEvents**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1314](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1314)

The pointer-events CSS property for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`pointerEvents`](#pointerevents-7)

<a id="render-18"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [shapes/Line.ts:121](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Line.ts#L121)

Draws the lines.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Overrides

[`Shape`](#shape-23).[`render`](#render-32)

<a id="role-3"></a>

##### role()

###### Call Signature

> **role**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1325](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1325)

The role attribute.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`role`](#role-6)

###### Call Signature

> **role**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1326](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1326)

The role attribute.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`role`](#role-6)

<a id="rotate-3"></a>

##### rotate()

###### Call Signature

> **rotate**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1336](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1336)

The rotation angle in degrees for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`rotate`](#rotate-6)

###### Call Signature

> **rotate**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1337](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1337)

The rotation angle in degrees for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`rotate`](#rotate-6)

<a id="rx-3"></a>

##### rx()

###### Call Signature

> **rx**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1347](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1347)

Defines the "rx" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`rx`](#rx-6)

###### Call Signature

> **rx**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1348](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1348)

Defines the "rx" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`rx`](#rx-6)

<a id="ry-3"></a>

##### ry()

###### Call Signature

> **ry**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1358](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1358)

Defines the "rx" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`ry`](#ry-6)

###### Call Signature

> **ry**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1359](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1359)

Defines the "rx" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`ry`](#ry-6)

<a id="scale-9"></a>

##### scale()

###### Call Signature

> **scale**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1369](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1369)

The scale transform accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`scale`](#scale-12)

###### Call Signature

> **scale**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1370](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1370)

The scale transform accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`scale`](#scale-12)

<a id="select-18"></a>

##### select()

###### Call Signature

> **select**(): `Selection`

Defined in: [shapes/Shape.ts:1380](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1380)

The SVG container element as a d3 selector or DOM element.

###### Returns

`Selection`

###### Inherited from

[`Shape`](#shape-23).[`select`](#select-32)

###### Call Signature

> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`

Defined in: [shapes/Shape.ts:1381](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1381)

The SVG container element as a d3 selector or DOM element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `HTMLElement` \| `SVGElement` \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`select`](#select-32)

<a id="shapeconfig-18"></a>

##### shapeConfig()

###### Call Signature

> **shapeConfig**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L225)

Configuration object with key/value pairs applied as method calls on each shape.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`Shape`](#shape-23).[`shapeConfig`](#shapeconfig-33)

###### Call Signature

> **shapeConfig**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:226](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L226)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`shapeConfig`](#shapeconfig-33)

<a id="shaperendering-3"></a>

##### shapeRendering()

###### Call Signature

> **shapeRendering**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1396](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1396)

The shape-rendering.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`shapeRendering`](#shaperendering-6)

###### Call Signature

> **shapeRendering**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1397)

The shape-rendering.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`shapeRendering`](#shaperendering-6)

<a id="sort-4"></a>

##### sort()

###### Call Signature

> **sort**(): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`

Defined in: [shapes/Shape.ts:1408](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1408)

A comparator function used to sort shapes for layering order.

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`

###### Inherited from

[`Shape`](#shape-23).[`sort`](#sort-9)

###### Call Signature

> **sort**(`_`: ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1409](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1409)

A comparator function used to sort shapes for layering order.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`sort`](#sort-9)

<a id="stroke-3"></a>

##### stroke()

###### Call Signature

> **stroke**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1419](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1419)

The stroke color accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`stroke`](#stroke-6)

###### Call Signature

> **stroke**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1420](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1420)

The stroke color accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`stroke`](#stroke-6)

<a id="strokedasharray-3"></a>

##### strokeDasharray()

###### Call Signature

> **strokeDasharray**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1430](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1430)

Defines the "stroke-dasharray" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeDasharray`](#strokedasharray-6)

###### Call Signature

> **strokeDasharray**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1431](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1431)

Defines the "stroke-dasharray" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeDasharray`](#strokedasharray-6)

<a id="strokelinecap-3"></a>

##### strokeLinecap()

###### Call Signature

> **strokeLinecap**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1442](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1442)

Defines the "stroke-linecap" attribute for the shapes. Accepted values are `"butt"`, `"round"`, and `"square"`.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeLinecap`](#strokelinecap-6)

###### Call Signature

> **strokeLinecap**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1443](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1443)

Defines the "stroke-linecap" attribute for the shapes. Accepted values are `"butt"`, `"round"`, and `"square"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeLinecap`](#strokelinecap-6)

<a id="strokeopacity-3"></a>

##### strokeOpacity()

###### Call Signature

> **strokeOpacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1454](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1454)

Defines the "stroke-opacity" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeOpacity`](#strokeopacity-6)

###### Call Signature

> **strokeOpacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1455](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1455)

Defines the "stroke-opacity" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeOpacity`](#strokeopacity-6)

<a id="strokewidth-3"></a>

##### strokeWidth()

###### Call Signature

> **strokeWidth**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1466](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1466)

The stroke-width.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeWidth`](#strokewidth-6)

###### Call Signature

> **strokeWidth**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1467](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1467)

The stroke-width.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeWidth`](#strokewidth-6)

<a id="textanchor-3"></a>

##### textAnchor()

###### Call Signature

> **textAnchor**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1477](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1477)

The text-anchor.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`textAnchor`](#textanchor-6)

###### Call Signature

> **textAnchor**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1478](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1478)

The text-anchor.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`textAnchor`](#textanchor-6)

<a id="texture-3"></a>

##### texture()

###### Call Signature

> **texture**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1488](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1488)

Defines the texture used inside of each shape. This uses the [textures.js](https://riccardoscalco.it/textures/) package, and expects either a simple string (`"lines"` or `"circles"`) or a more complex Object containing the various properties of the texture (ie. `{texture: "lines", orientation: "3/8", stroke: "darkorange"}`). If multiple textures are necessary, provide an accsesor Function that returns the correct String/Object for each given data point and index.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`texture`](#texture-6)

###### Call Signature

> **texture**(`_`: `string` \| `Record`\<`string`, `unknown`\> \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1489](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1489)

Defines the texture used inside of each shape. This uses the [textures.js](https://riccardoscalco.it/textures/) package, and expects either a simple string (`"lines"` or `"circles"`) or a more complex Object containing the various properties of the texture (ie. `{texture: "lines", orientation: "3/8", stroke: "darkorange"}`). If multiple textures are necessary, provide an accsesor Function that returns the correct String/Object for each given data point and index.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `Record`\<`string`, `unknown`\> \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`texture`](#texture-6)

<a id="texturedefault-3"></a>

##### textureDefault()

###### Call Signature

> **textureDefault**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1503)

A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`textureDefault`](#texturedefault-6)

###### Call Signature

> **textureDefault**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1504](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1504)

A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`textureDefault`](#texturedefault-6)

<a id="translate-12"></a>

##### translate()

###### Call Signature

> **translate**(): (`d`: `string`, `locale?`: `string`) => `string`

Defined in: [utils/BaseClass.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L214)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Returns

(`d`: `string`, `locale?`: `string`) => `string`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Shape`](#shape-23).[`translate`](#translate-15)

###### Call Signature

> **translate**(`_`: (`d`: `string`, `locale?`: `string`) => `string`): `this`

Defined in: [utils/BaseClass.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L215)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `string`, `locale?`: `string`) => `string` |

###### Returns

`this`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Shape`](#shape-23).[`translate`](#translate-15)

<a id="vectoreffect-3"></a>

##### vectorEffect()

###### Call Signature

> **vectorEffect**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1514](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1514)

The vector-effect.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`vectorEffect`](#vectoreffect-6)

###### Call Signature

> **vectorEffect**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1515](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1515)

The vector-effect.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`vectorEffect`](#vectoreffect-6)

<a id="verticalalign-4"></a>

##### verticalAlign()

###### Call Signature

> **verticalAlign**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1525](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1525)

The vertical alignment.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`verticalAlign`](#verticalalign-7)

###### Call Signature

> **verticalAlign**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1526](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1526)

The vertical alignment.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`verticalAlign`](#verticalalign-7)

<a id="x-9"></a>

##### x()

###### Call Signature

> **x**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1542](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1542)

The x position accessor for each shape.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`x`](#x-15)

###### Call Signature

> **x**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1543)

The x position accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`x`](#x-15)

<a id="y-9"></a>

##### y()

###### Call Signature

> **y**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1558](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1558)

The y position accessor for each shape.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.y;
}
```

###### Inherited from

[`Shape`](#shape-23).[`y`](#y-15)

###### Call Signature

> **y**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1559](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1559)

The y position accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.y;
}
```

###### Inherited from

[`Shape`](#shape-23).[`y`](#y-15)

#### Properties

| Property | Type | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="property-_active-3"></a> `_active` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | - | [`Shape`](#shape-23).[`_active`](#property-_active-6) | [shapes/Shape.ts:116](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L116) |
| <a id="property-_activegroup-3"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-23).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:112](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L112) |
| <a id="property-_activeopacity-3"></a> `_activeOpacity` | `number` | - | [`Shape`](#shape-23).[`_activeOpacity`](#property-_activeopacity-6) | [shapes/Shape.ts:57](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L57) |
| <a id="property-_activestyle-3"></a> `_activeStyle` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_activeStyle`](#property-_activestyle-6) | [shapes/Shape.ts:58](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L58) |
| <a id="property-_arialabel-3"></a> `_ariaLabel` | `AccessorFn` | - | [`Shape`](#shape-23).[`_ariaLabel`](#property-_arialabel-6) | [shapes/Shape.ts:59](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L59) |
| <a id="property-_backgroundimage-3"></a> `_backgroundImage` | `AccessorFn` | - | [`Shape`](#shape-23).[`_backgroundImage`](#property-_backgroundimage-6) | [shapes/Shape.ts:60](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L60) |
| <a id="property-_backgroundimageclass-3"></a> `_backgroundImageClass` | [`Image`](#image) | - | [`Shape`](#shape-23).[`_backgroundImageClass`](#property-_backgroundimageclass-6) | [shapes/Shape.ts:61](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L61) |
| <a id="property-_configdefault-12"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | - | [`Shape`](#shape-23).[`_configDefault`](#property-_configdefault-15) | [utils/BaseClass.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L69) |
| <a id="property-_curve-3"></a> `_curve` | `AccessorFn` | [`Shape`](#shape-23).[`_curve`](#property-_curve-6) | - | [shapes/Line.ts:18](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Line.ts#L18) |
| <a id="property-_data-12"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-23).[`_data`](#property-_data-15) | [shapes/Shape.ts:62](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L62) |
| <a id="property-_defined-3"></a> `_defined` | `AccessorFn` | [`Shape`](#shape-23).[`_defined`](#property-_defined-6) | - | [shapes/Line.ts:19](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Line.ts#L19) |
| <a id="property-_discrete-3"></a> `_discrete` | `string` \| *required* | - | [`Shape`](#shape-23).[`_discrete`](#property-_discrete-6) | [shapes/Shape.ts:118](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L118) |
| <a id="property-_duration-12"></a> `_duration` | `number` | - | [`Shape`](#shape-23).[`_duration`](#property-_duration-15) | [shapes/Shape.ts:63](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L63) |
| <a id="property-_enter-3"></a> `_enter` | `Selection` | - | [`Shape`](#shape-23).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:109](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L109) |
| <a id="property-_exit-3"></a> `_exit` | `Selection` | - | [`Shape`](#shape-23).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:110](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L110) |
| <a id="property-_fill-3"></a> `_fill` | `AccessorFn` | [`Shape`](#shape-23).[`_fill`](#property-_fill-6) | - | [shapes/Line.ts:20](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Line.ts#L20) |
| <a id="property-_fillopacity-3"></a> `_fillOpacity` | `AccessorFn` | - | [`Shape`](#shape-23).[`_fillOpacity`](#property-_fillopacity-6) | [shapes/Shape.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L65) |
| <a id="property-_group-10"></a> `_group` | `Selection` | - | [`Shape`](#shape-23).[`_group`](#property-_group-13) | [shapes/Shape.ts:107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L107) |
| <a id="property-_hitarea-3"></a> `_hitArea` | ((`d`: `DataPoint`, `i`: `number`, `aes`: `ShapeAes`) => `Record`\<`string`, `unknown`\>) \| `null` | [`Shape`](#shape-23).[`_hitArea`](#property-_hitarea-6) | - | [shapes/Line.ts:21](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Line.ts#L21) |
| <a id="property-_hover-3"></a> `_hover` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | - | [`Shape`](#shape-23).[`_hover`](#property-_hover-6) | [shapes/Shape.ts:117](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L117) |
| <a id="property-_hovergroup-3"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-23).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:111](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L111) |
| <a id="property-_hoveropacity-3"></a> `_hoverOpacity` | `number` | - | [`Shape`](#shape-23).[`_hoverOpacity`](#property-_hoveropacity-6) | [shapes/Shape.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L66) |
| <a id="property-_hoverstyle-3"></a> `_hoverStyle` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_hoverStyle`](#property-_hoverstyle-6) | [shapes/Shape.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L67) |
| <a id="property-_id-5"></a> `_id` | `AccessorFn` | - | [`Shape`](#shape-23).[`_id`](#property-_id-8) | [shapes/Shape.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L68) |
| <a id="property-_label-4"></a> `_label` | `AccessorFn` | - | [`Shape`](#shape-23).[`_label`](#property-_label-7) | [shapes/Shape.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L69) |
| <a id="property-_labelbounds-3"></a> `_labelBounds` | ((`d`: `DataPoint`, `i`: `number`, `aes`: `ShapeAes`) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null` | - | [`Shape`](#shape-23).[`_labelBounds`](#property-_labelbounds-6) | [shapes/Shape.ts:72](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L72) |
| <a id="property-_labelclass-4"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-23).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L70) |
| <a id="property-_labelconfig-4"></a> `_labelConfig` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_labelConfig`](#property-_labelconfig-7) | [shapes/Shape.ts:71](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L71) |
| <a id="property-_locale-12"></a> `_locale` | `string` | - | [`Shape`](#shape-23).[`_locale`](#property-_locale-15) | [utils/BaseClass.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L64) |
| <a id="property-_name-3"></a> `_name` | `string` | [`Shape`](#shape-23).[`_name`](#property-_name-6) | - | [shapes/Line.ts:28](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Line.ts#L28) |
| <a id="property-_on-12"></a> `_on` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | - | [`Shape`](#shape-23).[`_on`](#property-_on-15) | [utils/BaseClass.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L65) |
| <a id="property-_opacity-4"></a> `_opacity` | `AccessorFn` | - | [`Shape`](#shape-23).[`_opacity`](#property-_opacity-7) | [shapes/Shape.ts:80](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L80) |
| <a id="property-_parent-12"></a> `_parent` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_parent`](#property-_parent-15) | [utils/BaseClass.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L66) |
| <a id="property-_path-3"></a> `_path` | `Record`\<`string`, `unknown`\> | [`Shape`](#shape-23).[`_path`](#property-_path-6) | - | [shapes/Line.ts:29](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Line.ts#L29) |
| <a id="property-_pointerevents-4"></a> `_pointerEvents` | `AccessorFn` | - | [`Shape`](#shape-23).[`_pointerEvents`](#property-_pointerevents-7) | [shapes/Shape.ts:81](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L81) |
| <a id="property-_role-3"></a> `_role` | `AccessorFn` | - | [`Shape`](#shape-23).[`_role`](#property-_role-6) | [shapes/Shape.ts:82](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L82) |
| <a id="property-_rotate-3"></a> `_rotate` | `AccessorFn` | - | [`Shape`](#shape-23).[`_rotate`](#property-_rotate-6) | [shapes/Shape.ts:83](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L83) |
| <a id="property-_rx-3"></a> `_rx` | `AccessorFn` | - | [`Shape`](#shape-23).[`_rx`](#property-_rx-6) | [shapes/Shape.ts:84](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L84) |
| <a id="property-_ry-3"></a> `_ry` | `AccessorFn` | - | [`Shape`](#shape-23).[`_ry`](#property-_ry-6) | [shapes/Shape.ts:85](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L85) |
| <a id="property-_scale-9"></a> `_scale` | `AccessorFn` | - | [`Shape`](#shape-23).[`_scale`](#property-_scale-12) | [shapes/Shape.ts:86](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L86) |
| <a id="property-_select-12"></a> `_select` | `Selection` | - | [`Shape`](#shape-23).[`_select`](#property-_select-15) | [shapes/Shape.ts:102](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L102) |
| <a id="property-_shapeconfig-12"></a> `_shapeConfig?` | [`D3plusConfig`](#d3plusconfig) | - | [`Shape`](#shape-23).[`_shapeConfig`](#property-_shapeconfig-15) | [utils/BaseClass.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L70) |
| <a id="property-_shaperendering-3"></a> `_shapeRendering` | `AccessorFn` | - | [`Shape`](#shape-23).[`_shapeRendering`](#property-_shaperendering-6) | [shapes/Shape.ts:87](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L87) |
| <a id="property-_sort-3"></a> `_sort` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | - | [`Shape`](#shape-23).[`_sort`](#property-_sort-6) | [shapes/Shape.ts:106](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L106) |
| <a id="property-_stroke-3"></a> `_stroke` | `AccessorFn` | [`Shape`](#shape-23).[`_stroke`](#property-_stroke-6) | - | [shapes/Line.ts:30](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Line.ts#L30) |
| <a id="property-_strokedasharray-3"></a> `_strokeDasharray` | `AccessorFn` | [`Shape`](#shape-23).[`_strokeDasharray`](#property-_strokedasharray-6) | - | [shapes/Line.ts:32](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Line.ts#L32) |
| <a id="property-_strokelinecap-3"></a> `_strokeLinecap` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeLinecap`](#property-_strokelinecap-6) | [shapes/Shape.ts:90](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L90) |
| <a id="property-_strokeopacity-3"></a> `_strokeOpacity` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeOpacity`](#property-_strokeopacity-6) | [shapes/Shape.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L91) |
| <a id="property-_strokewidth-3"></a> `_strokeWidth` | `AccessorFn` | [`Shape`](#shape-23).[`_strokeWidth`](#property-_strokewidth-6) | - | [shapes/Line.ts:31](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Line.ts#L31) |
| <a id="property-_tagname-3"></a> `_tagName` | `string` | - | [`Shape`](#shape-23).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:93](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L93) |
| <a id="property-_textanchor-3"></a> `_textAnchor` | `AccessorFn` | - | [`Shape`](#shape-23).[`_textAnchor`](#property-_textanchor-6) | [shapes/Shape.ts:94](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L94) |
| <a id="property-_texture-3"></a> `_texture` | `AccessorFn` | - | [`Shape`](#shape-23).[`_texture`](#property-_texture-6) | [shapes/Shape.ts:95](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L95) |
| <a id="property-_texturedefault-3"></a> `_textureDefault` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_textureDefault`](#property-_texturedefault-6) | [shapes/Shape.ts:96](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L96) |
| <a id="property-_texturedefs-3"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-23).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:97](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L97) |
| <a id="property-_transition-8"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-23).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:103](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L103) |
| <a id="property-_translate-12"></a> `_translate` | (`d`: `string`, `locale?`: `string`) => `string` | - | [`Shape`](#shape-23).[`_translate`](#property-_translate-15) | [utils/BaseClass.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L67) |
| <a id="property-_update-3"></a> `_update` | `Selection` | - | [`Shape`](#shape-23).[`_update`](#property-_update-6) | [shapes/Shape.ts:108](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L108) |
| <a id="property-_uuid-12"></a> `_uuid` | `string` | - | [`Shape`](#shape-23).[`_uuid`](#property-_uuid-15) | [utils/BaseClass.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L68) |
| <a id="property-_vectoreffect-3"></a> `_vectorEffect` | `AccessorFn` | - | [`Shape`](#shape-23).[`_vectorEffect`](#property-_vectoreffect-6) | [shapes/Shape.ts:98](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L98) |
| <a id="property-_verticalalign-4"></a> `_verticalAlign` | `AccessorFn` | - | [`Shape`](#shape-23).[`_verticalAlign`](#property-_verticalalign-7) | [shapes/Shape.ts:99](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L99) |
| <a id="property-_x-5"></a> `_x` | `AccessorFn` | - | [`Shape`](#shape-23).[`_x`](#property-_x-8) | [shapes/Shape.ts:100](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L100) |
| <a id="property-_y-5"></a> `_y` | `AccessorFn` | - | [`Shape`](#shape-23).[`_y`](#property-_y-8) | [shapes/Shape.ts:101](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L101) |

***

<a id="lineplot"></a>

### LinePlot

Defined in: [charts/LinePlot.ts:12](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/LinePlot.ts#L12)

Creates a line plot based on an array of data.

#### Example

```ts
new d3plus.Plot()
.discrete("x")
.shape("Line")
```

#### Extends

- [`Plot`](#plot)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-12"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`active`](#active-18)

<a id="aggs-6"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`aggs`](#aggs-11)

<a id="annotations-4"></a>

##### annotations()

> **annotations**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2004](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2004)

Allows drawing custom shapes to be used as annotations in the provided x/y plot. This method accepts custom config objects for the [Shape](http://d3plus.org/docs/#Shape) class, either a single config object or an array of config objects. Each config object requires an additional parameter, the "shape", which denotes which [Shape](http://d3plus.org/docs/#Shape) sub-class to use ([Rect](http://d3plus.org/docs/#Rect), [Line](http://d3plus.org/docs/#Line), etc).

Additionally, each config object can also contain an optional "layer" key, which defines whether the annotations will be displayed in "front" or in "back" of the primary visualization shapes. This value defaults to "back" if not present.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`annotations`](#annotations-5)

<a id="ariahidden-6"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`ariaHidden`](#ariahidden-11)

<a id="attribution-6"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`attribution`](#attribution-11)

<a id="attributionstyle-6"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`attributionStyle`](#attributionstyle-11)

<a id="axispersist-4"></a>

##### axisPersist()

> **axisPersist**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2013](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2013)

Determines whether the x and y axes should have their scales persist while users filter the data, the timeline being the prime example (set this to `true` to make the axes stay consistent when the timeline changes).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`axisPersist`](#axispersist-5)

<a id="backconfig-6"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`backConfig`](#backconfig-11)

<a id="backgroundconfig-4"></a>

##### backgroundConfig()

> **backgroundConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2022](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2022)

A d3plus-shape configuration Object used for styling the background rectangle of the inner x/y plot (behind all of the shapes and gridlines).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`backgroundConfig`](#backgroundconfig-5)

<a id="barpadding-4"></a>

##### barPadding()

> **barPadding**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2031](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2031)

The pixel space between each bar in a group of bars.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`barPadding`](#barpadding-5)

<a id="baseline-4"></a>

##### baseline()

> **baseline**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2038](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2038)

The baseline for the x/y plot.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`baseline`](#baseline-5)

<a id="buffer-4"></a>

##### buffer()

> **buffer**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2045](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2045)

Determines whether or not to add additional padding at the ends of x or y scales. The most commone use for this is in Scatter Plots, so that the shapes do not appear directly on the axis itself. The value provided can either be `true` or `false` to toggle the behavior for all shape types, or a keyed Object for each shape type (ie. `{Bar: false, Circle: true, Line: false}`).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`buffer`](#buffer-5)

<a id="cache-6"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`cache`](#cache-11)

<a id="color-7"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`color`](#color-12)

<a id="colorscale-7"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`colorScale`](#colorscale-12)

<a id="colorscaleconfig-7"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`colorScaleConfig`](#colorscaleconfig-12)

<a id="colorscalemaxsize-6"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`colorScaleMaxSize`](#colorscalemaxsize-11)

<a id="colorscalepadding-7"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`colorScalePadding`](#colorscalepadding-12)

<a id="colorscaleposition-6"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| (() => `string` \| `boolean`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| (() => `string` \| `boolean`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`colorScalePosition`](#colorscaleposition-11)

<a id="confidence-4"></a>

##### confidence()

> **confidence**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2073](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2073)

The confidence interval as an array of [lower, upper] bounds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Example

```ts
var data = {id: "alpha", value: 10, lci: 9, hci: 11};
...
// Accessor functions
.confidence([function(d) { return d.lci }, function(d) { return d.hci }])

// Or static keys
.confidence(["lci", "hci"])
```

###### Inherited from

[`Plot`](#plot).[`confidence`](#confidence-5)

<a id="confidenceconfig-4"></a>

##### confidenceConfig()

> **confidenceConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2090](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2090)

Configuration object for shapes rendered as confidence intervals.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`confidenceConfig`](#confidenceconfig-5)

<a id="data-19"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): `DataPoint`[] \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

`DataPoint`[] \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`data`](#data-25)

<a id="datacutoff-6"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`dataCutoff`](#datacutoff-11)

<a id="depth-6"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`depth`](#depth-11)

<a id="destroy-6"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

###### Inherited from

[`Plot`](#plot).[`destroy`](#destroy-11)

<a id="detectresize-6"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`detectResize`](#detectresize-11)

<a id="detectresizedelay-6"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`detectResizeDelay`](#detectresizedelay-11)

<a id="detectvisible-6"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`detectVisible`](#detectvisible-11)

<a id="detectvisibleinterval-6"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`detectVisibleInterval`](#detectvisibleinterval-11)

<a id="discrete-10"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`discrete`](#discrete-16)

<a id="discretecutoff-4"></a>

##### discreteCutoff()

> **discreteCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2099](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2099)

When the width or height of the chart is less than or equal to this pixel value, the discrete axis will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`discreteCutoff`](#discretecutoff-5)

<a id="downloadbutton-6"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`downloadButton`](#downloadbutton-11)

<a id="downloadconfig-6"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`downloadConfig`](#downloadconfig-11)

<a id="downloadposition-6"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`downloadPosition`](#downloadposition-11)

<a id="duration-18"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`duration`](#duration-24)

<a id="filter-6"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`filter`](#filter-11)

<a id="fontfamily-6"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| `string`[] \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| `string`[] \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`fontFamily`](#fontfamily-11)

<a id="groupby-6"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

(`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`groupBy`](#groupby-11)

<a id="grouppadding-4"></a>

##### groupPadding()

> **groupPadding**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2108](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2108)

The pixel space between groups of bars.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`groupPadding`](#grouppadding-5)

<a id="height-15"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`height`](#height-20)

<a id="hiddencolor-6"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`hiddenColor`](#hiddencolor-11)

<a id="hiddenopacity-6"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`hiddenOpacity`](#hiddenopacity-11)

<a id="hover-12"></a>

##### hover()

> **hover**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `this`

Defined in: [charts/Viz.ts:1350](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1350)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`this`

###### Inherited from

[`Plot`](#plot).[`hover`](#hover-18)

<a id="label-11"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`label`](#label-17)

<a id="labelconnectorconfig-4"></a>

##### labelConnectorConfig()

> **labelConnectorConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2117](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2117)

The d3plus-shape config used on the Line shapes created to connect lineLabels to the end of their associated Line path.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`labelConnectorConfig`](#labelconnectorconfig-5)

<a id="labelposition-4"></a>

##### labelPosition()

> **labelPosition**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2127](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2127)

The behavior to be used when calculating the position and size of each shape's label(s). The value passed can either be the _String_ name of the behavior to be used for all shapes, or an accessor _Function_ that will be provided each data point and will be expected to return the behavior to be used for that data point. The availability and options for this method depend on the default logic for each Shape. As an example, the values "outside" or "inside" can be set for Bar shapes, whose "auto" default will calculate the best position dynamically based on the available space.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`labelPosition`](#labelposition-5)

<a id="legend-7"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`legend`](#legend-12)

<a id="legendconfig-8"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`legendConfig`](#legendconfig-13)

<a id="legendfilterinvert-6"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`legendFilterInvert`](#legendfilterinvert-11)

<a id="legendpadding-7"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`legendPadding`](#legendpadding-12)

<a id="legendposition-6"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| (() => `string`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| (() => `string`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`legendPosition`](#legendposition-11)

<a id="legendsort-6"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`legendSort`](#legendsort-11)

<a id="legendtooltip-6"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`legendTooltip`](#legendtooltip-11)

<a id="linelabels-4"></a>

##### lineLabels()

> **lineLabels**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2137](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2137)

Draws labels on the right side of any Line shapes that are drawn on the plot.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`lineLabels`](#linelabels-5)

<a id="linemarkerconfig-4"></a>

##### lineMarkerConfig()

> **lineMarkerConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2144](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2144)

Shape config for the Circle shapes drawn by the lineMarkers method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`lineMarkerConfig`](#linemarkerconfig-5)

<a id="linemarkers-4"></a>

##### lineMarkers()

> **lineMarkers**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2153](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2153)

Draws circle markers on each vertex of a Line.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`lineMarkers`](#linemarkers-5)

<a id="loadinghtml-6"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`loadingHTML`](#loadinghtml-11)

<a id="loadingmessage-6"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`loadingMessage`](#loadingmessage-11)

<a id="messagemask-6"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`messageMask`](#messagemask-11)

<a id="messagestyle-6"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`messageStyle`](#messagestyle-11)

<a id="nodatahtml-6"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`noDataHTML`](#nodatahtml-11)

<a id="nodatamessage-6"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`noDataMessage`](#nodatamessage-11)

<a id="render-19"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Plot`](#plot).[`render`](#render-25)

<a id="scrollcontainer-6"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| `HTMLElement` \| `Window` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| `HTMLElement` \| `Window` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`scrollContainer`](#scrollcontainer-11)

<a id="select-19"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

`Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`select`](#select-25)

<a id="shape-12"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`shape`](#shape-17)

<a id="shapeconfig-19"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`shapeConfig`](#shapeconfig-25)

<a id="shapesort-4"></a>

##### shapeSort()

> **shapeSort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2162](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2162)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) that receives each shape Class (ie. "Circle", "Line", etc) as it's comparator arguments. Shapes are drawn in groups based on their type, so you are defining the layering order for all shapes of said type.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`shapeSort`](#shapesort-5)

<a id="size-5"></a>

##### size()

> **size**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2169](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2169)

Sets the size of bubbles to the given Number, data key, or function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`size`](#size-7)

<a id="sizemax-4"></a>

##### sizeMax()

> **sizeMax**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2178)

Sets the size scale maximum to the specified number.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`sizeMax`](#sizemax-6)

<a id="sizemin-4"></a>

##### sizeMin()

> **sizeMin**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2185](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2185)

Sets the size scale minimum to the specified number.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`sizeMin`](#sizemin-6)

<a id="sizescale-4"></a>

##### sizeScale()

> **sizeScale**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2192](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2192)

Sets the size scale to the specified string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`sizeScale`](#sizescale-6)

<a id="stacked-4"></a>

##### stacked()

> **stacked**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2199](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2199)

If *value* is specified, toggles shape stacking. If *value* is not specified, returns the current stack value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`stacked`](#stacked-5)

<a id="stackoffset-4"></a>

##### stackOffset()

> **stackOffset**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2206](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2206)

Sets the stack offset. If *value* is not specified, returns the current stack offset function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`stackOffset`](#stackoffset-5)

<a id="stackorder-4"></a>

##### stackOrder()

> **stackOrder**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2219](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2219)

Sets the stack order. If *value* is not specified, returns the current stack order function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`stackOrder`](#stackorder-5)

<a id="subtitle-6"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`subtitle`](#subtitle-11)

<a id="subtitleconfig-6"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`subtitleConfig`](#subtitleconfig-11)

<a id="subtitlepadding-6"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`subtitlePadding`](#subtitlepadding-11)

<a id="svgdesc-6"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`svgDesc`](#svgdesc-11)

<a id="svgtitle-6"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`svgTitle`](#svgtitle-11)

<a id="threshold-6"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| ((`data`: `DataPoint`[]) => `number`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| ((`data`: `DataPoint`[]) => `number`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`threshold`](#threshold-11)

<a id="thresholdkey-6"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`thresholdKey`](#thresholdkey-11)

<a id="thresholdname-6"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`thresholdName`](#thresholdname-11)

<a id="time-6"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`time`](#time-11)

<a id="timefilter-6"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`timeFilter`](#timefilter-11)

<a id="timeline-6"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`timeline`](#timeline-11)

<a id="timelineconfig-6"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`timelineConfig`](#timelineconfig-11)

<a id="timelinedefault-6"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): `Date`[] \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

`Date`[] \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`timelineDefault`](#timelinedefault-11)

<a id="timelinepadding-6"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`timelinePadding`](#timelinepadding-11)

<a id="title-12"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`title`](#title-17)

<a id="titleconfig-12"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`titleConfig`](#titleconfig-17)

<a id="titlepadding-6"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`titlePadding`](#titlepadding-11)

<a id="tooltip-6"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`tooltip`](#tooltip-11)

<a id="tooltipconfig-6"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`tooltipConfig`](#tooltipconfig-11)

<a id="total-6"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`total`](#total-11)

<a id="totalconfig-6"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`totalConfig`](#totalconfig-11)

<a id="totalformat-6"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): ((`d`: `number`) => `string`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

((`d`: `number`) => `string`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`totalFormat`](#totalformat-11)

<a id="totalpadding-6"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`totalPadding`](#totalpadding-11)

<a id="width-15"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`width`](#width-20)

<a id="x-10"></a>

##### x()

> **x**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2236](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2236)

Accessor function or string key for the x-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x`](#x-13)

<a id="x2-4"></a>

##### x2()

> **x2**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2250)

Accessor function or string key for the secondary x-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x2`](#x2-5)

<a id="x2config-4"></a>

##### x2Config()

> **x2Config**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2280](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2280)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the secondary x-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x2Config`](#x2config-5)

<a id="x2domain-4"></a>

##### x2Domain()

> **x2Domain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2296](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2296)

The x2 domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x2Domain`](#x2domain-5)

<a id="x2sort-4"></a>

##### x2Sort()

> **x2Sort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2310](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2310)

Defines a custom sorting comparitor function to be used for discrete x2 axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`x2Sort`](#x2sort-5)

<a id="xconfig-4"></a>

##### xConfig()

> **xConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2264](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2264)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the x-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`xConfig`](#xconfig-5)

<a id="xcutoff-4"></a>

##### xCutoff()

> **xCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2273](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2273)

When the width of the chart is less than or equal to this pixel value, and the x-axis is not the discrete axis, it will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`xCutoff`](#xcutoff-5)

<a id="xdomain-4"></a>

##### xDomain()

> **xDomain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2289](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2289)

The x domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`xDomain`](#xdomain-5)

<a id="xsort-4"></a>

##### xSort()

> **xSort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2303](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2303)

Defines a custom sorting comparitor function to be used for discrete x axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`xSort`](#xsort-5)

<a id="y-10"></a>

##### y()

> **y**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2317](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2317)

Accessor function or string key for the y-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y`](#y-13)

<a id="y2-4"></a>

##### y2()

> **y2**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2331](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2331)

Accessor function or string key for the secondary y-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y2`](#y2-5)

<a id="y2config-4"></a>

##### y2Config()

> **y2Config**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2366](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2366)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the secondary y-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y2Config`](#y2config-5)

<a id="y2domain-4"></a>

##### y2Domain()

> **y2Domain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2385](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2385)

The y2 domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y2Domain`](#y2domain-5)

<a id="y2sort-4"></a>

##### y2Sort()

> **y2Sort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2399](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2399)

Defines a custom sorting comparitor function to be used for discrete y2 axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`y2Sort`](#y2sort-5)

<a id="yconfig-4"></a>

##### yConfig()

> **yConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2347](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2347)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the y-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

*Note:* If a "domain" array is passed to the y-axis config, it will be reversed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`yConfig`](#yconfig-5)

<a id="ycutoff-4"></a>

##### yCutoff()

> **yCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2359](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2359)

When the height of the chart is less than or equal to this pixel value, and the y-axis is not the discrete axis, it will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`yCutoff`](#ycutoff-5)

<a id="ydomain-4"></a>

##### yDomain()

> **yDomain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2378](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2378)

The y domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`yDomain`](#ydomain-5)

<a id="ysort-4"></a>

##### ySort()

> **ySort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2392](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2392)

Defines a custom sorting comparitor function to be used for discrete y axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`Plot`](#plot).[`ySort`](#ysort-5)

<a id="zoom-6"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`zoom`](#zoom-11)

<a id="zoombrushhandlesize-6"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`zoomBrushHandleSize`](#zoombrushhandlesize-11)

<a id="zoombrushhandlestyle-6"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`zoomBrushHandleStyle`](#zoombrushhandlestyle-11)

<a id="zoombrushselectionstyle-6"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`zoomBrushSelectionStyle`](#zoombrushselectionstyle-11)

<a id="zoomcontrolstyle-6"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`zoomControlStyle`](#zoomcontrolstyle-11)

<a id="zoomcontrolstyleactive-6"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`zoomControlStyleActive`](#zoomcontrolstyleactive-11)

<a id="zoomcontrolstylehover-6"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`zoomControlStyleHover`](#zoomcontrolstylehover-11)

<a id="zoomfactor-6"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`zoomFactor`](#zoomfactor-11)

<a id="zoommax-6"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`zoomMax`](#zoommax-11)

<a id="zoompadding-6"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`zoomPadding`](#zoompadding-11)

<a id="zoompan-6"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`zoomPan`](#zoompan-11)

<a id="zoomscroll-6"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`LinePlot`](#lineplot)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`LinePlot`](#lineplot)

###### Inherited from

[`Plot`](#plot).[`zoomScroll`](#zoomscroll-11)

***

<a id="matrix"></a>

### Matrix

Defined in: [charts/Matrix.ts:26](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Matrix.ts#L26)

Creates a simple rows/columns Matrix view of any dataset. See [this example](https://d3plus.org/examples/d3plus-matrix/getting-started/) for help getting started using the Matrix class.

#### Extends

- [`Viz`](#viz)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-13"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`active`](#active-29)

<a id="aggs-7"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`aggs`](#aggs-20)

<a id="ariahidden-7"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`ariaHidden`](#ariahidden-21)

<a id="attribution-7"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`attribution`](#attribution-20)

<a id="attributionstyle-7"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`attributionStyle`](#attributionstyle-20)

<a id="backconfig-7"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`backConfig`](#backconfig-20)

<a id="cache-7"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`cache`](#cache-20)

<a id="cellpadding"></a>

##### cellPadding()

> **cellPadding**(`_?`: `number`): `number` \| [`Matrix`](#matrix)

Defined in: [charts/Matrix.ts:218](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Matrix.ts#L218)

The pixel padding in between each cell.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Matrix`](#matrix)

<a id="color-8"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`color`](#color-21)

<a id="colorscale-8"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`colorScale`](#colorscale-21)

<a id="colorscaleconfig-8"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`colorScaleConfig`](#colorscaleconfig-21)

<a id="colorscalemaxsize-7"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`colorScaleMaxSize`](#colorscalemaxsize-20)

<a id="colorscalepadding-8"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`colorScalePadding`](#colorscalepadding-21)

<a id="colorscaleposition-7"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`colorScalePosition`](#colorscaleposition-20)

<a id="column"></a>

##### column()

> **column**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| [`Matrix`](#matrix) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

Defined in: [charts/Matrix.ts:232](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Matrix.ts#L232)

Determines which key in your data should be used for each column in the matrix. Can be either a String that matches a key used in every data point, or an accessor function that receives a data point and it's index in the data array, and is expected to return it's column value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| [`Matrix`](#matrix) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

###### Example

```ts
function column(d) {
return d.name;
}
```

<a id="columnconfig"></a>

##### columnConfig()

> **columnConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Matrix.ts:243](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Matrix.ts#L243)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the column labels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

<a id="columnlist"></a>

##### columnList()

> **columnList**(`_?`: (`string` \| `number` \| `boolean` \| `DataPoint`)[]): [`Matrix`](#matrix) \| (`string` \| `number` \| `boolean` \| `DataPoint`)[]

Defined in: [charts/Matrix.ts:252](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Matrix.ts#L252)

A manual list of IDs to be used for columns.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`string` \| `number` \| `boolean` \| `DataPoint`)[] |

###### Returns

[`Matrix`](#matrix) \| (`string` \| `number` \| `boolean` \| `DataPoint`)[]

<a id="columnsort"></a>

##### columnSort()

> **columnSort**(`_?`: (...`args`: `unknown`[]) => `unknown`): [`Matrix`](#matrix) \| ((...`args`: `unknown`[]) => `unknown`)

Defined in: [charts/Matrix.ts:266](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Matrix.ts#L266)

A sort comparator function that is run on the unique set of column values.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

[`Matrix`](#matrix) \| ((...`args`: `unknown`[]) => `unknown`)

###### Example

```ts
function column(a, b) {
return a.localeCompare(b);
}
```

<a id="data-20"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): `DataPoint`[] \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

`DataPoint`[] \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`data`](#data-39)

<a id="datacutoff-7"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`dataCutoff`](#datacutoff-20)

<a id="depth-7"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`depth`](#depth-20)

<a id="destroy-7"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`destroy`](#destroy-20)

<a id="detectresize-7"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`detectResize`](#detectresize-20)

<a id="detectresizedelay-7"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`detectResizeDelay`](#detectresizedelay-20)

<a id="detectvisible-7"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`detectVisible`](#detectvisible-20)

<a id="detectvisibleinterval-7"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`detectVisibleInterval`](#detectvisibleinterval-20)

<a id="discrete-11"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`discrete`](#discrete-27)

<a id="downloadbutton-7"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`downloadButton`](#downloadbutton-20)

<a id="downloadconfig-7"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`downloadConfig`](#downloadconfig-20)

<a id="downloadposition-7"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`downloadPosition`](#downloadposition-20)

<a id="duration-19"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`duration`](#duration-37)

<a id="filter-7"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`filter`](#filter-20)

<a id="fontfamily-7"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| `string`[] \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| `string`[] \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`fontFamily`](#fontfamily-21)

<a id="groupby-7"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

(`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`groupBy`](#groupby-20)

<a id="height-16"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`height`](#height-33)

<a id="hiddencolor-7"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`hiddenColor`](#hiddencolor-20)

<a id="hiddenopacity-7"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`hiddenOpacity`](#hiddenopacity-20)

<a id="hover-13"></a>

##### hover()

> **hover**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `this`

Defined in: [charts/Viz.ts:1350](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1350)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`hover`](#hover-29)

<a id="label-12"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`label`](#label-28)

<a id="legend-8"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`legend`](#legend-21)

<a id="legendconfig-9"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`legendConfig`](#legendconfig-22)

<a id="legendfilterinvert-7"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`legendFilterInvert`](#legendfilterinvert-20)

<a id="legendpadding-8"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`legendPadding`](#legendpadding-21)

<a id="legendposition-7"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| (() => `string`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| (() => `string`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`legendPosition`](#legendposition-20)

<a id="legendsort-7"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`legendSort`](#legendsort-20)

<a id="legendtooltip-7"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`legendTooltip`](#legendtooltip-20)

<a id="loadinghtml-7"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`loadingHTML`](#loadinghtml-20)

<a id="loadingmessage-7"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`loadingMessage`](#loadingmessage-20)

<a id="messagemask-7"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`messageMask`](#messagemask-20)

<a id="messagestyle-7"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`messageStyle`](#messagestyle-20)

<a id="nodatahtml-7"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`noDataHTML`](#nodatahtml-20)

<a id="nodatamessage-7"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`noDataMessage`](#nodatamessage-20)

<a id="render-20"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`render`](#render-38)

<a id="row"></a>

##### row()

> **row**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| [`Matrix`](#matrix) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

Defined in: [charts/Matrix.ts:278](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Matrix.ts#L278)

Determines which key in your data should be used for each row in the matrix. Can be either a String that matches a key used in every data point, or an accessor function that receives a data point and it's index in the data array, and is expected to return it's row value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| [`Matrix`](#matrix) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

###### Example

```ts
function row(d) {
return d.name;
}
```

<a id="rowconfig"></a>

##### rowConfig()

> **rowConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Matrix.ts:289](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Matrix.ts#L289)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the row labels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

<a id="rowlist"></a>

##### rowList()

> **rowList**(`_?`: (`string` \| `number` \| `boolean` \| `DataPoint`)[]): [`Matrix`](#matrix) \| (`string` \| `number` \| `boolean` \| `DataPoint`)[]

Defined in: [charts/Matrix.ts:298](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Matrix.ts#L298)

A manual list of IDs to be used for rows.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`string` \| `number` \| `boolean` \| `DataPoint`)[] |

###### Returns

[`Matrix`](#matrix) \| (`string` \| `number` \| `boolean` \| `DataPoint`)[]

<a id="rowsort"></a>

##### rowSort()

> **rowSort**(`_?`: (...`args`: `unknown`[]) => `unknown`): [`Matrix`](#matrix) \| ((...`args`: `unknown`[]) => `unknown`)

Defined in: [charts/Matrix.ts:312](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Matrix.ts#L312)

A sort comparator function that is run on the unique set of row values.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

[`Matrix`](#matrix) \| ((...`args`: `unknown`[]) => `unknown`)

###### Example

```ts
function row(a, b) {
return a.localeCompare(b);
}
```

<a id="scrollcontainer-7"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| `HTMLElement` \| `Window` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| `HTMLElement` \| `Window` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`scrollContainer`](#scrollcontainer-20)

<a id="select-20"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

`Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`select`](#select-38)

<a id="shape-13"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`shape`](#shape-28)

<a id="shapeconfig-20"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`shapeConfig`](#shapeconfig-40)

<a id="subtitle-7"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`subtitle`](#subtitle-20)

<a id="subtitleconfig-7"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`subtitleConfig`](#subtitleconfig-20)

<a id="subtitlepadding-7"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`subtitlePadding`](#subtitlepadding-20)

<a id="svgdesc-7"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`svgDesc`](#svgdesc-20)

<a id="svgtitle-7"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`svgTitle`](#svgtitle-20)

<a id="threshold-7"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`threshold`](#threshold-20)

<a id="thresholdkey-7"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`thresholdKey`](#thresholdkey-20)

<a id="thresholdname-7"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`thresholdName`](#thresholdname-20)

<a id="time-7"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`time`](#time-20)

<a id="timefilter-7"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`timeFilter`](#timefilter-20)

<a id="timeline-7"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`timeline`](#timeline-21)

<a id="timelineconfig-7"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`timelineConfig`](#timelineconfig-21)

<a id="timelinedefault-7"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): `Date`[] \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

`Date`[] \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`timelineDefault`](#timelinedefault-20)

<a id="timelinepadding-7"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`timelinePadding`](#timelinepadding-21)

<a id="title-13"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`title`](#title-28)

<a id="titleconfig-13"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`titleConfig`](#titleconfig-27)

<a id="titlepadding-7"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`titlePadding`](#titlepadding-20)

<a id="tooltip-7"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`tooltip`](#tooltip-21)

<a id="tooltipconfig-7"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`tooltipConfig`](#tooltipconfig-21)

<a id="total-7"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`total`](#total-20)

<a id="totalconfig-7"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`totalConfig`](#totalconfig-20)

<a id="totalformat-7"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): ((`d`: `number`) => `string`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

((`d`: `number`) => `string`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`totalFormat`](#totalformat-20)

<a id="totalpadding-7"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`totalPadding`](#totalpadding-20)

<a id="width-16"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`width`](#width-33)

<a id="zoom-7"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`zoom`](#zoom-20)

<a id="zoombrushhandlesize-7"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleSize`](#zoombrushhandlesize-20)

<a id="zoombrushhandlestyle-7"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleStyle`](#zoombrushhandlestyle-20)

<a id="zoombrushselectionstyle-7"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`zoomBrushSelectionStyle`](#zoombrushselectionstyle-20)

<a id="zoomcontrolstyle-7"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyle`](#zoomcontrolstyle-20)

<a id="zoomcontrolstyleactive-7"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleActive`](#zoomcontrolstyleactive-20)

<a id="zoomcontrolstylehover-7"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleHover`](#zoomcontrolstylehover-20)

<a id="zoomfactor-7"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`zoomFactor`](#zoomfactor-20)

<a id="zoommax-7"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`zoomMax`](#zoommax-20)

<a id="zoompadding-7"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`zoomPadding`](#zoompadding-20)

<a id="zoompan-7"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`zoomPan`](#zoompan-20)

<a id="zoomscroll-7"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`Matrix`](#matrix)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Matrix`](#matrix)

###### Inherited from

[`Viz`](#viz).[`zoomScroll`](#zoomscroll-20)

***

<a id="network"></a>

### Network

Defined in: [charts/Network.ts:39](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Network.ts#L39)

Creates a network visualization based on a defined set of nodes and edges. [Click here](http://d3plus.org/examples/d3plus-network/getting-started/) for help getting started using the Network class.

#### Extends

- [`Viz`](#viz)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-14"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`active`](#active-29)

<a id="aggs-8"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Network`](#network)

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`aggs`](#aggs-20)

<a id="ariahidden-8"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`Network`](#network)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`ariaHidden`](#ariahidden-21)

<a id="attribution-8"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Network`](#network)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`attribution`](#attribution-20)

<a id="attributionstyle-8"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Network`](#network)

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`attributionStyle`](#attributionstyle-20)

<a id="backconfig-8"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Network`](#network)

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`backConfig`](#backconfig-20)

<a id="cache-8"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`cache`](#cache-20)

<a id="color-9"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`color`](#color-21)

<a id="colorscale-9"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`colorScale`](#colorscale-21)

<a id="colorscaleconfig-9"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Network`](#network)

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`colorScaleConfig`](#colorscaleconfig-21)

<a id="colorscalemaxsize-8"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`colorScaleMaxSize`](#colorscalemaxsize-20)

<a id="colorscalepadding-9"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`colorScalePadding`](#colorscalepadding-21)

<a id="colorscaleposition-8"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`colorScalePosition`](#colorscaleposition-20)

<a id="data-21"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): `DataPoint`[] \| [`Network`](#network)

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

`DataPoint`[] \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`data`](#data-39)

<a id="datacutoff-8"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`dataCutoff`](#datacutoff-20)

<a id="depth-8"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`depth`](#depth-20)

<a id="destroy-8"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`destroy`](#destroy-20)

<a id="detectresize-8"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`detectResize`](#detectresize-20)

<a id="detectresizedelay-8"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`detectResizeDelay`](#detectresizedelay-20)

<a id="detectvisible-8"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`detectVisible`](#detectvisible-20)

<a id="detectvisibleinterval-8"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`detectVisibleInterval`](#detectvisibleinterval-20)

<a id="discrete-12"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`discrete`](#discrete-27)

<a id="downloadbutton-8"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`downloadButton`](#downloadbutton-20)

<a id="downloadconfig-8"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Network`](#network)

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`downloadConfig`](#downloadconfig-20)

<a id="downloadposition-8"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`downloadPosition`](#downloadposition-20)

<a id="duration-20"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`duration`](#duration-37)

<a id="filter-8"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`filter`](#filter-20)

<a id="fontfamily-8"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| `string`[] \| [`Network`](#network)

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| `string`[] \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`fontFamily`](#fontfamily-21)

<a id="groupby-8"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Network`](#network)

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

(`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`groupBy`](#groupby-20)

<a id="height-17"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`height`](#height-33)

<a id="hiddencolor-8"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`hiddenColor`](#hiddencolor-20)

<a id="hiddenopacity-8"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`hiddenOpacity`](#hiddenopacity-20)

<a id="hover-14"></a>

##### hover()

> **hover**(`_`: `any`): [`Network`](#network)

Defined in: [charts/Network.ts:566](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Network.ts#L566)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

[`Network`](#network)

###### Overrides

[`Viz`](#viz).[`hover`](#hover-29)

<a id="label-13"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`label`](#label-28)

<a id="legend-9"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`legend`](#legend-21)

<a id="legendconfig-10"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Network`](#network)

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`legendConfig`](#legendconfig-22)

<a id="legendfilterinvert-8"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`legendFilterInvert`](#legendfilterinvert-20)

<a id="legendpadding-9"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`legendPadding`](#legendpadding-21)

<a id="legendposition-8"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| (() => `string`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| (() => `string`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`legendPosition`](#legendposition-20)

<a id="legendsort-8"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`legendSort`](#legendsort-20)

<a id="legendtooltip-8"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Network`](#network)

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`legendTooltip`](#legendtooltip-20)

<a id="links"></a>

##### links()

> **links**(`_`: `any`, `f?`: `any`): `any`

Defined in: [charts/Network.ts:586](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Network.ts#L586)

A predefined *Array* of edges that connect each object passed to the [node](#Network.node) method. The `source` and `target` keys in each link need to map to the nodes in one of three ways:
1. The index of the node in the nodes array (as in [this](http://d3plus.org/examples/d3plus-network/getting-started/) example).
2. The actual node *Object* itself.
3. A *String* value matching the `id` of the node.

The value passed should either be an *Array* of data or a *String* representing a filepath or URL to be loaded. An optional formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final links *Array*.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_` | `any` | - |
| `f?` | `any` | Array of link objects or a URL to load links from. |

###### Returns

`any`

<a id="linksize"></a>

##### linkSize()

> **linkSize**(`_?`: `any`): `any`

Defined in: [charts/Network.ts:597](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Network.ts#L597)

Defines the thickness of the links connecting each node. The value provided can be either a pixel Number to be used for all links, or an accessor function that returns a specific data value to be used in an automatically calculated linear scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `any` |

###### Returns

`any`

<a id="linksizemin"></a>

##### linkSizeMin()

> **linkSizeMin**(`_?`: `any`): `any`

Defined in: [charts/Network.ts:606](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Network.ts#L606)

Defines the minimum pixel stroke width used in link sizing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `any` |

###### Returns

`any`

<a id="linksizescale"></a>

##### linkSizeScale()

> **linkSizeScale**(`_?`: `any`): `any`

Defined in: [charts/Network.ts:615](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Network.ts#L615)

The type of [continuous d3-scale](https://github.com/d3/d3-scale#continuous-scales) used when calculating the pixel size of links in the network.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `any` |

###### Returns

`any`

<a id="loadinghtml-8"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`loadingHTML`](#loadinghtml-20)

<a id="loadingmessage-8"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`loadingMessage`](#loadingmessage-20)

<a id="messagemask-8"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`messageMask`](#messagemask-20)

<a id="messagestyle-8"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Network`](#network)

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`messageStyle`](#messagestyle-20)

<a id="nodatahtml-8"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`noDataHTML`](#nodatahtml-20)

<a id="nodatamessage-8"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`noDataMessage`](#nodatamessage-20)

<a id="nodegroupby"></a>

##### nodeGroupBy()

> **nodeGroupBy**(`_?`: `any`): `any`

Defined in: [charts/Network.ts:624](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Network.ts#L624)

The node group accessor(s). This method overrides the default .groupBy() function from being used with the data passed to .nodes().

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `any` |

###### Returns

`any`

<a id="nodes"></a>

##### nodes()

> **nodes**(`_`: `any`, `f?`: `any`): `any`

Defined in: [charts/Network.ts:650](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Network.ts#L650)

The list of nodes to be used for drawing the network. The value passed should either be an *Array* of data or a *String* representing a filepath or URL to be loaded.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final node *Array*.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_` | `any` | - |
| `f?` | `any` | Array of node objects or a URL to load nodes from. |

###### Returns

`any`

<a id="render-21"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`render`](#render-38)

<a id="scrollcontainer-8"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| `HTMLElement` \| `Window` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| `HTMLElement` \| `Window` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`scrollContainer`](#scrollcontainer-20)

<a id="select-21"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Network`](#network)

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

`Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`select`](#select-38)

<a id="shape-14"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`shape`](#shape-28)

<a id="shapeconfig-21"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Network`](#network)

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`shapeConfig`](#shapeconfig-40)

<a id="size-6"></a>

##### size()

> **size**(`_?`: `any`): `any`

Defined in: [charts/Network.ts:661](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Network.ts#L661)

The size accessor for each node in the network.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `any` |

###### Returns

`any`

<a id="sizemax-5"></a>

##### sizeMax()

> **sizeMax**(`_?`: `any`): `any`

Defined in: [charts/Network.ts:670](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Network.ts#L670)

Defines the maximum pixel radius used in size scaling. By default, the maximum size is determined by half the distance of the two closest nodes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `any` |

###### Returns

`any`

<a id="sizemin-5"></a>

##### sizeMin()

> **sizeMin**(`_?`: `any`): `any`

Defined in: [charts/Network.ts:677](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Network.ts#L677)

Defines the minimum pixel radius used in size scaling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `any` |

###### Returns

`any`

<a id="sizescale-5"></a>

##### sizeScale()

> **sizeScale**(`_?`: `any`): `any`

Defined in: [charts/Network.ts:684](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Network.ts#L684)

The type of [continuous d3-scale](https://github.com/d3/d3-scale#continuous-scales) used when calculating the pixel size of nodes in the network.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `any` |

###### Returns

`any`

<a id="subtitle-8"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`subtitle`](#subtitle-20)

<a id="subtitleconfig-8"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Network`](#network)

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`subtitleConfig`](#subtitleconfig-20)

<a id="subtitlepadding-8"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`subtitlePadding`](#subtitlepadding-20)

<a id="svgdesc-8"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`svgDesc`](#svgdesc-20)

<a id="svgtitle-8"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`svgTitle`](#svgtitle-20)

<a id="threshold-8"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`threshold`](#threshold-20)

<a id="thresholdkey-8"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`thresholdKey`](#thresholdkey-20)

<a id="thresholdname-8"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`thresholdName`](#thresholdname-20)

<a id="time-8"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`time`](#time-20)

<a id="timefilter-8"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`timeFilter`](#timefilter-20)

<a id="timeline-8"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`timeline`](#timeline-21)

<a id="timelineconfig-8"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Network`](#network)

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`timelineConfig`](#timelineconfig-21)

<a id="timelinedefault-8"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): `Date`[] \| [`Network`](#network)

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

`Date`[] \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`timelineDefault`](#timelinedefault-20)

<a id="timelinepadding-8"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`timelinePadding`](#timelinepadding-21)

<a id="title-14"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`title`](#title-28)

<a id="titleconfig-14"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Network`](#network)

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`titleConfig`](#titleconfig-27)

<a id="titlepadding-8"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`titlePadding`](#titlepadding-20)

<a id="tooltip-8"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`tooltip`](#tooltip-21)

<a id="tooltipconfig-8"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Network`](#network)

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`tooltipConfig`](#tooltipconfig-21)

<a id="total-8"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`total`](#total-20)

<a id="totalconfig-8"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Network`](#network)

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`totalConfig`](#totalconfig-20)

<a id="totalformat-8"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): ((`d`: `number`) => `string`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

((`d`: `number`) => `string`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`totalFormat`](#totalformat-20)

<a id="totalpadding-8"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Network`](#network)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`totalPadding`](#totalpadding-20)

<a id="width-17"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`width`](#width-33)

<a id="x-11"></a>

##### x()

> **x**(`_?`: `any`): `any`

Defined in: [charts/Network.ts:691](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Network.ts#L691)

The x position accessor for each node. The data passed to .data() takes priority over the .nodes() data array. By default, the x and y positions are determined dynamically based on default force layout properties.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `any` |

###### Returns

`any`

<a id="y-11"></a>

##### y()

> **y**(`_?`: `any`): `any`

Defined in: [charts/Network.ts:705](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Network.ts#L705)

The y position accessor for each node. The data passed to .data() takes priority over the .nodes() data array. By default, the x and y positions are determined dynamically based on default force layout properties.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `any` |

###### Returns

`any`

<a id="zoom-8"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`zoom`](#zoom-20)

<a id="zoombrushhandlesize-8"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleSize`](#zoombrushhandlesize-20)

<a id="zoombrushhandlestyle-8"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Network`](#network)

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleStyle`](#zoombrushhandlestyle-20)

<a id="zoombrushselectionstyle-8"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Network`](#network)

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`zoomBrushSelectionStyle`](#zoombrushselectionstyle-20)

<a id="zoomcontrolstyle-8"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Network`](#network)

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyle`](#zoomcontrolstyle-20)

<a id="zoomcontrolstyleactive-8"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Network`](#network)

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleActive`](#zoomcontrolstyleactive-20)

<a id="zoomcontrolstylehover-8"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Network`](#network)

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleHover`](#zoomcontrolstylehover-20)

<a id="zoomfactor-8"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`zoomFactor`](#zoomfactor-20)

<a id="zoommax-8"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`zoomMax`](#zoommax-20)

<a id="zoompadding-8"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`zoomPadding`](#zoompadding-20)

<a id="zoompan-8"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`zoomPan`](#zoompan-20)

<a id="zoomscroll-8"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`Network`](#network)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Network`](#network)

###### Inherited from

[`Viz`](#viz).[`zoomScroll`](#zoomscroll-20)

***

<a id="pack"></a>

### Pack

Defined in: [charts/Pack.ts:27](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Pack.ts#L27)

Uses the [d3 pack layout](https://github.com/d3/d3-hierarchy#pack) to creates Circle Packing chart based on an array of data.

#### Extends

- [`Viz`](#viz)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-15"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`active`](#active-29)

<a id="aggs-9"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`aggs`](#aggs-20)

<a id="ariahidden-9"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`ariaHidden`](#ariahidden-21)

<a id="attribution-9"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`attribution`](#attribution-20)

<a id="attributionstyle-9"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`attributionStyle`](#attributionstyle-20)

<a id="backconfig-9"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`backConfig`](#backconfig-20)

<a id="cache-9"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`cache`](#cache-20)

<a id="color-10"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`color`](#color-21)

<a id="colorscale-10"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`colorScale`](#colorscale-21)

<a id="colorscaleconfig-10"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`colorScaleConfig`](#colorscaleconfig-21)

<a id="colorscalemaxsize-9"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`colorScaleMaxSize`](#colorscalemaxsize-20)

<a id="colorscalepadding-10"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`colorScalePadding`](#colorscalepadding-21)

<a id="colorscaleposition-9"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`colorScalePosition`](#colorscaleposition-20)

<a id="data-22"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): `DataPoint`[] \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

`DataPoint`[] \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`data`](#data-39)

<a id="datacutoff-9"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`dataCutoff`](#datacutoff-20)

<a id="depth-9"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`depth`](#depth-20)

<a id="destroy-9"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`destroy`](#destroy-20)

<a id="detectresize-9"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`detectResize`](#detectresize-20)

<a id="detectresizedelay-9"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`detectResizeDelay`](#detectresizedelay-20)

<a id="detectvisible-9"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`detectVisible`](#detectvisible-20)

<a id="detectvisibleinterval-9"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`detectVisibleInterval`](#detectvisibleinterval-20)

<a id="discrete-13"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`discrete`](#discrete-27)

<a id="downloadbutton-9"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`downloadButton`](#downloadbutton-20)

<a id="downloadconfig-9"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`downloadConfig`](#downloadconfig-20)

<a id="downloadposition-9"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`downloadPosition`](#downloadposition-20)

<a id="duration-21"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`duration`](#duration-37)

<a id="filter-9"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`filter`](#filter-20)

<a id="fontfamily-9"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| `string`[] \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| `string`[] \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`fontFamily`](#fontfamily-21)

<a id="groupby-9"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

(`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`groupBy`](#groupby-20)

<a id="height-18"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`height`](#height-33)

<a id="hiddencolor-9"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`hiddenColor`](#hiddencolor-20)

<a id="hiddenopacity-9"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`hiddenOpacity`](#hiddenopacity-20)

<a id="hover-15"></a>

##### hover()

> **hover**(`_`: `any`): [`Pack`](#pack)

Defined in: [charts/Pack.ts:151](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Pack.ts#L151)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

[`Pack`](#pack)

###### Overrides

[`Viz`](#viz).[`hover`](#hover-29)

<a id="label-14"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`label`](#label-28)

<a id="layoutpadding"></a>

##### layoutPadding()

> **layoutPadding**(`_`: `any`): `any`

Defined in: [charts/Pack.ts:162](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Pack.ts#L162)

The inner and outer padding for the pack layout.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="legend-10"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`legend`](#legend-21)

<a id="legendconfig-11"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`legendConfig`](#legendconfig-22)

<a id="legendfilterinvert-9"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`legendFilterInvert`](#legendfilterinvert-20)

<a id="legendpadding-10"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`legendPadding`](#legendpadding-21)

<a id="legendposition-9"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| (() => `string`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| (() => `string`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`legendPosition`](#legendposition-20)

<a id="legendsort-9"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`legendSort`](#legendsort-20)

<a id="legendtooltip-9"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`legendTooltip`](#legendtooltip-20)

<a id="loadinghtml-9"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`loadingHTML`](#loadinghtml-20)

<a id="loadingmessage-9"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`loadingMessage`](#loadingmessage-20)

<a id="messagemask-9"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`messageMask`](#messagemask-20)

<a id="messagestyle-9"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`messageStyle`](#messagestyle-20)

<a id="nodatahtml-9"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`noDataHTML`](#nodatahtml-20)

<a id="nodatamessage-9"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`noDataMessage`](#nodatamessage-20)

<a id="packopacity"></a>

##### packOpacity()

> **packOpacity**(`_`: `any`): `any`

Defined in: [charts/Pack.ts:171](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Pack.ts#L171)

The opacity of nested circles within the pack layout.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="render-22"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`render`](#render-38)

<a id="scrollcontainer-9"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| `HTMLElement` \| `Window` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| `HTMLElement` \| `Window` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`scrollContainer`](#scrollcontainer-20)

<a id="select-22"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

`Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`select`](#select-38)

<a id="shape-15"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`shape`](#shape-28)

<a id="shapeconfig-22"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`shapeConfig`](#shapeconfig-40)

<a id="sort-5"></a>

##### sort()

> **sort**(`_`: `any`): `any`

Defined in: [charts/Pack.ts:185](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Pack.ts#L185)

Sort comparator function for the pack layout. Defaults to descending order by the associated input data's numeric value attribute.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Example

```ts
function comparator(a, b) {
return b.value - a.value;
}
```

<a id="subtitle-9"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`subtitle`](#subtitle-20)

<a id="subtitleconfig-9"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`subtitleConfig`](#subtitleconfig-20)

<a id="subtitlepadding-9"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`subtitlePadding`](#subtitlepadding-20)

<a id="sum"></a>

##### sum()

> **sum**(`_`: `any`): `any`

Defined in: [charts/Pack.ts:197](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Pack.ts#L197)

The sum accessor used for sizing each circle in the pack layout.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Example

```ts
function sum(d) {
return d.sum;
}
```

<a id="svgdesc-9"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`svgDesc`](#svgdesc-20)

<a id="svgtitle-9"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`svgTitle`](#svgtitle-20)

<a id="threshold-9"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`threshold`](#threshold-20)

<a id="thresholdkey-9"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`thresholdKey`](#thresholdkey-20)

<a id="thresholdname-9"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`thresholdName`](#thresholdname-20)

<a id="time-9"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`time`](#time-20)

<a id="timefilter-9"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`timeFilter`](#timefilter-20)

<a id="timeline-9"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`timeline`](#timeline-21)

<a id="timelineconfig-9"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`timelineConfig`](#timelineconfig-21)

<a id="timelinedefault-9"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): `Date`[] \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

`Date`[] \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`timelineDefault`](#timelinedefault-20)

<a id="timelinepadding-9"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`timelinePadding`](#timelinepadding-21)

<a id="title-15"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`title`](#title-28)

<a id="titleconfig-15"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`titleConfig`](#titleconfig-27)

<a id="titlepadding-9"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`titlePadding`](#titlepadding-20)

<a id="tooltip-9"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`tooltip`](#tooltip-21)

<a id="tooltipconfig-9"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`tooltipConfig`](#tooltipconfig-21)

<a id="total-9"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`total`](#total-20)

<a id="totalconfig-9"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`totalConfig`](#totalconfig-20)

<a id="totalformat-9"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): ((`d`: `number`) => `string`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

((`d`: `number`) => `string`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`totalFormat`](#totalformat-20)

<a id="totalpadding-9"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`totalPadding`](#totalpadding-20)

<a id="width-18"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`width`](#width-33)

<a id="zoom-9"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`zoom`](#zoom-20)

<a id="zoombrushhandlesize-9"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleSize`](#zoombrushhandlesize-20)

<a id="zoombrushhandlestyle-9"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleStyle`](#zoombrushhandlestyle-20)

<a id="zoombrushselectionstyle-9"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`zoomBrushSelectionStyle`](#zoombrushselectionstyle-20)

<a id="zoomcontrolstyle-9"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyle`](#zoomcontrolstyle-20)

<a id="zoomcontrolstyleactive-9"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleActive`](#zoomcontrolstyleactive-20)

<a id="zoomcontrolstylehover-9"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleHover`](#zoomcontrolstylehover-20)

<a id="zoomfactor-9"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`zoomFactor`](#zoomfactor-20)

<a id="zoommax-9"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`zoomMax`](#zoommax-20)

<a id="zoompadding-9"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`zoomPadding`](#zoompadding-20)

<a id="zoompan-9"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`zoomPan`](#zoompan-20)

<a id="zoomscroll-9"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`Pack`](#pack)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pack`](#pack)

###### Inherited from

[`Viz`](#viz).[`zoomScroll`](#zoomscroll-20)

***

<a id="path"></a>

### Path

Defined in: [shapes/Path.ts:12](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Path.ts#L12)

Creates SVG Paths based on an array of data.

#### Extends

- [`Shape`](#shape-23)

#### Methods

<a id="_datafilter-2"></a>

##### \_dataFilter()?

> `optional` **\_dataFilter**(`data`: `DataPoint`[]): `DataPoint`[]

Defined in: [shapes/Shape.ts:105](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L105)

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `data` | `DataPoint`[] | The raw data array to filter. |

###### Returns

`DataPoint`[]

###### Inherited from

[`Shape`](#shape-23).[`_dataFilter`](#_datafilter-4)

<a id="active-16"></a>

##### active()

###### Call Signature

> **active**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

Defined in: [shapes/Shape.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1019)

The active callback function for highlighting shapes.

###### Returns

((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

###### Inherited from

[`Shape`](#shape-23).[`active`](#active-25)

###### Call Signature

> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1020](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1020)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`active`](#active-25)

<a id="activeopacity-4"></a>

##### activeOpacity()

###### Call Signature

> **activeOpacity**(): `number`

Defined in: [shapes/Shape.ts:1037](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1037)

When shapes are active, this is the opacity of any shape that is not active.

###### Returns

`number`

###### Inherited from

[`Shape`](#shape-23).[`activeOpacity`](#activeopacity-6)

###### Call Signature

> **activeOpacity**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1038](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1038)

When shapes are active, this is the opacity of any shape that is not active.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`activeOpacity`](#activeopacity-6)

<a id="activestyle-4"></a>

##### activeStyle()

###### Call Signature

> **activeStyle**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1048](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1048)

The style to apply to active shapes.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`activeStyle`](#activestyle-6)

###### Call Signature

> **activeStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1049](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1049)

The style to apply to active shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`activeStyle`](#activestyle-6)

<a id="arialabel-4"></a>

##### ariaLabel()

###### Call Signature

> **ariaLabel**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1059](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1059)

The aria-label attribute for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`ariaLabel`](#arialabel-6)

###### Call Signature

> **ariaLabel**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1060](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1060)

The aria-label attribute for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`ariaLabel`](#arialabel-6)

<a id="backgroundimage-4"></a>

##### backgroundImage()

###### Call Signature

> **backgroundImage**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1070](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1070)

The background-image accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`backgroundImage`](#backgroundimage-6)

###### Call Signature

> **backgroundImage**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1071](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1071)

The background-image accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`backgroundImage`](#backgroundimage-6)

<a id="config-13"></a>

##### config()

###### Call Signature

> **config**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L91)

Methods that correspond to the key/value pairs and returns this class.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`Shape`](#shape-23).[`config`](#config-15)

###### Call Signature

> **config**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L92)

Methods that correspond to the key/value pairs and returns this class.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`config`](#config-15)

<a id="d"></a>

##### d()

###### Call Signature

> **d**(): `AccessorFn`

Defined in: [shapes/Path.ts:102](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Path.ts#L102)

The "d" attribute.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.path;
}
```

###### Call Signature

> **d**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Path.ts:103](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Path.ts#L103)

The "d" attribute.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.path;
}
```

<a id="data-23"></a>

##### data()

###### Call Signature

> **data**(): `DataPoint`[]

Defined in: [shapes/Shape.ts:1082](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1082)

The data array used to create shapes. A shape will be drawn for each object in the array.

###### Returns

`DataPoint`[]

###### Inherited from

[`Shape`](#shape-23).[`data`](#data-32)

###### Call Signature

> **data**(`_`: `DataPoint`[]): `this`

Defined in: [shapes/Shape.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1083)

The data array used to create shapes. A shape will be drawn for each object in the array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `DataPoint`[] |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`data`](#data-32)

<a id="discrete-14"></a>

##### discrete()

###### Call Signature

> **discrete**(): `string` \| `undefined`

Defined in: [shapes/Shape.ts:1091](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1091)

Determines if either the X or Y position is discrete along a Line, which helps in determining the nearest data point on a line for a hit area event.

###### Returns

`string` \| `undefined`

###### Inherited from

[`Shape`](#shape-23).[`discrete`](#discrete-23)

###### Call Signature

> **discrete**(`_`: `string`): `this`

Defined in: [shapes/Shape.ts:1092](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1092)

Determines if either the X or Y position is discrete along a Line, which helps in determining the nearest data point on a line for a hit area event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`discrete`](#discrete-23)

<a id="duration-22"></a>

##### duration()

###### Call Signature

> **duration**(): `number`

Defined in: [shapes/Shape.ts:1100](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1100)

The animation duration in milliseconds.

###### Returns

`number`

###### Inherited from

[`Shape`](#shape-23).[`duration`](#duration-31)

###### Call Signature

> **duration**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1101](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1101)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`duration`](#duration-31)

<a id="fill-4"></a>

##### fill()

###### Call Signature

> **fill**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1109](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1109)

The fill color accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`fill`](#fill-6)

###### Call Signature

> **fill**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1110](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1110)

The fill color accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`fill`](#fill-6)

<a id="fillopacity-4"></a>

##### fillOpacity()

###### Call Signature

> **fillOpacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1120](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1120)

Defines the "fill-opacity" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`fillOpacity`](#fillopacity-6)

###### Call Signature

> **fillOpacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1121](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1121)

Defines the "fill-opacity" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`fillOpacity`](#fillopacity-6)

<a id="hitarea-4"></a>

##### hitArea()

###### Call Signature

> **hitArea**(): ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) \| `null`

Defined in: [shapes/Shape.ts:1180](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1180)

The mouse hit area accessor function.

###### Returns

((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) \| `null`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`hitArea`](#hitarea-6)

###### Call Signature

> **hitArea**(`_`: `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>)): `this`

Defined in: [shapes/Shape.ts:1187](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1187)

The mouse hit area accessor function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) |

###### Returns

`this`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`hitArea`](#hitarea-6)

<a id="hover-16"></a>

##### hover()

###### Call Signature

> **hover**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

Defined in: [shapes/Shape.ts:1131](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1131)

The hover callback function for highlighting shapes on mouseover.

###### Returns

((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

###### Inherited from

[`Shape`](#shape-23).[`hover`](#hover-25)

###### Call Signature

> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1132](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1132)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`hover`](#hover-25)

<a id="hoveropacity-4"></a>

##### hoverOpacity()

###### Call Signature

> **hoverOpacity**(): `number`

Defined in: [shapes/Shape.ts:1160](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1160)

The opacity of non-hovered shapes when any shape is hovered.

###### Returns

`number`

###### Inherited from

[`Shape`](#shape-23).[`hoverOpacity`](#hoveropacity-6)

###### Call Signature

> **hoverOpacity**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1161](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1161)

The opacity of non-hovered shapes when any shape is hovered.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`hoverOpacity`](#hoveropacity-6)

<a id="hoverstyle-4"></a>

##### hoverStyle()

###### Call Signature

> **hoverStyle**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1149](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1149)

The style to apply to hovered shapes.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`hoverStyle`](#hoverstyle-6)

###### Call Signature

> **hoverStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1150)

The style to apply to hovered shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`hoverStyle`](#hoverstyle-6)

<a id="id-6"></a>

##### id()

###### Call Signature

> **id**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1220](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1220)

The unique id accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`id`](#id-8)

###### Call Signature

> **id**(`_`: `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1221](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1221)

The unique id accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`id`](#id-8)

<a id="label-15"></a>

##### label()

###### Call Signature

> **label**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1229](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1229)

The text label accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`label`](#label-24)

###### Call Signature

> **label**(`_`: `string` \| `string`[] \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1230](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1230)

The text label accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `string`[] \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`label`](#label-24)

<a id="labelbounds-4"></a>

##### labelBounds()

###### Call Signature

> **labelBounds**(): ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null`

Defined in: [shapes/Shape.ts:1251](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1251)

The label bounds accessor function.

###### Returns

((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`labelBounds`](#labelbounds-6)

###### Call Signature

> **labelBounds**(`_`: `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`)): `this`

Defined in: [shapes/Shape.ts:1258](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1258)

The label bounds accessor function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) |

###### Returns

`this`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`labelBounds`](#labelbounds-6)

<a id="labelconfig-5"></a>

##### labelConfig()

###### Call Signature

> **labelConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1291](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1291)

A pass-through to the config method of the TextBox class used to create a shape's labels.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`labelConfig`](#labelconfig-7)

###### Call Signature

> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1292](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1292)

A pass-through to the config method of the TextBox class used to create a shape's labels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`labelConfig`](#labelconfig-7)

<a id="locale-13"></a>

##### locale()

###### Call Signature

> **locale**(): `string`

Defined in: [utils/BaseClass.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L156)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Returns

`string`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Shape`](#shape-23).[`locale`](#locale-15)

###### Call Signature

> **locale**(`_`: `string` \| `object`): `this`

Defined in: [utils/BaseClass.ts:157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L157)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `object` |

###### Returns

`this`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Shape`](#shape-23).[`locale`](#locale-15)

<a id="on-13"></a>

##### on()

###### Call Signature

> **on**(): `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

Defined in: [utils/BaseClass.ts:176](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L176)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Returns

`Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

###### Call Signature

> **on**(`_`: `string`): ((...`args`: `unknown`[]) => `unknown`) \| `undefined`

Defined in: [utils/BaseClass.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L177)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

((...`args`: `unknown`[]) => `unknown`) \| `undefined`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

###### Call Signature

> **on**(`_`: `string`, `f`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [utils/BaseClass.ts:178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L178)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |
| `f` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

###### Call Signature

> **on**(`_`: `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:179](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L179)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

<a id="opacity-5"></a>

##### opacity()

###### Call Signature

> **opacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1302](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1302)

The opacity accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`opacity`](#opacity-7)

###### Call Signature

> **opacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1303](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1303)

The opacity accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`opacity`](#opacity-7)

<a id="parent-13"></a>

##### parent()

###### Call Signature

> **parent**(): `Record`\<`string`, `unknown`\>

Defined in: [utils/BaseClass.ts:200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L200)

Parent config used by the wrapper.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`parent`](#parent-15)

###### Call Signature

> **parent**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L201)

Parent config used by the wrapper.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`parent`](#parent-15)

<a id="pointerevents-5"></a>

##### pointerEvents()

###### Call Signature

> **pointerEvents**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1313](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1313)

The pointer-events CSS property for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`pointerEvents`](#pointerevents-7)

###### Call Signature

> **pointerEvents**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1314](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1314)

The pointer-events CSS property for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`pointerEvents`](#pointerevents-7)

<a id="render-23"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [shapes/Path.ts:74](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Path.ts#L74)

Draws the paths.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Overrides

[`Shape`](#shape-23).[`render`](#render-32)

<a id="role-4"></a>

##### role()

###### Call Signature

> **role**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1325](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1325)

The role attribute.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`role`](#role-6)

###### Call Signature

> **role**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1326](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1326)

The role attribute.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`role`](#role-6)

<a id="rotate-4"></a>

##### rotate()

###### Call Signature

> **rotate**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1336](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1336)

The rotation angle in degrees for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`rotate`](#rotate-6)

###### Call Signature

> **rotate**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1337](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1337)

The rotation angle in degrees for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`rotate`](#rotate-6)

<a id="rx-4"></a>

##### rx()

###### Call Signature

> **rx**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1347](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1347)

Defines the "rx" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`rx`](#rx-6)

###### Call Signature

> **rx**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1348](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1348)

Defines the "rx" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`rx`](#rx-6)

<a id="ry-4"></a>

##### ry()

###### Call Signature

> **ry**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1358](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1358)

Defines the "rx" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`ry`](#ry-6)

###### Call Signature

> **ry**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1359](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1359)

Defines the "rx" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`ry`](#ry-6)

<a id="scale-10"></a>

##### scale()

###### Call Signature

> **scale**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1369](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1369)

The scale transform accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`scale`](#scale-12)

###### Call Signature

> **scale**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1370](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1370)

The scale transform accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`scale`](#scale-12)

<a id="select-23"></a>

##### select()

###### Call Signature

> **select**(): `Selection`

Defined in: [shapes/Shape.ts:1380](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1380)

The SVG container element as a d3 selector or DOM element.

###### Returns

`Selection`

###### Inherited from

[`Shape`](#shape-23).[`select`](#select-32)

###### Call Signature

> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`

Defined in: [shapes/Shape.ts:1381](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1381)

The SVG container element as a d3 selector or DOM element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `HTMLElement` \| `SVGElement` \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`select`](#select-32)

<a id="shapeconfig-23"></a>

##### shapeConfig()

###### Call Signature

> **shapeConfig**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L225)

Configuration object with key/value pairs applied as method calls on each shape.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`Shape`](#shape-23).[`shapeConfig`](#shapeconfig-33)

###### Call Signature

> **shapeConfig**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:226](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L226)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`shapeConfig`](#shapeconfig-33)

<a id="shaperendering-4"></a>

##### shapeRendering()

###### Call Signature

> **shapeRendering**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1396](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1396)

The shape-rendering.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`shapeRendering`](#shaperendering-6)

###### Call Signature

> **shapeRendering**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1397)

The shape-rendering.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`shapeRendering`](#shaperendering-6)

<a id="sort-6"></a>

##### sort()

###### Call Signature

> **sort**(): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`

Defined in: [shapes/Shape.ts:1408](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1408)

A comparator function used to sort shapes for layering order.

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`

###### Inherited from

[`Shape`](#shape-23).[`sort`](#sort-9)

###### Call Signature

> **sort**(`_`: ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1409](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1409)

A comparator function used to sort shapes for layering order.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`sort`](#sort-9)

<a id="stroke-4"></a>

##### stroke()

###### Call Signature

> **stroke**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1419](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1419)

The stroke color accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`stroke`](#stroke-6)

###### Call Signature

> **stroke**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1420](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1420)

The stroke color accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`stroke`](#stroke-6)

<a id="strokedasharray-4"></a>

##### strokeDasharray()

###### Call Signature

> **strokeDasharray**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1430](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1430)

Defines the "stroke-dasharray" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeDasharray`](#strokedasharray-6)

###### Call Signature

> **strokeDasharray**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1431](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1431)

Defines the "stroke-dasharray" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeDasharray`](#strokedasharray-6)

<a id="strokelinecap-4"></a>

##### strokeLinecap()

###### Call Signature

> **strokeLinecap**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1442](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1442)

Defines the "stroke-linecap" attribute for the shapes. Accepted values are `"butt"`, `"round"`, and `"square"`.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeLinecap`](#strokelinecap-6)

###### Call Signature

> **strokeLinecap**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1443](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1443)

Defines the "stroke-linecap" attribute for the shapes. Accepted values are `"butt"`, `"round"`, and `"square"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeLinecap`](#strokelinecap-6)

<a id="strokeopacity-4"></a>

##### strokeOpacity()

###### Call Signature

> **strokeOpacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1454](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1454)

Defines the "stroke-opacity" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeOpacity`](#strokeopacity-6)

###### Call Signature

> **strokeOpacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1455](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1455)

Defines the "stroke-opacity" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeOpacity`](#strokeopacity-6)

<a id="strokewidth-4"></a>

##### strokeWidth()

###### Call Signature

> **strokeWidth**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1466](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1466)

The stroke-width.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeWidth`](#strokewidth-6)

###### Call Signature

> **strokeWidth**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1467](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1467)

The stroke-width.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeWidth`](#strokewidth-6)

<a id="textanchor-4"></a>

##### textAnchor()

###### Call Signature

> **textAnchor**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1477](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1477)

The text-anchor.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`textAnchor`](#textanchor-6)

###### Call Signature

> **textAnchor**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1478](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1478)

The text-anchor.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`textAnchor`](#textanchor-6)

<a id="texture-4"></a>

##### texture()

###### Call Signature

> **texture**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1488](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1488)

Defines the texture used inside of each shape. This uses the [textures.js](https://riccardoscalco.it/textures/) package, and expects either a simple string (`"lines"` or `"circles"`) or a more complex Object containing the various properties of the texture (ie. `{texture: "lines", orientation: "3/8", stroke: "darkorange"}`). If multiple textures are necessary, provide an accsesor Function that returns the correct String/Object for each given data point and index.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`texture`](#texture-6)

###### Call Signature

> **texture**(`_`: `string` \| `Record`\<`string`, `unknown`\> \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1489](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1489)

Defines the texture used inside of each shape. This uses the [textures.js](https://riccardoscalco.it/textures/) package, and expects either a simple string (`"lines"` or `"circles"`) or a more complex Object containing the various properties of the texture (ie. `{texture: "lines", orientation: "3/8", stroke: "darkorange"}`). If multiple textures are necessary, provide an accsesor Function that returns the correct String/Object for each given data point and index.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `Record`\<`string`, `unknown`\> \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`texture`](#texture-6)

<a id="texturedefault-4"></a>

##### textureDefault()

###### Call Signature

> **textureDefault**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1503)

A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`textureDefault`](#texturedefault-6)

###### Call Signature

> **textureDefault**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1504](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1504)

A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`textureDefault`](#texturedefault-6)

<a id="translate-13"></a>

##### translate()

###### Call Signature

> **translate**(): (`d`: `string`, `locale?`: `string`) => `string`

Defined in: [utils/BaseClass.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L214)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Returns

(`d`: `string`, `locale?`: `string`) => `string`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Shape`](#shape-23).[`translate`](#translate-15)

###### Call Signature

> **translate**(`_`: (`d`: `string`, `locale?`: `string`) => `string`): `this`

Defined in: [utils/BaseClass.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L215)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `string`, `locale?`: `string`) => `string` |

###### Returns

`this`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Shape`](#shape-23).[`translate`](#translate-15)

<a id="vectoreffect-4"></a>

##### vectorEffect()

###### Call Signature

> **vectorEffect**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1514](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1514)

The vector-effect.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`vectorEffect`](#vectoreffect-6)

###### Call Signature

> **vectorEffect**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1515](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1515)

The vector-effect.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`vectorEffect`](#vectoreffect-6)

<a id="verticalalign-5"></a>

##### verticalAlign()

###### Call Signature

> **verticalAlign**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1525](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1525)

The vertical alignment.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`verticalAlign`](#verticalalign-7)

###### Call Signature

> **verticalAlign**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1526](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1526)

The vertical alignment.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`verticalAlign`](#verticalalign-7)

<a id="x-12"></a>

##### x()

###### Call Signature

> **x**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1542](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1542)

The x position accessor for each shape.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`x`](#x-15)

###### Call Signature

> **x**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1543)

The x position accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`x`](#x-15)

<a id="y-12"></a>

##### y()

###### Call Signature

> **y**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1558](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1558)

The y position accessor for each shape.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.y;
}
```

###### Inherited from

[`Shape`](#shape-23).[`y`](#y-15)

###### Call Signature

> **y**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1559](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1559)

The y position accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.y;
}
```

###### Inherited from

[`Shape`](#shape-23).[`y`](#y-15)

#### Properties

| Property | Type | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="property-_active-4"></a> `_active` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | - | [`Shape`](#shape-23).[`_active`](#property-_active-6) | [shapes/Shape.ts:116](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L116) |
| <a id="property-_activegroup-4"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-23).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:112](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L112) |
| <a id="property-_activeopacity-4"></a> `_activeOpacity` | `number` | - | [`Shape`](#shape-23).[`_activeOpacity`](#property-_activeopacity-6) | [shapes/Shape.ts:57](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L57) |
| <a id="property-_activestyle-4"></a> `_activeStyle` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_activeStyle`](#property-_activestyle-6) | [shapes/Shape.ts:58](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L58) |
| <a id="property-_arialabel-4"></a> `_ariaLabel` | `AccessorFn` | - | [`Shape`](#shape-23).[`_ariaLabel`](#property-_arialabel-6) | [shapes/Shape.ts:59](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L59) |
| <a id="property-_backgroundimage-4"></a> `_backgroundImage` | `AccessorFn` | - | [`Shape`](#shape-23).[`_backgroundImage`](#property-_backgroundimage-6) | [shapes/Shape.ts:60](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L60) |
| <a id="property-_backgroundimageclass-4"></a> `_backgroundImageClass` | [`Image`](#image) | - | [`Shape`](#shape-23).[`_backgroundImageClass`](#property-_backgroundimageclass-6) | [shapes/Shape.ts:61](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L61) |
| <a id="property-_configdefault-13"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | - | [`Shape`](#shape-23).[`_configDefault`](#property-_configdefault-15) | [utils/BaseClass.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L69) |
| <a id="property-_curve-4"></a> `_curve` | `AccessorFn` | - | [`Shape`](#shape-23).[`_curve`](#property-_curve-6) | [shapes/Shape.ts:121](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L121) |
| <a id="property-_d"></a> `_d` | `AccessorFn` | - | - | [shapes/Path.ts:13](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Path.ts#L13) |
| <a id="property-_data-13"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-23).[`_data`](#property-_data-15) | [shapes/Shape.ts:62](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L62) |
| <a id="property-_defined-4"></a> `_defined` | `AccessorFn` | - | [`Shape`](#shape-23).[`_defined`](#property-_defined-6) | [shapes/Shape.ts:120](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L120) |
| <a id="property-_discrete-4"></a> `_discrete` | `string` \| *required* | - | [`Shape`](#shape-23).[`_discrete`](#property-_discrete-6) | [shapes/Shape.ts:118](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L118) |
| <a id="property-_duration-13"></a> `_duration` | `number` | - | [`Shape`](#shape-23).[`_duration`](#property-_duration-15) | [shapes/Shape.ts:63](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L63) |
| <a id="property-_enter-4"></a> `_enter` | `Selection` | - | [`Shape`](#shape-23).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:109](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L109) |
| <a id="property-_exit-4"></a> `_exit` | `Selection` | - | [`Shape`](#shape-23).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:110](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L110) |
| <a id="property-_fill-4"></a> `_fill` | `AccessorFn` | - | [`Shape`](#shape-23).[`_fill`](#property-_fill-6) | [shapes/Shape.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L64) |
| <a id="property-_fillopacity-4"></a> `_fillOpacity` | `AccessorFn` | - | [`Shape`](#shape-23).[`_fillOpacity`](#property-_fillopacity-6) | [shapes/Shape.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L65) |
| <a id="property-_group-11"></a> `_group` | `Selection` | - | [`Shape`](#shape-23).[`_group`](#property-_group-13) | [shapes/Shape.ts:107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L107) |
| <a id="property-_hitarea-4"></a> `_hitArea` | ((`d`: `DataPoint`, `i`: `number`, `aes`: `ShapeAes`) => `Record`\<`string`, `unknown`\>) \| `null` | - | [`Shape`](#shape-23).[`_hitArea`](#property-_hitarea-6) | [shapes/Shape.ts:113](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L113) |
| <a id="property-_hover-4"></a> `_hover` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | - | [`Shape`](#shape-23).[`_hover`](#property-_hover-6) | [shapes/Shape.ts:117](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L117) |
| <a id="property-_hovergroup-4"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-23).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:111](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L111) |
| <a id="property-_hoveropacity-4"></a> `_hoverOpacity` | `number` | - | [`Shape`](#shape-23).[`_hoverOpacity`](#property-_hoveropacity-6) | [shapes/Shape.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L66) |
| <a id="property-_hoverstyle-4"></a> `_hoverStyle` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_hoverStyle`](#property-_hoverstyle-6) | [shapes/Shape.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L67) |
| <a id="property-_id-6"></a> `_id` | `AccessorFn` | - | [`Shape`](#shape-23).[`_id`](#property-_id-8) | [shapes/Shape.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L68) |
| <a id="property-_label-5"></a> `_label` | `AccessorFn` | - | [`Shape`](#shape-23).[`_label`](#property-_label-7) | [shapes/Shape.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L69) |
| <a id="property-_labelbounds-4"></a> `_labelBounds` | ((`d`: `DataPoint`, `i`: `number`, `aes`: `ShapeAes`) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null` | [`Shape`](#shape-23).[`_labelBounds`](#property-_labelbounds-6) | - | [shapes/Path.ts:14](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Path.ts#L14) |
| <a id="property-_labelclass-5"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-23).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L70) |
| <a id="property-_labelconfig-5"></a> `_labelConfig` | `Record`\<`string`, `unknown`\> | [`Shape`](#shape-23).[`_labelConfig`](#property-_labelconfig-7) | - | [shapes/Path.ts:22](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Path.ts#L22) |
| <a id="property-_locale-13"></a> `_locale` | `string` | - | [`Shape`](#shape-23).[`_locale`](#property-_locale-15) | [utils/BaseClass.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L64) |
| <a id="property-_name-4"></a> `_name` | `string` | [`Shape`](#shape-23).[`_name`](#property-_name-6) | - | [shapes/Path.ts:21](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Path.ts#L21) |
| <a id="property-_on-13"></a> `_on` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | - | [`Shape`](#shape-23).[`_on`](#property-_on-15) | [utils/BaseClass.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L65) |
| <a id="property-_opacity-5"></a> `_opacity` | `AccessorFn` | - | [`Shape`](#shape-23).[`_opacity`](#property-_opacity-7) | [shapes/Shape.ts:80](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L80) |
| <a id="property-_parent-13"></a> `_parent` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_parent`](#property-_parent-15) | [utils/BaseClass.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L66) |
| <a id="property-_path-4"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_path`](#property-_path-6) | [shapes/Shape.ts:119](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L119) |
| <a id="property-_pointerevents-5"></a> `_pointerEvents` | `AccessorFn` | - | [`Shape`](#shape-23).[`_pointerEvents`](#property-_pointerevents-7) | [shapes/Shape.ts:81](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L81) |
| <a id="property-_role-4"></a> `_role` | `AccessorFn` | - | [`Shape`](#shape-23).[`_role`](#property-_role-6) | [shapes/Shape.ts:82](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L82) |
| <a id="property-_rotate-4"></a> `_rotate` | `AccessorFn` | - | [`Shape`](#shape-23).[`_rotate`](#property-_rotate-6) | [shapes/Shape.ts:83](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L83) |
| <a id="property-_rx-4"></a> `_rx` | `AccessorFn` | - | [`Shape`](#shape-23).[`_rx`](#property-_rx-6) | [shapes/Shape.ts:84](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L84) |
| <a id="property-_ry-4"></a> `_ry` | `AccessorFn` | - | [`Shape`](#shape-23).[`_ry`](#property-_ry-6) | [shapes/Shape.ts:85](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L85) |
| <a id="property-_scale-10"></a> `_scale` | `AccessorFn` | - | [`Shape`](#shape-23).[`_scale`](#property-_scale-12) | [shapes/Shape.ts:86](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L86) |
| <a id="property-_select-13"></a> `_select` | `Selection` | - | [`Shape`](#shape-23).[`_select`](#property-_select-15) | [shapes/Shape.ts:102](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L102) |
| <a id="property-_shapeconfig-13"></a> `_shapeConfig?` | [`D3plusConfig`](#d3plusconfig) | - | [`Shape`](#shape-23).[`_shapeConfig`](#property-_shapeconfig-15) | [utils/BaseClass.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L70) |
| <a id="property-_shaperendering-4"></a> `_shapeRendering` | `AccessorFn` | - | [`Shape`](#shape-23).[`_shapeRendering`](#property-_shaperendering-6) | [shapes/Shape.ts:87](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L87) |
| <a id="property-_sort-4"></a> `_sort` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | - | [`Shape`](#shape-23).[`_sort`](#property-_sort-6) | [shapes/Shape.ts:106](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L106) |
| <a id="property-_stroke-4"></a> `_stroke` | `AccessorFn` | - | [`Shape`](#shape-23).[`_stroke`](#property-_stroke-6) | [shapes/Shape.ts:88](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L88) |
| <a id="property-_strokedasharray-4"></a> `_strokeDasharray` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeDasharray`](#property-_strokedasharray-6) | [shapes/Shape.ts:89](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L89) |
| <a id="property-_strokelinecap-4"></a> `_strokeLinecap` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeLinecap`](#property-_strokelinecap-6) | [shapes/Shape.ts:90](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L90) |
| <a id="property-_strokeopacity-4"></a> `_strokeOpacity` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeOpacity`](#property-_strokeopacity-6) | [shapes/Shape.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L91) |
| <a id="property-_strokewidth-4"></a> `_strokeWidth` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeWidth`](#property-_strokewidth-6) | [shapes/Shape.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L92) |
| <a id="property-_tagname-4"></a> `_tagName` | `string` | - | [`Shape`](#shape-23).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:93](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L93) |
| <a id="property-_textanchor-4"></a> `_textAnchor` | `AccessorFn` | - | [`Shape`](#shape-23).[`_textAnchor`](#property-_textanchor-6) | [shapes/Shape.ts:94](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L94) |
| <a id="property-_texture-4"></a> `_texture` | `AccessorFn` | - | [`Shape`](#shape-23).[`_texture`](#property-_texture-6) | [shapes/Shape.ts:95](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L95) |
| <a id="property-_texturedefault-4"></a> `_textureDefault` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_textureDefault`](#property-_texturedefault-6) | [shapes/Shape.ts:96](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L96) |
| <a id="property-_texturedefs-4"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-23).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:97](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L97) |
| <a id="property-_transition-9"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-23).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:103](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L103) |
| <a id="property-_translate-13"></a> `_translate` | (`d`: `string`, `locale?`: `string`) => `string` | - | [`Shape`](#shape-23).[`_translate`](#property-_translate-15) | [utils/BaseClass.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L67) |
| <a id="property-_update-4"></a> `_update` | `Selection` | - | [`Shape`](#shape-23).[`_update`](#property-_update-6) | [shapes/Shape.ts:108](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L108) |
| <a id="property-_uuid-13"></a> `_uuid` | `string` | - | [`Shape`](#shape-23).[`_uuid`](#property-_uuid-15) | [utils/BaseClass.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L68) |
| <a id="property-_vectoreffect-4"></a> `_vectorEffect` | `AccessorFn` | - | [`Shape`](#shape-23).[`_vectorEffect`](#property-_vectoreffect-6) | [shapes/Shape.ts:98](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L98) |
| <a id="property-_verticalalign-5"></a> `_verticalAlign` | `AccessorFn` | - | [`Shape`](#shape-23).[`_verticalAlign`](#property-_verticalalign-7) | [shapes/Shape.ts:99](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L99) |
| <a id="property-_x-6"></a> `_x` | `AccessorFn` | - | [`Shape`](#shape-23).[`_x`](#property-_x-8) | [shapes/Shape.ts:100](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L100) |
| <a id="property-_y-6"></a> `_y` | `AccessorFn` | - | [`Shape`](#shape-23).[`_y`](#property-_y-8) | [shapes/Shape.ts:101](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L101) |

***

<a id="pie"></a>

### Pie

Defined in: [charts/Pie.ts:13](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Pie.ts#L13)

Uses the [d3 pie layout](https://github.com/d3/d3-shape#pies) to creates SVG arcs based on an array of data.

#### Extends

- [`Viz`](#viz)

#### Extended by

- [`Donut`](#donut)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-17"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`active`](#active-29)

<a id="aggs-10"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`aggs`](#aggs-20)

<a id="ariahidden-10"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`ariaHidden`](#ariahidden-21)

<a id="attribution-10"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`attribution`](#attribution-20)

<a id="attributionstyle-10"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`attributionStyle`](#attributionstyle-20)

<a id="backconfig-10"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`backConfig`](#backconfig-20)

<a id="cache-10"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`cache`](#cache-20)

<a id="color-11"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`color`](#color-21)

<a id="colorscale-11"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`colorScale`](#colorscale-21)

<a id="colorscaleconfig-11"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`colorScaleConfig`](#colorscaleconfig-21)

<a id="colorscalemaxsize-10"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`colorScaleMaxSize`](#colorscalemaxsize-20)

<a id="colorscalepadding-11"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`colorScalePadding`](#colorscalepadding-21)

<a id="colorscaleposition-10"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`colorScalePosition`](#colorscaleposition-20)

<a id="data-24"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): `DataPoint`[] \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

`DataPoint`[] \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`data`](#data-39)

<a id="datacutoff-10"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`dataCutoff`](#datacutoff-20)

<a id="depth-10"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`depth`](#depth-20)

<a id="destroy-10"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`destroy`](#destroy-20)

<a id="detectresize-10"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`detectResize`](#detectresize-20)

<a id="detectresizedelay-10"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`detectResizeDelay`](#detectresizedelay-20)

<a id="detectvisible-10"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`detectVisible`](#detectvisible-20)

<a id="detectvisibleinterval-10"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`detectVisibleInterval`](#detectvisibleinterval-20)

<a id="discrete-15"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`discrete`](#discrete-27)

<a id="downloadbutton-10"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`downloadButton`](#downloadbutton-20)

<a id="downloadconfig-10"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`downloadConfig`](#downloadconfig-20)

<a id="downloadposition-10"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`downloadPosition`](#downloadposition-20)

<a id="duration-23"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`duration`](#duration-37)

<a id="filter-10"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`filter`](#filter-20)

<a id="fontfamily-10"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| `string`[] \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| `string`[] \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`fontFamily`](#fontfamily-21)

<a id="groupby-10"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

(`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`groupBy`](#groupby-20)

<a id="height-19"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`height`](#height-33)

<a id="hiddencolor-10"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`hiddenColor`](#hiddencolor-20)

<a id="hiddenopacity-10"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`hiddenOpacity`](#hiddenopacity-20)

<a id="hover-17"></a>

##### hover()

> **hover**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `this`

Defined in: [charts/Viz.ts:1350](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1350)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`hover`](#hover-29)

<a id="innerradius-1"></a>

##### innerRadius()

> **innerRadius**(`_?`: `number` \| (() => `number`)): `number` \| [`Pie`](#pie) \| (() => `number`)

Defined in: [charts/Pie.ts:107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Pie.ts#L107)

The pixel value, or function that returns a pixel value, that is used as the inner radius of the Pie (creating a Donut).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| (() => `number`) |

###### Returns

`number` \| [`Pie`](#pie) \| (() => `number`)

<a id="label-16"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`label`](#label-28)

<a id="legend-11"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`legend`](#legend-21)

<a id="legendconfig-12"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`legendConfig`](#legendconfig-22)

<a id="legendfilterinvert-10"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`legendFilterInvert`](#legendfilterinvert-20)

<a id="legendpadding-11"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`legendPadding`](#legendpadding-21)

<a id="legendposition-10"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| (() => `string`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| (() => `string`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`legendPosition`](#legendposition-20)

<a id="legendsort-10"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`legendSort`](#legendsort-20)

<a id="legendtooltip-10"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`legendTooltip`](#legendtooltip-20)

<a id="loadinghtml-10"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`loadingHTML`](#loadinghtml-20)

<a id="loadingmessage-10"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`loadingMessage`](#loadingmessage-20)

<a id="messagemask-10"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`messageMask`](#messagemask-20)

<a id="messagestyle-10"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`messageStyle`](#messagestyle-20)

<a id="nodatahtml-10"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`noDataHTML`](#nodatahtml-20)

<a id="nodatamessage-10"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`noDataMessage`](#nodatamessage-20)

<a id="padangle-1"></a>

##### padAngle()

> **padAngle**(`_?`: `number`): `number` \| [`Pie`](#pie)

Defined in: [charts/Pie.ts:118](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Pie.ts#L118)

The padding between each arc, set as a radian value between `0` and `1`.

If set, this will override any previously set padPixel value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pie`](#pie)

<a id="padpixel-1"></a>

##### padPixel()

> **padPixel**(`_?`: `number`): `number` \| [`Pie`](#pie)

Defined in: [charts/Pie.ts:129](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Pie.ts#L129)

The padding between each arc, set as a pixel number value.

By default the value is `0`, which shows no padding between each arc.

If `padAngle` is defined, the `padPixel` value will not be considered.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pie`](#pie)

<a id="render-24"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`render`](#render-38)

<a id="scrollcontainer-10"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| `HTMLElement` \| `Window` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| `HTMLElement` \| `Window` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`scrollContainer`](#scrollcontainer-20)

<a id="select-24"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

`Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`select`](#select-38)

<a id="shape-16"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`shape`](#shape-28)

<a id="shapeconfig-24"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`shapeConfig`](#shapeconfig-40)

<a id="sort-7"></a>

##### sort()

> **sort**(`_?`: (...`args`: `unknown`[]) => `unknown`): [`Pie`](#pie) \| ((...`args`: `unknown`[]) => `unknown`)

Defined in: [charts/Pie.ts:136](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Pie.ts#L136)

A comparator function that sorts the Pie slices.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

[`Pie`](#pie) \| ((...`args`: `unknown`[]) => `unknown`)

<a id="subtitle-10"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`subtitle`](#subtitle-20)

<a id="subtitleconfig-10"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`subtitleConfig`](#subtitleconfig-20)

<a id="subtitlepadding-10"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`subtitlePadding`](#subtitlepadding-20)

<a id="svgdesc-10"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`svgDesc`](#svgdesc-20)

<a id="svgtitle-10"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`svgTitle`](#svgtitle-20)

<a id="threshold-10"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`threshold`](#threshold-20)

<a id="thresholdkey-10"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`thresholdKey`](#thresholdkey-20)

<a id="thresholdname-10"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`thresholdName`](#thresholdname-20)

<a id="time-10"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`time`](#time-20)

<a id="timefilter-10"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`timeFilter`](#timefilter-20)

<a id="timeline-10"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`timeline`](#timeline-21)

<a id="timelineconfig-10"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`timelineConfig`](#timelineconfig-21)

<a id="timelinedefault-10"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): `Date`[] \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

`Date`[] \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`timelineDefault`](#timelinedefault-20)

<a id="timelinepadding-10"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`timelinePadding`](#timelinepadding-21)

<a id="title-16"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`title`](#title-28)

<a id="titleconfig-16"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`titleConfig`](#titleconfig-27)

<a id="titlepadding-10"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`titlePadding`](#titlepadding-20)

<a id="tooltip-10"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`tooltip`](#tooltip-21)

<a id="tooltipconfig-10"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`tooltipConfig`](#tooltipconfig-21)

<a id="total-10"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`total`](#total-20)

<a id="totalconfig-10"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`totalConfig`](#totalconfig-20)

<a id="totalformat-10"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): ((`d`: `number`) => `string`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

((`d`: `number`) => `string`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`totalFormat`](#totalformat-20)

<a id="totalpadding-10"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`totalPadding`](#totalpadding-20)

<a id="value-2"></a>

##### value()

> **value**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| [`Pie`](#pie) \| ((`d`: `DataPoint`, `i`: `number`) => `number`)

Defined in: [charts/Pie.ts:143](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Pie.ts#L143)

The accessor key for each data point used to calculate the size of each Pie section.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| [`Pie`](#pie) \| ((`d`: `DataPoint`, `i`: `number`) => `number`)

<a id="width-19"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`width`](#width-33)

<a id="zoom-10"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`zoom`](#zoom-20)

<a id="zoombrushhandlesize-10"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleSize`](#zoombrushhandlesize-20)

<a id="zoombrushhandlestyle-10"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleStyle`](#zoombrushhandlestyle-20)

<a id="zoombrushselectionstyle-10"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`zoomBrushSelectionStyle`](#zoombrushselectionstyle-20)

<a id="zoomcontrolstyle-10"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyle`](#zoomcontrolstyle-20)

<a id="zoomcontrolstyleactive-10"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleActive`](#zoomcontrolstyleactive-20)

<a id="zoomcontrolstylehover-10"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleHover`](#zoomcontrolstylehover-20)

<a id="zoomfactor-10"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`zoomFactor`](#zoomfactor-20)

<a id="zoommax-10"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`zoomMax`](#zoommax-20)

<a id="zoompadding-10"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`zoomPadding`](#zoompadding-20)

<a id="zoompan-10"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`zoomPan`](#zoompan-20)

<a id="zoomscroll-10"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`Pie`](#pie)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Pie`](#pie)

###### Inherited from

[`Viz`](#viz).[`zoomScroll`](#zoomscroll-20)

***

<a id="plot"></a>

### Plot

Defined in: [charts/Plot.ts:162](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L162)

Creates an x/y plot based on an array of data.

#### Extends

- [`Viz`](#viz)

#### Extended by

- [`AreaPlot`](#areaplot)
- [`BarChart`](#barchart)
- [`BoxWhisker`](#boxwhisker)
- [`BumpChart`](#bumpchart)
- [`LinePlot`](#lineplot)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-18"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

###### Inherited from

[`Viz`](#viz).[`active`](#active-29)

<a id="aggs-11"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Viz`](#viz).[`aggs`](#aggs-20)

<a id="annotations-5"></a>

##### annotations()

> **annotations**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2004](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2004)

Allows drawing custom shapes to be used as annotations in the provided x/y plot. This method accepts custom config objects for the [Shape](http://d3plus.org/docs/#Shape) class, either a single config object or an array of config objects. Each config object requires an additional parameter, the "shape", which denotes which [Shape](http://d3plus.org/docs/#Shape) sub-class to use ([Rect](http://d3plus.org/docs/#Rect), [Line](http://d3plus.org/docs/#Line), etc).

Additionally, each config object can also contain an optional "layer" key, which defines whether the annotations will be displayed in "front" or in "back" of the primary visualization shapes. This value defaults to "back" if not present.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="ariahidden-11"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`ariaHidden`](#ariahidden-21)

<a id="attribution-11"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`attribution`](#attribution-20)

<a id="attributionstyle-11"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Viz`](#viz).[`attributionStyle`](#attributionstyle-20)

<a id="axispersist-5"></a>

##### axisPersist()

> **axisPersist**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2013](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2013)

Determines whether the x and y axes should have their scales persist while users filter the data, the timeline being the prime example (set this to `true` to make the axes stay consistent when the timeline changes).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="backconfig-11"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Viz`](#viz).[`backConfig`](#backconfig-20)

<a id="backgroundconfig-5"></a>

##### backgroundConfig()

> **backgroundConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2022](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2022)

A d3plus-shape configuration Object used for styling the background rectangle of the inner x/y plot (behind all of the shapes and gridlines).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="barpadding-5"></a>

##### barPadding()

> **barPadding**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2031](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2031)

The pixel space between each bar in a group of bars.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="baseline-5"></a>

##### baseline()

> **baseline**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2038](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2038)

The baseline for the x/y plot.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="buffer-5"></a>

##### buffer()

> **buffer**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2045](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2045)

Determines whether or not to add additional padding at the ends of x or y scales. The most commone use for this is in Scatter Plots, so that the shapes do not appear directly on the axis itself. The value provided can either be `true` or `false` to toggle the behavior for all shape types, or a keyed Object for each shape type (ie. `{Bar: false, Circle: true, Line: false}`).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="cache-11"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`cache`](#cache-20)

<a id="color-12"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

###### Inherited from

[`Viz`](#viz).[`color`](#color-21)

<a id="colorscale-12"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

###### Inherited from

[`Viz`](#viz).[`colorScale`](#colorscale-21)

<a id="colorscaleconfig-12"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Viz`](#viz).[`colorScaleConfig`](#colorscaleconfig-21)

<a id="colorscalemaxsize-11"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`colorScaleMaxSize`](#colorscalemaxsize-20)

<a id="colorscalepadding-12"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Plot`](#plot) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`Plot`](#plot) \| (() => `boolean`)

###### Inherited from

[`Viz`](#viz).[`colorScalePadding`](#colorscalepadding-21)

<a id="colorscaleposition-11"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| [`Plot`](#plot) \| (() => `string` \| `boolean`)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| [`Plot`](#plot) \| (() => `string` \| `boolean`)

###### Inherited from

[`Viz`](#viz).[`colorScalePosition`](#colorscaleposition-20)

<a id="confidence-5"></a>

##### confidence()

> **confidence**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2073](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2073)

The confidence interval as an array of [lower, upper] bounds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Example

```ts
var data = {id: "alpha", value: 10, lci: 9, hci: 11};
...
// Accessor functions
.confidence([function(d) { return d.lci }, function(d) { return d.hci }])

// Or static keys
.confidence(["lci", "hci"])
```

<a id="confidenceconfig-5"></a>

##### confidenceConfig()

> **confidenceConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2090](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2090)

Configuration object for shapes rendered as confidence intervals.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="data-25"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): [`Plot`](#plot) \| `DataPoint`[]

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

[`Plot`](#plot) \| `DataPoint`[]

###### Inherited from

[`Viz`](#viz).[`data`](#data-39)

<a id="datacutoff-11"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`dataCutoff`](#datacutoff-20)

<a id="depth-11"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`depth`](#depth-20)

<a id="destroy-11"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`destroy`](#destroy-20)

<a id="detectresize-11"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`detectResize`](#detectresize-20)

<a id="detectresizedelay-11"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`detectResizeDelay`](#detectresizedelay-20)

<a id="detectvisible-11"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`detectVisible`](#detectvisible-20)

<a id="detectvisibleinterval-11"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`detectVisibleInterval`](#detectvisibleinterval-20)

<a id="discrete-16"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`discrete`](#discrete-27)

<a id="discretecutoff-5"></a>

##### discreteCutoff()

> **discreteCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2099](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2099)

When the width or height of the chart is less than or equal to this pixel value, the discrete axis will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="downloadbutton-11"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`downloadButton`](#downloadbutton-20)

<a id="downloadconfig-11"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Viz`](#viz).[`downloadConfig`](#downloadconfig-20)

<a id="downloadposition-11"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`downloadPosition`](#downloadposition-20)

<a id="duration-24"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`duration`](#duration-37)

<a id="filter-11"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

###### Inherited from

[`Viz`](#viz).[`filter`](#filter-20)

<a id="fontfamily-11"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| [`Plot`](#plot) \| `string`[]

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| [`Plot`](#plot) \| `string`[]

###### Inherited from

[`Viz`](#viz).[`fontFamily`](#fontfamily-21)

<a id="groupby-11"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): [`Plot`](#plot) \| (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[]

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

[`Plot`](#plot) \| (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[]

###### Inherited from

[`Viz`](#viz).[`groupBy`](#groupby-20)

<a id="grouppadding-5"></a>

##### groupPadding()

> **groupPadding**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2108](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2108)

The pixel space between groups of bars.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="height-20"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`height`](#height-33)

<a id="hiddencolor-11"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

###### Inherited from

[`Viz`](#viz).[`hiddenColor`](#hiddencolor-20)

<a id="hiddenopacity-11"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `number`)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `number`)

###### Inherited from

[`Viz`](#viz).[`hiddenOpacity`](#hiddenopacity-20)

<a id="hover-18"></a>

##### hover()

> **hover**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `this`

Defined in: [charts/Viz.ts:1350](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1350)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`hover`](#hover-29)

<a id="label-17"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

###### Inherited from

[`Viz`](#viz).[`label`](#label-28)

<a id="labelconnectorconfig-5"></a>

##### labelConnectorConfig()

> **labelConnectorConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2117](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2117)

The d3plus-shape config used on the Line shapes created to connect lineLabels to the end of their associated Line path.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="labelposition-5"></a>

##### labelPosition()

> **labelPosition**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2127](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2127)

The behavior to be used when calculating the position and size of each shape's label(s). The value passed can either be the _String_ name of the behavior to be used for all shapes, or an accessor _Function_ that will be provided each data point and will be expected to return the behavior to be used for that data point. The availability and options for this method depend on the default logic for each Shape. As an example, the values "outside" or "inside" can be set for Bar shapes, whose "auto" default will calculate the best position dynamically based on the available space.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="legend-12"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| [`Plot`](#plot) \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| [`Plot`](#plot) \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)

###### Inherited from

[`Viz`](#viz).[`legend`](#legend-21)

<a id="legendconfig-13"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Viz`](#viz).[`legendConfig`](#legendconfig-22)

<a id="legendfilterinvert-11"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Plot`](#plot) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`Plot`](#plot) \| (() => `boolean`)

###### Inherited from

[`Viz`](#viz).[`legendFilterInvert`](#legendfilterinvert-20)

<a id="legendpadding-12"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Plot`](#plot) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`Plot`](#plot) \| (() => `boolean`)

###### Inherited from

[`Viz`](#viz).[`legendPadding`](#legendpadding-21)

<a id="legendposition-11"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| [`Plot`](#plot) \| (() => `string`)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| [`Plot`](#plot) \| (() => `string`)

###### Inherited from

[`Viz`](#viz).[`legendPosition`](#legendposition-20)

<a id="legendsort-11"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): [`Plot`](#plot) \| ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

[`Plot`](#plot) \| ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`)

###### Inherited from

[`Viz`](#viz).[`legendSort`](#legendsort-20)

<a id="legendtooltip-11"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Viz`](#viz).[`legendTooltip`](#legendtooltip-20)

<a id="linelabels-5"></a>

##### lineLabels()

> **lineLabels**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2137](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2137)

Draws labels on the right side of any Line shapes that are drawn on the plot.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="linemarkerconfig-5"></a>

##### lineMarkerConfig()

> **lineMarkerConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2144](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2144)

Shape config for the Circle shapes drawn by the lineMarkers method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="linemarkers-5"></a>

##### lineMarkers()

> **lineMarkers**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2153](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2153)

Draws circle markers on each vertex of a Line.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="loadinghtml-11"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| [`Plot`](#plot) \| ((`viz`: [`Viz`](#viz)) => `string`)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| [`Plot`](#plot) \| ((`viz`: [`Viz`](#viz)) => `string`)

###### Inherited from

[`Viz`](#viz).[`loadingHTML`](#loadinghtml-20)

<a id="loadingmessage-11"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`loadingMessage`](#loadingmessage-20)

<a id="messagemask-11"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`messageMask`](#messagemask-20)

<a id="messagestyle-11"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Viz`](#viz).[`messageStyle`](#messagestyle-20)

<a id="nodatahtml-11"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| [`Plot`](#plot) \| ((`viz`: [`Viz`](#viz)) => `string`)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| [`Plot`](#plot) \| ((`viz`: [`Viz`](#viz)) => `string`)

###### Inherited from

[`Viz`](#viz).[`noDataHTML`](#nodatahtml-20)

<a id="nodatamessage-11"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`noDataMessage`](#nodatamessage-20)

<a id="render-25"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`render`](#render-38)

<a id="scrollcontainer-11"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| [`Plot`](#plot) \| `HTMLElement` \| `Window`

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| [`Plot`](#plot) \| `HTMLElement` \| `Window`

###### Inherited from

[`Viz`](#viz).[`scrollContainer`](#scrollcontainer-20)

<a id="select-25"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): [`Plot`](#plot) \| `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\>

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

[`Plot`](#plot) \| `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\>

###### Inherited from

[`Viz`](#viz).[`select`](#select-38)

<a id="shape-17"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

###### Inherited from

[`Viz`](#viz).[`shape`](#shape-28)

<a id="shapeconfig-25"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Viz`](#viz).[`shapeConfig`](#shapeconfig-40)

<a id="shapesort-5"></a>

##### shapeSort()

> **shapeSort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2162](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2162)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) that receives each shape Class (ie. "Circle", "Line", etc) as it's comparator arguments. Shapes are drawn in groups based on their type, so you are defining the layering order for all shapes of said type.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="size-7"></a>

##### size()

> **size**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2169](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2169)

Sets the size of bubbles to the given Number, data key, or function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="sizemax-6"></a>

##### sizeMax()

> **sizeMax**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2178)

Sets the size scale maximum to the specified number.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="sizemin-6"></a>

##### sizeMin()

> **sizeMin**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2185](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2185)

Sets the size scale minimum to the specified number.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="sizescale-6"></a>

##### sizeScale()

> **sizeScale**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2192](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2192)

Sets the size scale to the specified string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="stacked-5"></a>

##### stacked()

> **stacked**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2199](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2199)

If *value* is specified, toggles shape stacking. If *value* is not specified, returns the current stack value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="stackoffset-5"></a>

##### stackOffset()

> **stackOffset**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2206](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2206)

Sets the stack offset. If *value* is not specified, returns the current stack offset function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="stackorder-5"></a>

##### stackOrder()

> **stackOrder**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2219](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2219)

Sets the stack order. If *value* is not specified, returns the current stack order function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="subtitle-11"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| [`Plot`](#plot) \| ((`data`: `DataPoint`[]) => `string`)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| [`Plot`](#plot) \| ((`data`: `DataPoint`[]) => `string`)

###### Inherited from

[`Viz`](#viz).[`subtitle`](#subtitle-20)

<a id="subtitleconfig-11"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Viz`](#viz).[`subtitleConfig`](#subtitleconfig-20)

<a id="subtitlepadding-11"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Plot`](#plot) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`Plot`](#plot) \| (() => `boolean`)

###### Inherited from

[`Viz`](#viz).[`subtitlePadding`](#subtitlepadding-20)

<a id="svgdesc-11"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`svgDesc`](#svgdesc-20)

<a id="svgtitle-11"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`svgTitle`](#svgtitle-20)

<a id="threshold-11"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| [`Plot`](#plot) \| ((`data`: `DataPoint`[]) => `number`)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| [`Plot`](#plot) \| ((`data`: `DataPoint`[]) => `number`)

###### Inherited from

[`Viz`](#viz).[`threshold`](#threshold-20)

<a id="thresholdkey-11"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

###### Inherited from

[`Viz`](#viz).[`thresholdKey`](#thresholdkey-20)

<a id="thresholdname-11"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

###### Inherited from

[`Viz`](#viz).[`thresholdName`](#thresholdname-20)

<a id="time-11"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

###### Inherited from

[`Viz`](#viz).[`time`](#time-20)

<a id="timefilter-11"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

###### Inherited from

[`Viz`](#viz).[`timeFilter`](#timefilter-20)

<a id="timeline-11"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`timeline`](#timeline-21)

<a id="timelineconfig-11"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Viz`](#viz).[`timelineConfig`](#timelineconfig-21)

<a id="timelinedefault-11"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): [`Plot`](#plot) \| `Date`[]

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

[`Plot`](#plot) \| `Date`[]

###### Inherited from

[`Viz`](#viz).[`timelineDefault`](#timelinedefault-20)

<a id="timelinepadding-11"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Plot`](#plot) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`Plot`](#plot) \| (() => `boolean`)

###### Inherited from

[`Viz`](#viz).[`timelinePadding`](#timelinepadding-21)

<a id="title-17"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| [`Plot`](#plot) \| ((`data`: `DataPoint`[]) => `string`)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| [`Plot`](#plot) \| ((`data`: `DataPoint`[]) => `string`)

###### Inherited from

[`Viz`](#viz).[`title`](#title-28)

<a id="titleconfig-17"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Viz`](#viz).[`titleConfig`](#titleconfig-27)

<a id="titlepadding-11"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Plot`](#plot) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`Plot`](#plot) \| (() => `boolean`)

###### Inherited from

[`Viz`](#viz).[`titlePadding`](#titlepadding-20)

<a id="tooltip-11"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

###### Inherited from

[`Viz`](#viz).[`tooltip`](#tooltip-21)

<a id="tooltipconfig-11"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Viz`](#viz).[`tooltipConfig`](#tooltipconfig-21)

<a id="total-11"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `number`)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `number`)

###### Inherited from

[`Viz`](#viz).[`total`](#total-20)

<a id="totalconfig-11"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Viz`](#viz).[`totalConfig`](#totalconfig-20)

<a id="totalformat-11"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): [`Plot`](#plot) \| ((`d`: `number`) => `string`)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

[`Plot`](#plot) \| ((`d`: `number`) => `string`)

###### Inherited from

[`Viz`](#viz).[`totalFormat`](#totalformat-20)

<a id="totalpadding-11"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Plot`](#plot) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`Plot`](#plot) \| (() => `boolean`)

###### Inherited from

[`Viz`](#viz).[`totalPadding`](#totalpadding-20)

<a id="width-20"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`width`](#width-33)

<a id="x-13"></a>

##### x()

> **x**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2236](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2236)

Accessor function or string key for the x-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="x2-5"></a>

##### x2()

> **x2**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2250)

Accessor function or string key for the secondary x-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="x2config-5"></a>

##### x2Config()

> **x2Config**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2280](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2280)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the secondary x-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="x2domain-5"></a>

##### x2Domain()

> **x2Domain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2296](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2296)

The x2 domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="x2sort-5"></a>

##### x2Sort()

> **x2Sort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2310](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2310)

Defines a custom sorting comparitor function to be used for discrete x2 axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="xconfig-5"></a>

##### xConfig()

> **xConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2264](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2264)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the x-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="xcutoff-5"></a>

##### xCutoff()

> **xCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2273](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2273)

When the width of the chart is less than or equal to this pixel value, and the x-axis is not the discrete axis, it will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="xdomain-5"></a>

##### xDomain()

> **xDomain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2289](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2289)

The x domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="xsort-5"></a>

##### xSort()

> **xSort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2303](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2303)

Defines a custom sorting comparitor function to be used for discrete x axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="y-13"></a>

##### y()

> **y**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2317](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2317)

Accessor function or string key for the y-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="y2-5"></a>

##### y2()

> **y2**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2331](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2331)

Accessor function or string key for the secondary y-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="y2config-5"></a>

##### y2Config()

> **y2Config**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2366](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2366)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the secondary y-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="y2domain-5"></a>

##### y2Domain()

> **y2Domain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2385](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2385)

The y2 domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="y2sort-5"></a>

##### y2Sort()

> **y2Sort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2399](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2399)

Defines a custom sorting comparitor function to be used for discrete y2 axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="yconfig-5"></a>

##### yConfig()

> **yConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2347](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2347)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the y-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

*Note:* If a "domain" array is passed to the y-axis config, it will be reversed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="ycutoff-5"></a>

##### yCutoff()

> **yCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2359](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2359)

When the height of the chart is less than or equal to this pixel value, and the y-axis is not the discrete axis, it will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="ydomain-5"></a>

##### yDomain()

> **yDomain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2378](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2378)

The y domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="ysort-5"></a>

##### ySort()

> **ySort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2392](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2392)

Defines a custom sorting comparitor function to be used for discrete y axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="zoom-11"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`zoom`](#zoom-20)

<a id="zoombrushhandlesize-11"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleSize`](#zoombrushhandlesize-20)

<a id="zoombrushhandlestyle-11"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleStyle`](#zoombrushhandlestyle-20)

<a id="zoombrushselectionstyle-11"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Viz`](#viz).[`zoomBrushSelectionStyle`](#zoombrushselectionstyle-20)

<a id="zoomcontrolstyle-11"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Viz`](#viz).[`zoomControlStyle`](#zoomcontrolstyle-20)

<a id="zoomcontrolstyleactive-11"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleActive`](#zoomcontrolstyleactive-20)

<a id="zoomcontrolstylehover-11"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| [`Plot`](#plot) \| `Record`\<`string`, `unknown`\>

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleHover`](#zoomcontrolstylehover-20)

<a id="zoomfactor-11"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`zoomFactor`](#zoomfactor-20)

<a id="zoommax-11"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`zoomMax`](#zoommax-20)

<a id="zoompadding-11"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`zoomPadding`](#zoompadding-20)

<a id="zoompan-11"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`zoomPan`](#zoompan-20)

<a id="zoomscroll-11"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`Plot`](#plot)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Plot`](#plot)

###### Inherited from

[`Viz`](#viz).[`zoomScroll`](#zoomscroll-20)

***

<a id="priestley"></a>

### Priestley

Defined in: [charts/Priestley.ts:14](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Priestley.ts#L14)

Creates a priestley timeline based on an array of data.

#### Extends

- [`Viz`](#viz)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-19"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`active`](#active-29)

<a id="aggs-12"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`aggs`](#aggs-20)

<a id="ariahidden-12"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`ariaHidden`](#ariahidden-21)

<a id="attribution-12"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`attribution`](#attribution-20)

<a id="attributionstyle-12"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`attributionStyle`](#attributionstyle-20)

<a id="axisconfig-2"></a>

##### axisConfig()

> **axisConfig**(`_`: `any`): `any`

Defined in: [charts/Priestley.ts:169](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Priestley.ts#L169)

Configuration object for the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="backconfig-12"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`backConfig`](#backconfig-20)

<a id="cache-12"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`cache`](#cache-20)

<a id="color-13"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`color`](#color-21)

<a id="colorscale-13"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`colorScale`](#colorscale-21)

<a id="colorscaleconfig-13"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`colorScaleConfig`](#colorscaleconfig-21)

<a id="colorscalemaxsize-12"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`colorScaleMaxSize`](#colorscalemaxsize-20)

<a id="colorscalepadding-13"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`colorScalePadding`](#colorscalepadding-21)

<a id="colorscaleposition-12"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`colorScalePosition`](#colorscaleposition-20)

<a id="data-26"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): `DataPoint`[] \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

`DataPoint`[] \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`data`](#data-39)

<a id="datacutoff-12"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`dataCutoff`](#datacutoff-20)

<a id="depth-12"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`depth`](#depth-20)

<a id="destroy-12"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`destroy`](#destroy-20)

<a id="detectresize-12"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`detectResize`](#detectresize-20)

<a id="detectresizedelay-12"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`detectResizeDelay`](#detectresizedelay-20)

<a id="detectvisible-12"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`detectVisible`](#detectvisible-20)

<a id="detectvisibleinterval-12"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`detectVisibleInterval`](#detectvisibleinterval-20)

<a id="discrete-17"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`discrete`](#discrete-27)

<a id="downloadbutton-12"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`downloadButton`](#downloadbutton-20)

<a id="downloadconfig-12"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`downloadConfig`](#downloadconfig-20)

<a id="downloadposition-12"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`downloadPosition`](#downloadposition-20)

<a id="duration-25"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`duration`](#duration-37)

<a id="end"></a>

##### end()

> **end**(`_`: `any`): `any`

Defined in: [charts/Priestley.ts:178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Priestley.ts#L178)

Accessor function or string key for the end date of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="filter-12"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`filter`](#filter-20)

<a id="fontfamily-12"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| `string`[] \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| `string`[] \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`fontFamily`](#fontfamily-21)

<a id="groupby-12"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

(`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`groupBy`](#groupby-20)

<a id="height-21"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`height`](#height-33)

<a id="hiddencolor-12"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`hiddenColor`](#hiddencolor-20)

<a id="hiddenopacity-12"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`hiddenOpacity`](#hiddenopacity-20)

<a id="hover-19"></a>

##### hover()

> **hover**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `this`

Defined in: [charts/Viz.ts:1350](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1350)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`hover`](#hover-29)

<a id="label-18"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`label`](#label-28)

<a id="legend-13"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`legend`](#legend-21)

<a id="legendconfig-14"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`legendConfig`](#legendconfig-22)

<a id="legendfilterinvert-12"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`legendFilterInvert`](#legendfilterinvert-20)

<a id="legendpadding-13"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`legendPadding`](#legendpadding-21)

<a id="legendposition-12"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| (() => `string`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| (() => `string`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`legendPosition`](#legendposition-20)

<a id="legendsort-12"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`legendSort`](#legendsort-20)

<a id="legendtooltip-12"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`legendTooltip`](#legendtooltip-20)

<a id="loadinghtml-12"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`loadingHTML`](#loadinghtml-20)

<a id="loadingmessage-12"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`loadingMessage`](#loadingmessage-20)

<a id="messagemask-12"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`messageMask`](#messagemask-20)

<a id="messagestyle-12"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`messageStyle`](#messagestyle-20)

<a id="nodatahtml-12"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`noDataHTML`](#nodatahtml-20)

<a id="nodatamessage-12"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`noDataMessage`](#nodatamessage-20)

<a id="paddinginner-5"></a>

##### paddingInner()

> **paddingInner**(`_`: `any`): `any`

Defined in: [charts/Priestley.ts:192](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Priestley.ts#L192)

The [paddingInner](https://github.com/d3/d3-scale#band_paddingInner) value of the underlining [Band Scale](https://github.com/d3/d3-scale#band-scales) used to determine the height of each bar. Values should be a ratio between 0 and 1 representing the space in between each rectangle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="paddingouter-5"></a>

##### paddingOuter()

> **paddingOuter**(`_`: `any`): `any`

Defined in: [charts/Priestley.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Priestley.ts#L201)

The [paddingOuter](https://github.com/d3/d3-scale#band_paddingOuter) value of the underlining [Band Scale](https://github.com/d3/d3-scale#band-scales) used to determine the height of each bar. Values should be a ratio between 0 and 1 representing the space around the outer rectangles.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="render-26"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`render`](#render-38)

<a id="scrollcontainer-12"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| `HTMLElement` \| `Window` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| `HTMLElement` \| `Window` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`scrollContainer`](#scrollcontainer-20)

<a id="select-26"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

`Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`select`](#select-38)

<a id="shape-18"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`shape`](#shape-28)

<a id="shapeconfig-26"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`shapeConfig`](#shapeconfig-40)

<a id="start"></a>

##### start()

> **start**(`_`: `any`): `any`

Defined in: [charts/Priestley.ts:210](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Priestley.ts#L210)

Accessor function or string key for the start date of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="subtitle-12"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`subtitle`](#subtitle-20)

<a id="subtitleconfig-12"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`subtitleConfig`](#subtitleconfig-20)

<a id="subtitlepadding-12"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`subtitlePadding`](#subtitlepadding-20)

<a id="svgdesc-12"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`svgDesc`](#svgdesc-20)

<a id="svgtitle-12"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`svgTitle`](#svgtitle-20)

<a id="threshold-12"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`threshold`](#threshold-20)

<a id="thresholdkey-12"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`thresholdKey`](#thresholdkey-20)

<a id="thresholdname-12"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`thresholdName`](#thresholdname-20)

<a id="time-12"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`time`](#time-20)

<a id="timefilter-12"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`timeFilter`](#timefilter-20)

<a id="timeline-12"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`timeline`](#timeline-21)

<a id="timelineconfig-12"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`timelineConfig`](#timelineconfig-21)

<a id="timelinedefault-12"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): `Date`[] \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

`Date`[] \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`timelineDefault`](#timelinedefault-20)

<a id="timelinepadding-12"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`timelinePadding`](#timelinepadding-21)

<a id="title-18"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`title`](#title-28)

<a id="titleconfig-18"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`titleConfig`](#titleconfig-27)

<a id="titlepadding-12"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`titlePadding`](#titlepadding-20)

<a id="tooltip-12"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`tooltip`](#tooltip-21)

<a id="tooltipconfig-12"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`tooltipConfig`](#tooltipconfig-21)

<a id="total-12"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`total`](#total-20)

<a id="totalconfig-12"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`totalConfig`](#totalconfig-20)

<a id="totalformat-12"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): ((`d`: `number`) => `string`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

((`d`: `number`) => `string`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`totalFormat`](#totalformat-20)

<a id="totalpadding-12"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`totalPadding`](#totalpadding-20)

<a id="width-21"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`width`](#width-33)

<a id="zoom-12"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`zoom`](#zoom-20)

<a id="zoombrushhandlesize-12"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleSize`](#zoombrushhandlesize-20)

<a id="zoombrushhandlestyle-12"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleStyle`](#zoombrushhandlestyle-20)

<a id="zoombrushselectionstyle-12"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`zoomBrushSelectionStyle`](#zoombrushselectionstyle-20)

<a id="zoomcontrolstyle-12"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyle`](#zoomcontrolstyle-20)

<a id="zoomcontrolstyleactive-12"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleActive`](#zoomcontrolstyleactive-20)

<a id="zoomcontrolstylehover-12"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleHover`](#zoomcontrolstylehover-20)

<a id="zoomfactor-12"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`zoomFactor`](#zoomfactor-20)

<a id="zoommax-12"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`zoomMax`](#zoommax-20)

<a id="zoompadding-12"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`zoomPadding`](#zoompadding-20)

<a id="zoompan-12"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`zoomPan`](#zoompan-20)

<a id="zoomscroll-12"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`Priestley`](#priestley)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Priestley`](#priestley)

###### Inherited from

[`Viz`](#viz).[`zoomScroll`](#zoomscroll-20)

***

<a id="radar"></a>

### Radar

Defined in: [charts/Radar.ts:17](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Radar.ts#L17)

Creates a radar visualization based on an array of data.

#### Extends

- [`Viz`](#viz)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-20"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`active`](#active-29)

<a id="aggs-13"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`aggs`](#aggs-20)

<a id="ariahidden-13"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`ariaHidden`](#ariahidden-21)

<a id="attribution-13"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`attribution`](#attribution-20)

<a id="attributionstyle-13"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`attributionStyle`](#attributionstyle-20)

<a id="axisconfig-3"></a>

##### axisConfig()

> **axisConfig**(`_`: `any`): `any`

Defined in: [charts/Radar.ts:262](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Radar.ts#L262)

Configuration object for the radial spokes, circles, and labels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="backconfig-13"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`backConfig`](#backconfig-20)

<a id="cache-13"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`cache`](#cache-20)

<a id="color-14"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`color`](#color-21)

<a id="colorscale-14"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`colorScale`](#colorscale-21)

<a id="colorscaleconfig-14"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`colorScaleConfig`](#colorscaleconfig-21)

<a id="colorscalemaxsize-13"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`colorScaleMaxSize`](#colorscalemaxsize-20)

<a id="colorscalepadding-14"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`colorScalePadding`](#colorscalepadding-21)

<a id="colorscaleposition-13"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`colorScalePosition`](#colorscaleposition-20)

<a id="data-27"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): `DataPoint`[] \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

`DataPoint`[] \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`data`](#data-39)

<a id="datacutoff-13"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`dataCutoff`](#datacutoff-20)

<a id="depth-13"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`depth`](#depth-20)

<a id="destroy-13"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`destroy`](#destroy-20)

<a id="detectresize-13"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`detectResize`](#detectresize-20)

<a id="detectresizedelay-13"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`detectResizeDelay`](#detectresizedelay-20)

<a id="detectvisible-13"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`detectVisible`](#detectvisible-20)

<a id="detectvisibleinterval-13"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`detectVisibleInterval`](#detectvisibleinterval-20)

<a id="discrete-18"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`discrete`](#discrete-27)

<a id="downloadbutton-13"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`downloadButton`](#downloadbutton-20)

<a id="downloadconfig-13"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`downloadConfig`](#downloadconfig-20)

<a id="downloadposition-13"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`downloadPosition`](#downloadposition-20)

<a id="duration-26"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`duration`](#duration-37)

<a id="filter-13"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`filter`](#filter-20)

<a id="fontfamily-13"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| `string`[] \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| `string`[] \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`fontFamily`](#fontfamily-21)

<a id="groupby-13"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

(`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`groupBy`](#groupby-20)

<a id="height-22"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`height`](#height-33)

<a id="hiddencolor-13"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`hiddenColor`](#hiddencolor-20)

<a id="hiddenopacity-13"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`hiddenOpacity`](#hiddenopacity-20)

<a id="hover-20"></a>

##### hover()

> **hover**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `this`

Defined in: [charts/Viz.ts:1350](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1350)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`hover`](#hover-29)

<a id="label-19"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`label`](#label-28)

<a id="legend-14"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`legend`](#legend-21)

<a id="legendconfig-15"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`legendConfig`](#legendconfig-22)

<a id="legendfilterinvert-13"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`legendFilterInvert`](#legendfilterinvert-20)

<a id="legendpadding-14"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`legendPadding`](#legendpadding-21)

<a id="legendposition-13"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| (() => `string`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| (() => `string`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`legendPosition`](#legendposition-20)

<a id="legendsort-13"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`legendSort`](#legendsort-20)

<a id="legendtooltip-13"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`legendTooltip`](#legendtooltip-20)

<a id="loadinghtml-13"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`loadingHTML`](#loadinghtml-20)

<a id="loadingmessage-13"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`loadingMessage`](#loadingmessage-20)

<a id="messagemask-13"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`messageMask`](#messagemask-20)

<a id="messagestyle-13"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`messageStyle`](#messagestyle-20)

<a id="metric"></a>

##### metric()

> **metric**(`_`: `any`): `any`

Defined in: [charts/Radar.ts:271](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Radar.ts#L271)

Accessor function for the metric value used as each axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="nodatahtml-13"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`noDataHTML`](#nodatahtml-20)

<a id="nodatamessage-13"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`noDataMessage`](#nodatamessage-20)

<a id="outerpadding"></a>

##### outerPadding()

> **outerPadding**(`_`: `any`): `any`

Defined in: [charts/Radar.ts:280](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Radar.ts#L280)

Determines how much pixel spaces to give the outer labels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="render-27"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`render`](#render-38)

<a id="scrollcontainer-13"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| `HTMLElement` \| `Window` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| `HTMLElement` \| `Window` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`scrollContainer`](#scrollcontainer-20)

<a id="select-27"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

`Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`select`](#select-38)

<a id="shape-19"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`shape`](#shape-28)

<a id="shapeconfig-27"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`shapeConfig`](#shapeconfig-40)

<a id="subtitle-13"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`subtitle`](#subtitle-20)

<a id="subtitleconfig-13"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`subtitleConfig`](#subtitleconfig-20)

<a id="subtitlepadding-13"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`subtitlePadding`](#subtitlepadding-20)

<a id="svgdesc-13"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`svgDesc`](#svgdesc-20)

<a id="svgtitle-13"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`svgTitle`](#svgtitle-20)

<a id="threshold-13"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`threshold`](#threshold-20)

<a id="thresholdkey-13"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`thresholdKey`](#thresholdkey-20)

<a id="thresholdname-13"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`thresholdName`](#thresholdname-20)

<a id="time-13"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`time`](#time-20)

<a id="timefilter-13"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`timeFilter`](#timefilter-20)

<a id="timeline-13"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`timeline`](#timeline-21)

<a id="timelineconfig-13"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`timelineConfig`](#timelineconfig-21)

<a id="timelinedefault-13"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): `Date`[] \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

`Date`[] \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`timelineDefault`](#timelinedefault-20)

<a id="timelinepadding-13"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`timelinePadding`](#timelinepadding-21)

<a id="title-19"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`title`](#title-28)

<a id="titleconfig-19"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`titleConfig`](#titleconfig-27)

<a id="titlepadding-13"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`titlePadding`](#titlepadding-20)

<a id="tooltip-13"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`tooltip`](#tooltip-21)

<a id="tooltipconfig-13"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`tooltipConfig`](#tooltipconfig-21)

<a id="total-13"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`total`](#total-20)

<a id="totalconfig-13"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`totalConfig`](#totalconfig-20)

<a id="totalformat-13"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): ((`d`: `number`) => `string`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

((`d`: `number`) => `string`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`totalFormat`](#totalformat-20)

<a id="totalpadding-13"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`totalPadding`](#totalpadding-20)

<a id="value-3"></a>

##### value()

> **value**(`_`: `any`): `any`

Defined in: [charts/Radar.ts:294](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Radar.ts#L294)

The value accessor used to determine each data point's position along each axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Example

```ts
function value(d) {
return d.value;
}
```

<a id="width-22"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`width`](#width-33)

<a id="zoom-13"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`zoom`](#zoom-20)

<a id="zoombrushhandlesize-13"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleSize`](#zoombrushhandlesize-20)

<a id="zoombrushhandlestyle-13"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleStyle`](#zoombrushhandlestyle-20)

<a id="zoombrushselectionstyle-13"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`zoomBrushSelectionStyle`](#zoombrushselectionstyle-20)

<a id="zoomcontrolstyle-13"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyle`](#zoomcontrolstyle-20)

<a id="zoomcontrolstyleactive-13"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleActive`](#zoomcontrolstyleactive-20)

<a id="zoomcontrolstylehover-13"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleHover`](#zoomcontrolstylehover-20)

<a id="zoomfactor-13"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`zoomFactor`](#zoomfactor-20)

<a id="zoommax-13"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`zoomMax`](#zoommax-20)

<a id="zoompadding-13"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`zoomPadding`](#zoompadding-20)

<a id="zoompan-13"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`zoomPan`](#zoompan-20)

<a id="zoomscroll-13"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`Radar`](#radar)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Radar`](#radar)

###### Inherited from

[`Viz`](#viz).[`zoomScroll`](#zoomscroll-20)

***

<a id="radialmatrix"></a>

### RadialMatrix

Defined in: [charts/RadialMatrix.ts:25](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/RadialMatrix.ts#L25)

Creates a radial layout of a rows/columns Matrix of any dataset. See [this example](https://d3plus.org/examples/d3plus-matrix/radial-matrix/) for help getting started using the Matrix class.

#### Extends

- [`Viz`](#viz)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-21"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`active`](#active-29)

<a id="aggs-14"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`aggs`](#aggs-20)

<a id="ariahidden-14"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`ariaHidden`](#ariahidden-21)

<a id="attribution-14"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`attribution`](#attribution-20)

<a id="attributionstyle-14"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`attributionStyle`](#attributionstyle-20)

<a id="backconfig-14"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`backConfig`](#backconfig-20)

<a id="cache-14"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`cache`](#cache-20)

<a id="cellpadding-1"></a>

##### cellPadding()

> **cellPadding**(`_`: `any`): `any`

Defined in: [charts/RadialMatrix.ts:222](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/RadialMatrix.ts#L222)

The pixel padding in between each cell.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="color-15"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`color`](#color-21)

<a id="colorscale-15"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`colorScale`](#colorscale-21)

<a id="colorscaleconfig-15"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`colorScaleConfig`](#colorscaleconfig-21)

<a id="colorscalemaxsize-14"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`colorScaleMaxSize`](#colorscalemaxsize-20)

<a id="colorscalepadding-15"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`colorScalePadding`](#colorscalepadding-21)

<a id="colorscaleposition-14"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| (() => `string` \| `boolean`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| (() => `string` \| `boolean`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`colorScalePosition`](#colorscaleposition-20)

<a id="column-1"></a>

##### column()

> **column**(`_`: `any`): `any`

Defined in: [charts/RadialMatrix.ts:236](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/RadialMatrix.ts#L236)

Determines which key in your data should be used for each column in the matrix. Can be either a String that matches a key used in every data point, or an accessor function that receives a data point and it's index in the data array, and is expected to return it's column value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Example

```ts
function column(d) {
return d.name;
}
```

<a id="columnconfig-1"></a>

##### columnConfig()

> **columnConfig**(`_`: `any`): `any`

Defined in: [charts/RadialMatrix.ts:245](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/RadialMatrix.ts#L245)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the column labels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="columnlist-1"></a>

##### columnList()

> **columnList**(`_`: `any`): `any`

Defined in: [charts/RadialMatrix.ts:254](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/RadialMatrix.ts#L254)

A manual list of IDs to be used for rows.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="columnsort-1"></a>

##### columnSort()

> **columnSort**(`_`: `any`): `any`

Defined in: [charts/RadialMatrix.ts:266](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/RadialMatrix.ts#L266)

A sort comparator function that is run on the unique set of column values.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Example

```ts
function column(a, b) {
return a.localeCompare(b);
}
```

<a id="data-28"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): `DataPoint`[] \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

`DataPoint`[] \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`data`](#data-39)

<a id="datacutoff-14"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`dataCutoff`](#datacutoff-20)

<a id="depth-14"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`depth`](#depth-20)

<a id="destroy-14"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`destroy`](#destroy-20)

<a id="detectresize-14"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`detectResize`](#detectresize-20)

<a id="detectresizedelay-14"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`detectResizeDelay`](#detectresizedelay-20)

<a id="detectvisible-14"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`detectVisible`](#detectvisible-20)

<a id="detectvisibleinterval-14"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`detectVisibleInterval`](#detectvisibleinterval-20)

<a id="discrete-19"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`discrete`](#discrete-27)

<a id="downloadbutton-14"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`downloadButton`](#downloadbutton-20)

<a id="downloadconfig-14"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`downloadConfig`](#downloadconfig-20)

<a id="downloadposition-14"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`downloadPosition`](#downloadposition-20)

<a id="duration-27"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`duration`](#duration-37)

<a id="filter-14"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`filter`](#filter-20)

<a id="fontfamily-14"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| `string`[] \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| `string`[] \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`fontFamily`](#fontfamily-21)

<a id="groupby-14"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

(`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`groupBy`](#groupby-20)

<a id="height-23"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`height`](#height-33)

<a id="hiddencolor-14"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`hiddenColor`](#hiddencolor-20)

<a id="hiddenopacity-14"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`hiddenOpacity`](#hiddenopacity-20)

<a id="hover-21"></a>

##### hover()

> **hover**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `this`

Defined in: [charts/Viz.ts:1350](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1350)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`hover`](#hover-29)

<a id="innerradius-2"></a>

##### innerRadius()

> **innerRadius**(`_`: `any`): `any`

Defined in: [charts/RadialMatrix.ts:278](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/RadialMatrix.ts#L278)

The radius (in pixels) for the inner donut hole of the diagram. Can either be a static Number, or an accessor function that receives the outer radius as it's only argument.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Example

```ts
function(outerRadius) {
return outerRadius / 5;
}
```

<a id="label-20"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`label`](#label-28)

<a id="legend-15"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`legend`](#legend-21)

<a id="legendconfig-16"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`legendConfig`](#legendconfig-22)

<a id="legendfilterinvert-14"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`legendFilterInvert`](#legendfilterinvert-20)

<a id="legendpadding-15"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`legendPadding`](#legendpadding-21)

<a id="legendposition-14"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| (() => `string`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| (() => `string`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`legendPosition`](#legendposition-20)

<a id="legendsort-14"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`legendSort`](#legendsort-20)

<a id="legendtooltip-14"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`legendTooltip`](#legendtooltip-20)

<a id="loadinghtml-14"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`loadingHTML`](#loadinghtml-20)

<a id="loadingmessage-14"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`loadingMessage`](#loadingmessage-20)

<a id="messagemask-14"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`messageMask`](#messagemask-20)

<a id="messagestyle-14"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`messageStyle`](#messagestyle-20)

<a id="nodatahtml-14"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`noDataHTML`](#nodatahtml-20)

<a id="nodatamessage-14"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`noDataMessage`](#nodatamessage-20)

<a id="render-28"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`render`](#render-38)

<a id="row-1"></a>

##### row()

> **row**(`_`: `any`): `any`

Defined in: [charts/RadialMatrix.ts:292](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/RadialMatrix.ts#L292)

Determines which key in your data should be used for each row in the matrix. Can be either a String that matches a key used in every data point, or an accessor function that receives a data point and it's index in the data array, and is expected to return it's row value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Example

```ts
function row(d) {
return d.name;
}
```

<a id="rowlist-1"></a>

##### rowList()

> **rowList**(`_`: `any`): `any`

Defined in: [charts/RadialMatrix.ts:301](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/RadialMatrix.ts#L301)

A manual list of IDs to be used for rows.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="rowsort-1"></a>

##### rowSort()

> **rowSort**(`_`: `any`): `any`

Defined in: [charts/RadialMatrix.ts:313](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/RadialMatrix.ts#L313)

A sort comparator function that is run on the unique set of row values.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Example

```ts
function row(a, b) {
return a.localeCompare(b);
}
```

<a id="scrollcontainer-14"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| `HTMLElement` \| `Window` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| `HTMLElement` \| `Window` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`scrollContainer`](#scrollcontainer-20)

<a id="select-28"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

`Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`select`](#select-38)

<a id="shape-20"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`shape`](#shape-28)

<a id="shapeconfig-28"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`shapeConfig`](#shapeconfig-40)

<a id="subtitle-14"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`subtitle`](#subtitle-20)

<a id="subtitleconfig-14"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`subtitleConfig`](#subtitleconfig-20)

<a id="subtitlepadding-14"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`subtitlePadding`](#subtitlepadding-20)

<a id="svgdesc-14"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`svgDesc`](#svgdesc-20)

<a id="svgtitle-14"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`svgTitle`](#svgtitle-20)

<a id="threshold-14"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| ((`data`: `DataPoint`[]) => `number`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| ((`data`: `DataPoint`[]) => `number`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`threshold`](#threshold-20)

<a id="thresholdkey-14"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`thresholdKey`](#thresholdkey-20)

<a id="thresholdname-14"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`thresholdName`](#thresholdname-20)

<a id="time-14"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`time`](#time-20)

<a id="timefilter-14"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`timeFilter`](#timefilter-20)

<a id="timeline-14"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`timeline`](#timeline-21)

<a id="timelineconfig-14"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`timelineConfig`](#timelineconfig-21)

<a id="timelinedefault-14"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): `Date`[] \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

`Date`[] \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`timelineDefault`](#timelinedefault-20)

<a id="timelinepadding-14"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`timelinePadding`](#timelinepadding-21)

<a id="title-20"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`title`](#title-28)

<a id="titleconfig-20"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`titleConfig`](#titleconfig-27)

<a id="titlepadding-14"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`titlePadding`](#titlepadding-20)

<a id="tooltip-14"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`tooltip`](#tooltip-21)

<a id="tooltipconfig-14"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`tooltipConfig`](#tooltipconfig-21)

<a id="total-14"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`total`](#total-20)

<a id="totalconfig-14"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`totalConfig`](#totalconfig-20)

<a id="totalformat-14"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): ((`d`: `number`) => `string`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

((`d`: `number`) => `string`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`totalFormat`](#totalformat-20)

<a id="totalpadding-14"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`totalPadding`](#totalpadding-20)

<a id="width-23"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`width`](#width-33)

<a id="zoom-14"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`zoom`](#zoom-20)

<a id="zoombrushhandlesize-14"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleSize`](#zoombrushhandlesize-20)

<a id="zoombrushhandlestyle-14"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleStyle`](#zoombrushhandlestyle-20)

<a id="zoombrushselectionstyle-14"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`zoomBrushSelectionStyle`](#zoombrushselectionstyle-20)

<a id="zoomcontrolstyle-14"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyle`](#zoomcontrolstyle-20)

<a id="zoomcontrolstyleactive-14"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleActive`](#zoomcontrolstyleactive-20)

<a id="zoomcontrolstylehover-14"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleHover`](#zoomcontrolstylehover-20)

<a id="zoomfactor-14"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`zoomFactor`](#zoomfactor-20)

<a id="zoommax-14"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`zoomMax`](#zoommax-20)

<a id="zoompadding-14"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`zoomPadding`](#zoompadding-20)

<a id="zoompan-14"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`zoomPan`](#zoompan-20)

<a id="zoomscroll-14"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`RadialMatrix`](#radialmatrix)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`RadialMatrix`](#radialmatrix)

###### Inherited from

[`Viz`](#viz).[`zoomScroll`](#zoomscroll-20)

***

<a id="rect"></a>

### Rect

Defined in: [shapes/Rect.ts:10](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Rect.ts#L10)

Creates SVG rectangles based on an array of data. See [this example](https://d3plus.org/examples/d3plus-shape/getting-started/) for help getting started using the rectangle generator.

#### Extends

- [`Shape`](#shape-23)

#### Methods

<a id="_datafilter-3"></a>

##### \_dataFilter()?

> `optional` **\_dataFilter**(`data`: `DataPoint`[]): `DataPoint`[]

Defined in: [shapes/Shape.ts:105](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L105)

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `data` | `DataPoint`[] | The raw data array to filter. |

###### Returns

`DataPoint`[]

###### Inherited from

[`Shape`](#shape-23).[`_dataFilter`](#_datafilter-4)

<a id="active-22"></a>

##### active()

###### Call Signature

> **active**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

Defined in: [shapes/Shape.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1019)

The active callback function for highlighting shapes.

###### Returns

((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

###### Inherited from

[`Shape`](#shape-23).[`active`](#active-25)

###### Call Signature

> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1020](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1020)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`active`](#active-25)

<a id="activeopacity-5"></a>

##### activeOpacity()

###### Call Signature

> **activeOpacity**(): `number`

Defined in: [shapes/Shape.ts:1037](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1037)

When shapes are active, this is the opacity of any shape that is not active.

###### Returns

`number`

###### Inherited from

[`Shape`](#shape-23).[`activeOpacity`](#activeopacity-6)

###### Call Signature

> **activeOpacity**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1038](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1038)

When shapes are active, this is the opacity of any shape that is not active.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`activeOpacity`](#activeopacity-6)

<a id="activestyle-5"></a>

##### activeStyle()

###### Call Signature

> **activeStyle**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1048](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1048)

The style to apply to active shapes.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`activeStyle`](#activestyle-6)

###### Call Signature

> **activeStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1049](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1049)

The style to apply to active shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`activeStyle`](#activestyle-6)

<a id="arialabel-5"></a>

##### ariaLabel()

###### Call Signature

> **ariaLabel**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1059](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1059)

The aria-label attribute for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`ariaLabel`](#arialabel-6)

###### Call Signature

> **ariaLabel**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1060](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1060)

The aria-label attribute for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`ariaLabel`](#arialabel-6)

<a id="backgroundimage-5"></a>

##### backgroundImage()

###### Call Signature

> **backgroundImage**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1070](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1070)

The background-image accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`backgroundImage`](#backgroundimage-6)

###### Call Signature

> **backgroundImage**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1071](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1071)

The background-image accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`backgroundImage`](#backgroundimage-6)

<a id="config-14"></a>

##### config()

###### Call Signature

> **config**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L91)

Methods that correspond to the key/value pairs and returns this class.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`Shape`](#shape-23).[`config`](#config-15)

###### Call Signature

> **config**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L92)

Methods that correspond to the key/value pairs and returns this class.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`config`](#config-15)

<a id="data-29"></a>

##### data()

###### Call Signature

> **data**(): `DataPoint`[]

Defined in: [shapes/Shape.ts:1082](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1082)

The data array used to create shapes. A shape will be drawn for each object in the array.

###### Returns

`DataPoint`[]

###### Inherited from

[`Shape`](#shape-23).[`data`](#data-32)

###### Call Signature

> **data**(`_`: `DataPoint`[]): `this`

Defined in: [shapes/Shape.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1083)

The data array used to create shapes. A shape will be drawn for each object in the array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `DataPoint`[] |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`data`](#data-32)

<a id="discrete-20"></a>

##### discrete()

###### Call Signature

> **discrete**(): `string` \| `undefined`

Defined in: [shapes/Shape.ts:1091](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1091)

Determines if either the X or Y position is discrete along a Line, which helps in determining the nearest data point on a line for a hit area event.

###### Returns

`string` \| `undefined`

###### Inherited from

[`Shape`](#shape-23).[`discrete`](#discrete-23)

###### Call Signature

> **discrete**(`_`: `string`): `this`

Defined in: [shapes/Shape.ts:1092](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1092)

Determines if either the X or Y position is discrete along a Line, which helps in determining the nearest data point on a line for a hit area event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`discrete`](#discrete-23)

<a id="duration-28"></a>

##### duration()

###### Call Signature

> **duration**(): `number`

Defined in: [shapes/Shape.ts:1100](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1100)

The animation duration in milliseconds.

###### Returns

`number`

###### Inherited from

[`Shape`](#shape-23).[`duration`](#duration-31)

###### Call Signature

> **duration**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1101](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1101)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`duration`](#duration-31)

<a id="fill-5"></a>

##### fill()

###### Call Signature

> **fill**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1109](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1109)

The fill color accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`fill`](#fill-6)

###### Call Signature

> **fill**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1110](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1110)

The fill color accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`fill`](#fill-6)

<a id="fillopacity-5"></a>

##### fillOpacity()

###### Call Signature

> **fillOpacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1120](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1120)

Defines the "fill-opacity" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`fillOpacity`](#fillopacity-6)

###### Call Signature

> **fillOpacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1121](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1121)

Defines the "fill-opacity" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`fillOpacity`](#fillopacity-6)

<a id="height-24"></a>

##### height()

###### Call Signature

> **height**(): `AccessorFn`

Defined in: [shapes/Rect.ts:118](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Rect.ts#L118)

The height accessor for each rectangle.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.height;
}
```

###### Call Signature

> **height**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Rect.ts:119](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Rect.ts#L119)

The height accessor for each rectangle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.height;
}
```

<a id="hitarea-5"></a>

##### hitArea()

###### Call Signature

> **hitArea**(): ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) \| `null`

Defined in: [shapes/Shape.ts:1180](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1180)

The mouse hit area accessor function.

###### Returns

((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) \| `null`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`hitArea`](#hitarea-6)

###### Call Signature

> **hitArea**(`_`: `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>)): `this`

Defined in: [shapes/Shape.ts:1187](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1187)

The mouse hit area accessor function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) |

###### Returns

`this`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`hitArea`](#hitarea-6)

<a id="hover-22"></a>

##### hover()

###### Call Signature

> **hover**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

Defined in: [shapes/Shape.ts:1131](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1131)

The hover callback function for highlighting shapes on mouseover.

###### Returns

((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

###### Inherited from

[`Shape`](#shape-23).[`hover`](#hover-25)

###### Call Signature

> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1132](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1132)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`hover`](#hover-25)

<a id="hoveropacity-5"></a>

##### hoverOpacity()

###### Call Signature

> **hoverOpacity**(): `number`

Defined in: [shapes/Shape.ts:1160](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1160)

The opacity of non-hovered shapes when any shape is hovered.

###### Returns

`number`

###### Inherited from

[`Shape`](#shape-23).[`hoverOpacity`](#hoveropacity-6)

###### Call Signature

> **hoverOpacity**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1161](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1161)

The opacity of non-hovered shapes when any shape is hovered.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`hoverOpacity`](#hoveropacity-6)

<a id="hoverstyle-5"></a>

##### hoverStyle()

###### Call Signature

> **hoverStyle**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1149](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1149)

The style to apply to hovered shapes.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`hoverStyle`](#hoverstyle-6)

###### Call Signature

> **hoverStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1150)

The style to apply to hovered shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`hoverStyle`](#hoverstyle-6)

<a id="id-7"></a>

##### id()

###### Call Signature

> **id**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1220](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1220)

The unique id accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`id`](#id-8)

###### Call Signature

> **id**(`_`: `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1221](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1221)

The unique id accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`id`](#id-8)

<a id="label-21"></a>

##### label()

###### Call Signature

> **label**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1229](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1229)

The text label accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`label`](#label-24)

###### Call Signature

> **label**(`_`: `string` \| `string`[] \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1230](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1230)

The text label accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `string`[] \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`label`](#label-24)

<a id="labelbounds-5"></a>

##### labelBounds()

###### Call Signature

> **labelBounds**(): ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null`

Defined in: [shapes/Shape.ts:1251](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1251)

The label bounds accessor function.

###### Returns

((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`labelBounds`](#labelbounds-6)

###### Call Signature

> **labelBounds**(`_`: `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`)): `this`

Defined in: [shapes/Shape.ts:1258](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1258)

The label bounds accessor function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) |

###### Returns

`this`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Inherited from

[`Shape`](#shape-23).[`labelBounds`](#labelbounds-6)

<a id="labelconfig-6"></a>

##### labelConfig()

###### Call Signature

> **labelConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1291](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1291)

A pass-through to the config method of the TextBox class used to create a shape's labels.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`labelConfig`](#labelconfig-7)

###### Call Signature

> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1292](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1292)

A pass-through to the config method of the TextBox class used to create a shape's labels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`labelConfig`](#labelconfig-7)

<a id="locale-14"></a>

##### locale()

###### Call Signature

> **locale**(): `string`

Defined in: [utils/BaseClass.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L156)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Returns

`string`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Shape`](#shape-23).[`locale`](#locale-15)

###### Call Signature

> **locale**(`_`: `string` \| `object`): `this`

Defined in: [utils/BaseClass.ts:157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L157)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `object` |

###### Returns

`this`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Shape`](#shape-23).[`locale`](#locale-15)

<a id="on-14"></a>

##### on()

###### Call Signature

> **on**(): `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

Defined in: [utils/BaseClass.ts:176](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L176)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Returns

`Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

###### Call Signature

> **on**(`_`: `string`): ((...`args`: `unknown`[]) => `unknown`) \| `undefined`

Defined in: [utils/BaseClass.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L177)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

((...`args`: `unknown`[]) => `unknown`) \| `undefined`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

###### Call Signature

> **on**(`_`: `string`, `f`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [utils/BaseClass.ts:178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L178)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |
| `f` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

###### Call Signature

> **on**(`_`: `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:179](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L179)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`Shape`](#shape-23).[`on`](#on-15)

<a id="opacity-6"></a>

##### opacity()

###### Call Signature

> **opacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1302](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1302)

The opacity accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`opacity`](#opacity-7)

###### Call Signature

> **opacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1303](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1303)

The opacity accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`opacity`](#opacity-7)

<a id="parent-14"></a>

##### parent()

###### Call Signature

> **parent**(): `Record`\<`string`, `unknown`\>

Defined in: [utils/BaseClass.ts:200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L200)

Parent config used by the wrapper.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`parent`](#parent-15)

###### Call Signature

> **parent**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L201)

Parent config used by the wrapper.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`parent`](#parent-15)

<a id="pointerevents-6"></a>

##### pointerEvents()

###### Call Signature

> **pointerEvents**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1313](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1313)

The pointer-events CSS property for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`pointerEvents`](#pointerevents-7)

###### Call Signature

> **pointerEvents**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1314](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1314)

The pointer-events CSS property for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`pointerEvents`](#pointerevents-7)

<a id="render-29"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [shapes/Rect.ts:47](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Rect.ts#L47)

Draws the rectangles.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Overrides

[`Shape`](#shape-23).[`render`](#render-32)

<a id="role-5"></a>

##### role()

###### Call Signature

> **role**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1325](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1325)

The role attribute.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`role`](#role-6)

###### Call Signature

> **role**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1326](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1326)

The role attribute.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`role`](#role-6)

<a id="rotate-5"></a>

##### rotate()

###### Call Signature

> **rotate**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1336](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1336)

The rotation angle in degrees for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`rotate`](#rotate-6)

###### Call Signature

> **rotate**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1337](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1337)

The rotation angle in degrees for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`rotate`](#rotate-6)

<a id="rx-5"></a>

##### rx()

###### Call Signature

> **rx**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1347](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1347)

Defines the "rx" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`rx`](#rx-6)

###### Call Signature

> **rx**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1348](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1348)

Defines the "rx" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`rx`](#rx-6)

<a id="ry-5"></a>

##### ry()

###### Call Signature

> **ry**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1358](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1358)

Defines the "rx" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`ry`](#ry-6)

###### Call Signature

> **ry**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1359](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1359)

Defines the "rx" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`ry`](#ry-6)

<a id="scale-11"></a>

##### scale()

###### Call Signature

> **scale**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1369](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1369)

The scale transform accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`scale`](#scale-12)

###### Call Signature

> **scale**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1370](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1370)

The scale transform accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`scale`](#scale-12)

<a id="select-29"></a>

##### select()

###### Call Signature

> **select**(): `Selection`

Defined in: [shapes/Shape.ts:1380](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1380)

The SVG container element as a d3 selector or DOM element.

###### Returns

`Selection`

###### Inherited from

[`Shape`](#shape-23).[`select`](#select-32)

###### Call Signature

> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`

Defined in: [shapes/Shape.ts:1381](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1381)

The SVG container element as a d3 selector or DOM element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `HTMLElement` \| `SVGElement` \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`select`](#select-32)

<a id="shapeconfig-29"></a>

##### shapeConfig()

###### Call Signature

> **shapeConfig**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L225)

Configuration object with key/value pairs applied as method calls on each shape.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`Shape`](#shape-23).[`shapeConfig`](#shapeconfig-33)

###### Call Signature

> **shapeConfig**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:226](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L226)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`shapeConfig`](#shapeconfig-33)

<a id="shaperendering-5"></a>

##### shapeRendering()

###### Call Signature

> **shapeRendering**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1396](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1396)

The shape-rendering.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`shapeRendering`](#shaperendering-6)

###### Call Signature

> **shapeRendering**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1397)

The shape-rendering.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`shapeRendering`](#shaperendering-6)

<a id="sort-8"></a>

##### sort()

###### Call Signature

> **sort**(): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`

Defined in: [shapes/Shape.ts:1408](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1408)

A comparator function used to sort shapes for layering order.

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`

###### Inherited from

[`Shape`](#shape-23).[`sort`](#sort-9)

###### Call Signature

> **sort**(`_`: ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1409](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1409)

A comparator function used to sort shapes for layering order.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`sort`](#sort-9)

<a id="stroke-5"></a>

##### stroke()

###### Call Signature

> **stroke**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1419](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1419)

The stroke color accessor for each shape.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`stroke`](#stroke-6)

###### Call Signature

> **stroke**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1420](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1420)

The stroke color accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`stroke`](#stroke-6)

<a id="strokedasharray-5"></a>

##### strokeDasharray()

###### Call Signature

> **strokeDasharray**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1430](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1430)

Defines the "stroke-dasharray" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeDasharray`](#strokedasharray-6)

###### Call Signature

> **strokeDasharray**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1431](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1431)

Defines the "stroke-dasharray" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeDasharray`](#strokedasharray-6)

<a id="strokelinecap-5"></a>

##### strokeLinecap()

###### Call Signature

> **strokeLinecap**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1442](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1442)

Defines the "stroke-linecap" attribute for the shapes. Accepted values are `"butt"`, `"round"`, and `"square"`.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeLinecap`](#strokelinecap-6)

###### Call Signature

> **strokeLinecap**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1443](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1443)

Defines the "stroke-linecap" attribute for the shapes. Accepted values are `"butt"`, `"round"`, and `"square"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeLinecap`](#strokelinecap-6)

<a id="strokeopacity-5"></a>

##### strokeOpacity()

###### Call Signature

> **strokeOpacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1454](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1454)

Defines the "stroke-opacity" attribute for the shapes.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeOpacity`](#strokeopacity-6)

###### Call Signature

> **strokeOpacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1455](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1455)

Defines the "stroke-opacity" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeOpacity`](#strokeopacity-6)

<a id="strokewidth-5"></a>

##### strokeWidth()

###### Call Signature

> **strokeWidth**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1466](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1466)

The stroke-width.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`strokeWidth`](#strokewidth-6)

###### Call Signature

> **strokeWidth**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1467](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1467)

The stroke-width.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`strokeWidth`](#strokewidth-6)

<a id="textanchor-5"></a>

##### textAnchor()

###### Call Signature

> **textAnchor**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1477](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1477)

The text-anchor.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`textAnchor`](#textanchor-6)

###### Call Signature

> **textAnchor**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1478](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1478)

The text-anchor.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`textAnchor`](#textanchor-6)

<a id="texture-5"></a>

##### texture()

###### Call Signature

> **texture**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1488](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1488)

Defines the texture used inside of each shape. This uses the [textures.js](https://riccardoscalco.it/textures/) package, and expects either a simple string (`"lines"` or `"circles"`) or a more complex Object containing the various properties of the texture (ie. `{texture: "lines", orientation: "3/8", stroke: "darkorange"}`). If multiple textures are necessary, provide an accsesor Function that returns the correct String/Object for each given data point and index.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`texture`](#texture-6)

###### Call Signature

> **texture**(`_`: `string` \| `Record`\<`string`, `unknown`\> \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1489](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1489)

Defines the texture used inside of each shape. This uses the [textures.js](https://riccardoscalco.it/textures/) package, and expects either a simple string (`"lines"` or `"circles"`) or a more complex Object containing the various properties of the texture (ie. `{texture: "lines", orientation: "3/8", stroke: "darkorange"}`). If multiple textures are necessary, provide an accsesor Function that returns the correct String/Object for each given data point and index.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `Record`\<`string`, `unknown`\> \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`texture`](#texture-6)

<a id="texturedefault-5"></a>

##### textureDefault()

###### Call Signature

> **textureDefault**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1503)

A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Shape`](#shape-23).[`textureDefault`](#texturedefault-6)

###### Call Signature

> **textureDefault**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1504](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1504)

A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`textureDefault`](#texturedefault-6)

<a id="translate-14"></a>

##### translate()

###### Call Signature

> **translate**(): (`d`: `string`, `locale?`: `string`) => `string`

Defined in: [utils/BaseClass.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L214)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Returns

(`d`: `string`, `locale?`: `string`) => `string`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Shape`](#shape-23).[`translate`](#translate-15)

###### Call Signature

> **translate**(`_`: (`d`: `string`, `locale?`: `string`) => `string`): `this`

Defined in: [utils/BaseClass.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L215)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `string`, `locale?`: `string`) => `string` |

###### Returns

`this`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Shape`](#shape-23).[`translate`](#translate-15)

<a id="vectoreffect-5"></a>

##### vectorEffect()

###### Call Signature

> **vectorEffect**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1514](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1514)

The vector-effect.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`vectorEffect`](#vectoreffect-6)

###### Call Signature

> **vectorEffect**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1515](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1515)

The vector-effect.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`vectorEffect`](#vectoreffect-6)

<a id="verticalalign-6"></a>

##### verticalAlign()

###### Call Signature

> **verticalAlign**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1525](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1525)

The vertical alignment.

###### Returns

`AccessorFn`

###### Inherited from

[`Shape`](#shape-23).[`verticalAlign`](#verticalalign-7)

###### Call Signature

> **verticalAlign**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1526](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1526)

The vertical alignment.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Inherited from

[`Shape`](#shape-23).[`verticalAlign`](#verticalalign-7)

<a id="width-24"></a>

##### width()

###### Call Signature

> **width**(): `AccessorFn`

Defined in: [shapes/Rect.ts:134](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Rect.ts#L134)

The width accessor for each rectangle.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.width;
}
```

###### Call Signature

> **width**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Rect.ts:135](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Rect.ts#L135)

The width accessor for each rectangle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.width;
}
```

<a id="x-14"></a>

##### x()

###### Call Signature

> **x**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1542](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1542)

The x position accessor for each shape.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`x`](#x-15)

###### Call Signature

> **x**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1543)

The x position accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Inherited from

[`Shape`](#shape-23).[`x`](#x-15)

<a id="y-14"></a>

##### y()

###### Call Signature

> **y**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1558](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1558)

The y position accessor for each shape.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.y;
}
```

###### Inherited from

[`Shape`](#shape-23).[`y`](#y-15)

###### Call Signature

> **y**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1559](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1559)

The y position accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.y;
}
```

###### Inherited from

[`Shape`](#shape-23).[`y`](#y-15)

#### Properties

| Property | Type | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="property-_active-5"></a> `_active` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | - | [`Shape`](#shape-23).[`_active`](#property-_active-6) | [shapes/Shape.ts:116](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L116) |
| <a id="property-_activegroup-5"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-23).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:112](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L112) |
| <a id="property-_activeopacity-5"></a> `_activeOpacity` | `number` | - | [`Shape`](#shape-23).[`_activeOpacity`](#property-_activeopacity-6) | [shapes/Shape.ts:57](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L57) |
| <a id="property-_activestyle-5"></a> `_activeStyle` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_activeStyle`](#property-_activestyle-6) | [shapes/Shape.ts:58](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L58) |
| <a id="property-_arialabel-5"></a> `_ariaLabel` | `AccessorFn` | - | [`Shape`](#shape-23).[`_ariaLabel`](#property-_arialabel-6) | [shapes/Shape.ts:59](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L59) |
| <a id="property-_backgroundimage-5"></a> `_backgroundImage` | `AccessorFn` | - | [`Shape`](#shape-23).[`_backgroundImage`](#property-_backgroundimage-6) | [shapes/Shape.ts:60](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L60) |
| <a id="property-_backgroundimageclass-5"></a> `_backgroundImageClass` | [`Image`](#image) | - | [`Shape`](#shape-23).[`_backgroundImageClass`](#property-_backgroundimageclass-6) | [shapes/Shape.ts:61](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L61) |
| <a id="property-_configdefault-14"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | - | [`Shape`](#shape-23).[`_configDefault`](#property-_configdefault-15) | [utils/BaseClass.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L69) |
| <a id="property-_curve-5"></a> `_curve` | `AccessorFn` | - | [`Shape`](#shape-23).[`_curve`](#property-_curve-6) | [shapes/Shape.ts:121](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L121) |
| <a id="property-_data-14"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-23).[`_data`](#property-_data-15) | [shapes/Shape.ts:62](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L62) |
| <a id="property-_defined-5"></a> `_defined` | `AccessorFn` | - | [`Shape`](#shape-23).[`_defined`](#property-_defined-6) | [shapes/Shape.ts:120](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L120) |
| <a id="property-_discrete-5"></a> `_discrete` | `string` \| *required* | - | [`Shape`](#shape-23).[`_discrete`](#property-_discrete-6) | [shapes/Shape.ts:118](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L118) |
| <a id="property-_duration-14"></a> `_duration` | `number` | - | [`Shape`](#shape-23).[`_duration`](#property-_duration-15) | [shapes/Shape.ts:63](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L63) |
| <a id="property-_enter-5"></a> `_enter` | `Selection` | - | [`Shape`](#shape-23).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:109](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L109) |
| <a id="property-_exit-5"></a> `_exit` | `Selection` | - | [`Shape`](#shape-23).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:110](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L110) |
| <a id="property-_fill-5"></a> `_fill` | `AccessorFn` | - | [`Shape`](#shape-23).[`_fill`](#property-_fill-6) | [shapes/Shape.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L64) |
| <a id="property-_fillopacity-5"></a> `_fillOpacity` | `AccessorFn` | - | [`Shape`](#shape-23).[`_fillOpacity`](#property-_fillopacity-6) | [shapes/Shape.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L65) |
| <a id="property-_group-12"></a> `_group` | `Selection` | - | [`Shape`](#shape-23).[`_group`](#property-_group-13) | [shapes/Shape.ts:107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L107) |
| <a id="property-_height-9"></a> `_height` | `AccessorFn` | - | - | [shapes/Rect.ts:11](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Rect.ts#L11) |
| <a id="property-_hitarea-5"></a> `_hitArea` | ((`d`: `DataPoint`, `i`: `number`, `aes`: `ShapeAes`) => `Record`\<`string`, `unknown`\>) \| `null` | - | [`Shape`](#shape-23).[`_hitArea`](#property-_hitarea-6) | [shapes/Shape.ts:113](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L113) |
| <a id="property-_hover-5"></a> `_hover` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | - | [`Shape`](#shape-23).[`_hover`](#property-_hover-6) | [shapes/Shape.ts:117](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L117) |
| <a id="property-_hovergroup-5"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-23).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:111](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L111) |
| <a id="property-_hoveropacity-5"></a> `_hoverOpacity` | `number` | - | [`Shape`](#shape-23).[`_hoverOpacity`](#property-_hoveropacity-6) | [shapes/Shape.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L66) |
| <a id="property-_hoverstyle-5"></a> `_hoverStyle` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_hoverStyle`](#property-_hoverstyle-6) | [shapes/Shape.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L67) |
| <a id="property-_id-7"></a> `_id` | `AccessorFn` | - | [`Shape`](#shape-23).[`_id`](#property-_id-8) | [shapes/Shape.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L68) |
| <a id="property-_label-6"></a> `_label` | `AccessorFn` | - | [`Shape`](#shape-23).[`_label`](#property-_label-7) | [shapes/Shape.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L69) |
| <a id="property-_labelbounds-5"></a> `_labelBounds` | ((`d`: `DataPoint`, `i`: `number`, `aes`: `ShapeAes`) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null` | [`Shape`](#shape-23).[`_labelBounds`](#property-_labelbounds-6) | - | [shapes/Rect.ts:12](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Rect.ts#L12) |
| <a id="property-_labelclass-6"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-23).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L70) |
| <a id="property-_labelconfig-6"></a> `_labelConfig` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_labelConfig`](#property-_labelconfig-7) | [shapes/Shape.ts:71](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L71) |
| <a id="property-_locale-14"></a> `_locale` | `string` | - | [`Shape`](#shape-23).[`_locale`](#property-_locale-15) | [utils/BaseClass.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L64) |
| <a id="property-_name-5"></a> `_name` | `string` | [`Shape`](#shape-23).[`_name`](#property-_name-6) | - | [shapes/Rect.ts:19](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Rect.ts#L19) |
| <a id="property-_on-14"></a> `_on` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | - | [`Shape`](#shape-23).[`_on`](#property-_on-15) | [utils/BaseClass.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L65) |
| <a id="property-_opacity-6"></a> `_opacity` | `AccessorFn` | - | [`Shape`](#shape-23).[`_opacity`](#property-_opacity-7) | [shapes/Shape.ts:80](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L80) |
| <a id="property-_parent-14"></a> `_parent` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_parent`](#property-_parent-15) | [utils/BaseClass.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L66) |
| <a id="property-_path-5"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_path`](#property-_path-6) | [shapes/Shape.ts:119](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L119) |
| <a id="property-_pointerevents-6"></a> `_pointerEvents` | `AccessorFn` | - | [`Shape`](#shape-23).[`_pointerEvents`](#property-_pointerevents-7) | [shapes/Shape.ts:81](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L81) |
| <a id="property-_role-5"></a> `_role` | `AccessorFn` | - | [`Shape`](#shape-23).[`_role`](#property-_role-6) | [shapes/Shape.ts:82](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L82) |
| <a id="property-_rotate-5"></a> `_rotate` | `AccessorFn` | - | [`Shape`](#shape-23).[`_rotate`](#property-_rotate-6) | [shapes/Shape.ts:83](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L83) |
| <a id="property-_rx-5"></a> `_rx` | `AccessorFn` | - | [`Shape`](#shape-23).[`_rx`](#property-_rx-6) | [shapes/Shape.ts:84](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L84) |
| <a id="property-_ry-5"></a> `_ry` | `AccessorFn` | - | [`Shape`](#shape-23).[`_ry`](#property-_ry-6) | [shapes/Shape.ts:85](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L85) |
| <a id="property-_scale-11"></a> `_scale` | `AccessorFn` | - | [`Shape`](#shape-23).[`_scale`](#property-_scale-12) | [shapes/Shape.ts:86](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L86) |
| <a id="property-_select-14"></a> `_select` | `Selection` | - | [`Shape`](#shape-23).[`_select`](#property-_select-15) | [shapes/Shape.ts:102](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L102) |
| <a id="property-_shapeconfig-14"></a> `_shapeConfig?` | [`D3plusConfig`](#d3plusconfig) | - | [`Shape`](#shape-23).[`_shapeConfig`](#property-_shapeconfig-15) | [utils/BaseClass.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L70) |
| <a id="property-_shaperendering-5"></a> `_shapeRendering` | `AccessorFn` | - | [`Shape`](#shape-23).[`_shapeRendering`](#property-_shaperendering-6) | [shapes/Shape.ts:87](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L87) |
| <a id="property-_sort-5"></a> `_sort` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | - | [`Shape`](#shape-23).[`_sort`](#property-_sort-6) | [shapes/Shape.ts:106](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L106) |
| <a id="property-_stroke-5"></a> `_stroke` | `AccessorFn` | - | [`Shape`](#shape-23).[`_stroke`](#property-_stroke-6) | [shapes/Shape.ts:88](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L88) |
| <a id="property-_strokedasharray-5"></a> `_strokeDasharray` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeDasharray`](#property-_strokedasharray-6) | [shapes/Shape.ts:89](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L89) |
| <a id="property-_strokelinecap-5"></a> `_strokeLinecap` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeLinecap`](#property-_strokelinecap-6) | [shapes/Shape.ts:90](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L90) |
| <a id="property-_strokeopacity-5"></a> `_strokeOpacity` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeOpacity`](#property-_strokeopacity-6) | [shapes/Shape.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L91) |
| <a id="property-_strokewidth-5"></a> `_strokeWidth` | `AccessorFn` | - | [`Shape`](#shape-23).[`_strokeWidth`](#property-_strokewidth-6) | [shapes/Shape.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L92) |
| <a id="property-_tagname-5"></a> `_tagName` | `string` | - | [`Shape`](#shape-23).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:93](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L93) |
| <a id="property-_textanchor-5"></a> `_textAnchor` | `AccessorFn` | - | [`Shape`](#shape-23).[`_textAnchor`](#property-_textanchor-6) | [shapes/Shape.ts:94](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L94) |
| <a id="property-_texture-5"></a> `_texture` | `AccessorFn` | - | [`Shape`](#shape-23).[`_texture`](#property-_texture-6) | [shapes/Shape.ts:95](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L95) |
| <a id="property-_texturedefault-5"></a> `_textureDefault` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-23).[`_textureDefault`](#property-_texturedefault-6) | [shapes/Shape.ts:96](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L96) |
| <a id="property-_texturedefs-5"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-23).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:97](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L97) |
| <a id="property-_transition-10"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-23).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:103](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L103) |
| <a id="property-_translate-14"></a> `_translate` | (`d`: `string`, `locale?`: `string`) => `string` | - | [`Shape`](#shape-23).[`_translate`](#property-_translate-15) | [utils/BaseClass.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L67) |
| <a id="property-_update-5"></a> `_update` | `Selection` | - | [`Shape`](#shape-23).[`_update`](#property-_update-6) | [shapes/Shape.ts:108](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L108) |
| <a id="property-_uuid-14"></a> `_uuid` | `string` | - | [`Shape`](#shape-23).[`_uuid`](#property-_uuid-15) | [utils/BaseClass.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L68) |
| <a id="property-_vectoreffect-5"></a> `_vectorEffect` | `AccessorFn` | - | [`Shape`](#shape-23).[`_vectorEffect`](#property-_vectoreffect-6) | [shapes/Shape.ts:98](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L98) |
| <a id="property-_verticalalign-6"></a> `_verticalAlign` | `AccessorFn` | - | [`Shape`](#shape-23).[`_verticalAlign`](#property-_verticalalign-7) | [shapes/Shape.ts:99](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L99) |
| <a id="property-_width-9"></a> `_width` | `AccessorFn` | - | - | [shapes/Rect.ts:20](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Rect.ts#L20) |
| <a id="property-_x-7"></a> `_x` | `AccessorFn` | - | [`Shape`](#shape-23).[`_x`](#property-_x-8) | [shapes/Shape.ts:100](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L100) |
| <a id="property-_y-7"></a> `_y` | `AccessorFn` | - | [`Shape`](#shape-23).[`_y`](#property-_y-8) | [shapes/Shape.ts:101](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L101) |

***

<a id="rings"></a>

### Rings

Defined in: [charts/Rings.ts:15](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Rings.ts#L15)

Creates a ring visualization based on a defined set of nodes and edges. [Click here](http://d3plus.org/examples/d3plus-network/simple-rings/) for help getting started using the Rings class.

#### Extends

- [`Viz`](#viz)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-23"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`active`](#active-29)

<a id="aggs-15"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`aggs`](#aggs-20)

<a id="ariahidden-15"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`ariaHidden`](#ariahidden-21)

<a id="attribution-15"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`attribution`](#attribution-20)

<a id="attributionstyle-15"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`attributionStyle`](#attributionstyle-20)

<a id="backconfig-15"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`backConfig`](#backconfig-20)

<a id="cache-15"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`cache`](#cache-20)

<a id="center"></a>

##### center()

> **center**(`_`: `any`): `any`

Defined in: [charts/Rings.ts:576](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Rings.ts#L576)

The center node, specified by id.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="color-16"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`color`](#color-21)

<a id="colorscale-16"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`colorScale`](#colorscale-21)

<a id="colorscaleconfig-16"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`colorScaleConfig`](#colorscaleconfig-21)

<a id="colorscalemaxsize-15"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`colorScaleMaxSize`](#colorscalemaxsize-20)

<a id="colorscalepadding-16"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`colorScalePadding`](#colorscalepadding-21)

<a id="colorscaleposition-15"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`colorScalePosition`](#colorscaleposition-20)

<a id="data-30"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): `DataPoint`[] \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

`DataPoint`[] \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`data`](#data-39)

<a id="datacutoff-15"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`dataCutoff`](#datacutoff-20)

<a id="depth-15"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`depth`](#depth-20)

<a id="destroy-15"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`destroy`](#destroy-20)

<a id="detectresize-15"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`detectResize`](#detectresize-20)

<a id="detectresizedelay-15"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`detectResizeDelay`](#detectresizedelay-20)

<a id="detectvisible-15"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`detectVisible`](#detectvisible-20)

<a id="detectvisibleinterval-15"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`detectVisibleInterval`](#detectvisibleinterval-20)

<a id="discrete-21"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`discrete`](#discrete-27)

<a id="downloadbutton-15"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`downloadButton`](#downloadbutton-20)

<a id="downloadconfig-15"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`downloadConfig`](#downloadconfig-20)

<a id="downloadposition-15"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`downloadPosition`](#downloadposition-20)

<a id="duration-29"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`duration`](#duration-37)

<a id="filter-15"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`filter`](#filter-20)

<a id="fontfamily-15"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| `string`[] \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| `string`[] \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`fontFamily`](#fontfamily-21)

<a id="groupby-15"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

(`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`groupBy`](#groupby-20)

<a id="height-25"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`height`](#height-33)

<a id="hiddencolor-15"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`hiddenColor`](#hiddencolor-20)

<a id="hiddenopacity-15"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`hiddenOpacity`](#hiddenopacity-20)

<a id="hover-23"></a>

##### hover()

> **hover**(`_`: `any`): [`Rings`](#rings)

Defined in: [charts/Rings.ts:583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Rings.ts#L583)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

[`Rings`](#rings)

###### Overrides

[`Viz`](#viz).[`hover`](#hover-29)

<a id="label-22"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`label`](#label-28)

<a id="legend-16"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`legend`](#legend-21)

<a id="legendconfig-17"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`legendConfig`](#legendconfig-22)

<a id="legendfilterinvert-15"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`legendFilterInvert`](#legendfilterinvert-20)

<a id="legendpadding-16"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`legendPadding`](#legendpadding-21)

<a id="legendposition-15"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| (() => `string`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| (() => `string`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`legendPosition`](#legendposition-20)

<a id="legendsort-15"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`legendSort`](#legendsort-20)

<a id="legendtooltip-15"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`legendTooltip`](#legendtooltip-20)

<a id="links-1"></a>

##### links()

> **links**(`_`: `any`, `f?`: `any`): `any`

Defined in: [charts/Rings.ts:601](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Rings.ts#L601)

A predefined *Array* of edges that connect each object passed to the [node](#Rings.node) method. The `source` and `target` keys in each link need to map to the nodes in one of three ways:
1. The index of the node in the nodes array (as in [this](http://d3plus.org/examples/d3plus-network/getting-started/) example).
2. The actual node *Object* itself.
3. A *String* value matching the `id` of the node.

The value passed should either be an *Array* of data or a *String* representing a filepath or URL to be loaded. An optional formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final links *Array*.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_` | `any` | - |
| `f?` | `any` | Array of link objects or a URL to load links from. |

###### Returns

`any`

<a id="linksize-1"></a>

##### linkSize()

> **linkSize**(`_`: `any`): `any`

Defined in: [charts/Rings.ts:612](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Rings.ts#L612)

Defines the thickness of the links connecting each node. The value provided can be either a pixel Number to be used for all links, or an accessor function that returns a specific data value to be used in an automatically calculated linear scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="linksizemin-1"></a>

##### linkSizeMin()

> **linkSizeMin**(`_`: `any`): `any`

Defined in: [charts/Rings.ts:621](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Rings.ts#L621)

Defines the minimum pixel stroke width used in link sizing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="linksizescale-1"></a>

##### linkSizeScale()

> **linkSizeScale**(`_`: `any`): `any`

Defined in: [charts/Rings.ts:630](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Rings.ts#L630)

The type of [continuous d3-scale](https://github.com/d3/d3-scale#continuous-scales) used when calculating the pixel size of links in the network.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="loadinghtml-15"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`loadingHTML`](#loadinghtml-20)

<a id="loadingmessage-15"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`loadingMessage`](#loadingmessage-20)

<a id="messagemask-15"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`messageMask`](#messagemask-20)

<a id="messagestyle-15"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`messageStyle`](#messagestyle-20)

<a id="nodatahtml-15"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`noDataHTML`](#nodatahtml-20)

<a id="nodatamessage-15"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`noDataMessage`](#nodatamessage-20)

<a id="nodegroupby-1"></a>

##### nodeGroupBy()

> **nodeGroupBy**(`_`: `any`): `any`

Defined in: [charts/Rings.ts:639](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Rings.ts#L639)

The node group accessor(s). This method overrides the default .groupBy() function from being used with the data passed to .nodes().

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="nodes-1"></a>

##### nodes()

> **nodes**(`_`: `any`, `f?`: `any`): `any`

Defined in: [charts/Rings.ts:665](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Rings.ts#L665)

The list of nodes to be used for drawing the rings network. The value passed should either be an *Array* of data or a *String* representing a filepath or URL to be loaded.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final node *Array*.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_` | `any` | - |
| `f?` | `any` | Array of node objects or a URL to load nodes from. |

###### Returns

`any`

<a id="render-30"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`render`](#render-38)

<a id="scrollcontainer-15"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| `HTMLElement` \| `Window` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| `HTMLElement` \| `Window` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`scrollContainer`](#scrollcontainer-20)

<a id="select-30"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

`Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`select`](#select-38)

<a id="shape-21"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`shape`](#shape-28)

<a id="shapeconfig-30"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`shapeConfig`](#shapeconfig-40)

<a id="size-8"></a>

##### size()

> **size**(`_`: `any`): `any`

Defined in: [charts/Rings.ts:676](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Rings.ts#L676)

The size accessor for each node in the rings layout.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="sizemax-7"></a>

##### sizeMax()

> **sizeMax**(`_`: `any`): `any`

Defined in: [charts/Rings.ts:685](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Rings.ts#L685)

The size scale maximum. By default, the maximum size is determined by half the distance of the two closest nodes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="sizemin-7"></a>

##### sizeMin()

> **sizeMin**(`_`: `any`): `any`

Defined in: [charts/Rings.ts:692](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Rings.ts#L692)

The size scale minimum.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="sizescale-7"></a>

##### sizeScale()

> **sizeScale**(`_`: `any`): `any`

Defined in: [charts/Rings.ts:699](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Rings.ts#L699)

The size scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="subtitle-15"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`subtitle`](#subtitle-20)

<a id="subtitleconfig-15"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`subtitleConfig`](#subtitleconfig-20)

<a id="subtitlepadding-15"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`subtitlePadding`](#subtitlepadding-20)

<a id="svgdesc-15"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`svgDesc`](#svgdesc-20)

<a id="svgtitle-15"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`svgTitle`](#svgtitle-20)

<a id="threshold-15"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`threshold`](#threshold-20)

<a id="thresholdkey-15"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`thresholdKey`](#thresholdkey-20)

<a id="thresholdname-15"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`thresholdName`](#thresholdname-20)

<a id="time-15"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`time`](#time-20)

<a id="timefilter-15"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`timeFilter`](#timefilter-20)

<a id="timeline-15"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`timeline`](#timeline-21)

<a id="timelineconfig-15"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`timelineConfig`](#timelineconfig-21)

<a id="timelinedefault-15"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): `Date`[] \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

`Date`[] \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`timelineDefault`](#timelinedefault-20)

<a id="timelinepadding-15"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`timelinePadding`](#timelinepadding-21)

<a id="title-21"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`title`](#title-28)

<a id="titleconfig-21"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`titleConfig`](#titleconfig-27)

<a id="titlepadding-15"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`titlePadding`](#titlepadding-20)

<a id="tooltip-15"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`tooltip`](#tooltip-21)

<a id="tooltipconfig-15"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`tooltipConfig`](#tooltipconfig-21)

<a id="total-15"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`total`](#total-20)

<a id="totalconfig-15"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`totalConfig`](#totalconfig-20)

<a id="totalformat-15"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): ((`d`: `number`) => `string`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

((`d`: `number`) => `string`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`totalFormat`](#totalformat-20)

<a id="totalpadding-15"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`totalPadding`](#totalpadding-20)

<a id="width-25"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`width`](#width-33)

<a id="zoom-15"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`zoom`](#zoom-20)

<a id="zoombrushhandlesize-15"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleSize`](#zoombrushhandlesize-20)

<a id="zoombrushhandlestyle-15"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleStyle`](#zoombrushhandlestyle-20)

<a id="zoombrushselectionstyle-15"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`zoomBrushSelectionStyle`](#zoombrushselectionstyle-20)

<a id="zoomcontrolstyle-15"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyle`](#zoomcontrolstyle-20)

<a id="zoomcontrolstyleactive-15"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleActive`](#zoomcontrolstyleactive-20)

<a id="zoomcontrolstylehover-15"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleHover`](#zoomcontrolstylehover-20)

<a id="zoomfactor-15"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`zoomFactor`](#zoomfactor-20)

<a id="zoommax-15"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`zoomMax`](#zoommax-20)

<a id="zoompadding-15"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`zoomPadding`](#zoompadding-20)

<a id="zoompan-15"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`zoomPan`](#zoompan-20)

<a id="zoomscroll-15"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`Rings`](#rings)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Rings`](#rings)

###### Inherited from

[`Viz`](#viz).[`zoomScroll`](#zoomscroll-20)

***

<a id="sankey"></a>

### Sankey

Defined in: [charts/Sankey.ts:28](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Sankey.ts#L28)

Creates a sankey visualization based on a defined set of nodes and links. [Click here](http://d3plus.org/examples/d3plus-network/sankey-diagram/) for help getting started using the Sankey class.

#### Extends

- [`Viz`](#viz)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-24"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`active`](#active-29)

<a id="aggs-16"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`aggs`](#aggs-20)

<a id="ariahidden-16"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`ariaHidden`](#ariahidden-21)

<a id="attribution-16"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`attribution`](#attribution-20)

<a id="attributionstyle-16"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`attributionStyle`](#attributionstyle-20)

<a id="backconfig-16"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`backConfig`](#backconfig-20)

<a id="cache-16"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`cache`](#cache-20)

<a id="color-17"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`color`](#color-21)

<a id="colorscale-17"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`colorScale`](#colorscale-21)

<a id="colorscaleconfig-17"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`colorScaleConfig`](#colorscaleconfig-21)

<a id="colorscalemaxsize-16"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`colorScaleMaxSize`](#colorscalemaxsize-20)

<a id="colorscalepadding-17"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`colorScalePadding`](#colorscalepadding-21)

<a id="colorscaleposition-16"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`colorScalePosition`](#colorscaleposition-20)

<a id="data-31"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): `DataPoint`[] \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

`DataPoint`[] \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`data`](#data-39)

<a id="datacutoff-16"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`dataCutoff`](#datacutoff-20)

<a id="depth-16"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`depth`](#depth-20)

<a id="destroy-16"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`destroy`](#destroy-20)

<a id="detectresize-16"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`detectResize`](#detectresize-20)

<a id="detectresizedelay-16"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`detectResizeDelay`](#detectresizedelay-20)

<a id="detectvisible-16"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`detectVisible`](#detectvisible-20)

<a id="detectvisibleinterval-16"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`detectVisibleInterval`](#detectvisibleinterval-20)

<a id="discrete-22"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`discrete`](#discrete-27)

<a id="downloadbutton-16"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`downloadButton`](#downloadbutton-20)

<a id="downloadconfig-16"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`downloadConfig`](#downloadconfig-20)

<a id="downloadposition-16"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`downloadPosition`](#downloadposition-20)

<a id="duration-30"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`duration`](#duration-37)

<a id="filter-16"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`filter`](#filter-20)

<a id="fontfamily-16"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| `string`[] \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| `string`[] \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`fontFamily`](#fontfamily-21)

<a id="groupby-16"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

(`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`groupBy`](#groupby-20)

<a id="height-26"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`height`](#height-33)

<a id="hiddencolor-16"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`hiddenColor`](#hiddencolor-20)

<a id="hiddenopacity-16"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`hiddenOpacity`](#hiddenopacity-20)

<a id="hover-24"></a>

##### hover()

> **hover**(`_`: `any`): [`Sankey`](#sankey)

Defined in: [charts/Sankey.ts:230](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Sankey.ts#L230)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

[`Sankey`](#sankey)

###### Overrides

[`Viz`](#viz).[`hover`](#hover-29)

<a id="iterations"></a>

##### iterations()

> **iterations**(`_`: `any`): `any`

Defined in: [charts/Sankey.ts:241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Sankey.ts#L241)

A pass-through for the d3-sankey [iterations](https://github.com/d3/d3-sankey?tab=readme-ov-file#sankey_iterations) function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="label-23"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`label`](#label-28)

<a id="legend-17"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`legend`](#legend-21)

<a id="legendconfig-18"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`legendConfig`](#legendconfig-22)

<a id="legendfilterinvert-16"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`legendFilterInvert`](#legendfilterinvert-20)

<a id="legendpadding-17"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`legendPadding`](#legendpadding-21)

<a id="legendposition-16"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| (() => `string`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| (() => `string`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`legendPosition`](#legendposition-20)

<a id="legendsort-16"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`legendSort`](#legendsort-20)

<a id="legendtooltip-16"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`legendTooltip`](#legendtooltip-20)

<a id="links-2"></a>

##### links()

> **links**(`_`: `any`, `f?`: `any`): `any`

Defined in: [charts/Sankey.ts:252](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Sankey.ts#L252)

A predefined *Array* of edges that connect each object passed to the [node](#Sankey.node) method. The `source` and `target` keys in each link need to map to the nodes in one of one way:
1. A *String* value matching the `id` of the node.

The value passed should be an *Array* of data. An optional formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final links *Array*.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_` | `any` | - |
| `f?` | `any` | Array of link objects or a URL to load links from. |

###### Returns

`any`

<a id="linksort"></a>

##### linkSort()

> **linkSort**(`_`: `any`): `any`

Defined in: [charts/Sankey.ts:263](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Sankey.ts#L263)

A pass-through for the d3-sankey [linkSort](https://github.com/d3/d3-sankey?tab=readme-ov-file#sankey_linkSort) function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="linkssource"></a>

##### linksSource()

> **linksSource**(`_`: `any`): `any`

Defined in: [charts/Sankey.ts:270](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Sankey.ts#L270)

The key inside of each link Object that references the source node.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="linkstarget"></a>

##### linksTarget()

> **linksTarget**(`_`: `any`): `any`

Defined in: [charts/Sankey.ts:279](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Sankey.ts#L279)

The key inside of each link Object that references the target node.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="loadinghtml-16"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`loadingHTML`](#loadinghtml-20)

<a id="loadingmessage-16"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`loadingMessage`](#loadingmessage-20)

<a id="messagemask-16"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`messageMask`](#messagemask-20)

<a id="messagestyle-16"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`messageStyle`](#messagestyle-20)

<a id="nodatahtml-16"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`noDataHTML`](#nodatahtml-20)

<a id="nodatamessage-16"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`noDataMessage`](#nodatamessage-20)

<a id="nodealign"></a>

##### nodeAlign()

> **nodeAlign**(`_`: `any`): `any`

Defined in: [charts/Sankey.ts:288](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Sankey.ts#L288)

The nodeAlign property of the sankey layout, which can be "left", "right", "center", or "justify".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="nodeid"></a>

##### nodeId()

> **nodeId**(`_`: `any`): `any`

Defined in: [charts/Sankey.ts:298](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Sankey.ts#L298)

The node id accessor(s).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="nodepadding"></a>

##### nodePadding()

> **nodePadding**(`_`: `any`): `any`

Defined in: [charts/Sankey.ts:321](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Sankey.ts#L321)

Padding of the node. By default, the nodePadding size is 8.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="nodes-2"></a>

##### nodes()

> **nodes**(`_`: `any`, `f?`: `any`): `any`

Defined in: [charts/Sankey.ts:310](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Sankey.ts#L310)

The list of nodes to be used for drawing the network. The value passed must be an *Array* of data.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final node *Array*.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_` | `any` | - |
| `f?` | `any` | Array of node objects or a URL to load nodes from. |

###### Returns

`any`

<a id="nodesort"></a>

##### nodeSort()

> **nodeSort**(`_`: `any`): `any`

Defined in: [charts/Sankey.ts:330](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Sankey.ts#L330)

A pass-through for the d3-sankey [nodeSort](https://github.com/d3/d3-sankey?tab=readme-ov-file#sankey_nodeSort) function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="nodewidth"></a>

##### nodeWidth()

> **nodeWidth**(`_`: `any`): `any`

Defined in: [charts/Sankey.ts:337](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Sankey.ts#L337)

Width of the node. By default, the nodeWidth size is 30.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="render-31"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`render`](#render-38)

<a id="scrollcontainer-16"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| `HTMLElement` \| `Window` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| `HTMLElement` \| `Window` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`scrollContainer`](#scrollcontainer-20)

<a id="select-31"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

`Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`select`](#select-38)

<a id="shape-22"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`shape`](#shape-28)

<a id="shapeconfig-31"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`shapeConfig`](#shapeconfig-40)

<a id="subtitle-16"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`subtitle`](#subtitle-20)

<a id="subtitleconfig-16"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`subtitleConfig`](#subtitleconfig-20)

<a id="subtitlepadding-16"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`subtitlePadding`](#subtitlepadding-20)

<a id="svgdesc-16"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`svgDesc`](#svgdesc-20)

<a id="svgtitle-16"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`svgTitle`](#svgtitle-20)

<a id="threshold-16"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`threshold`](#threshold-20)

<a id="thresholdkey-16"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`thresholdKey`](#thresholdkey-20)

<a id="thresholdname-16"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`thresholdName`](#thresholdname-20)

<a id="time-16"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`time`](#time-20)

<a id="timefilter-16"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`timeFilter`](#timefilter-20)

<a id="timeline-16"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`timeline`](#timeline-21)

<a id="timelineconfig-16"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`timelineConfig`](#timelineconfig-21)

<a id="timelinedefault-16"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): `Date`[] \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

`Date`[] \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`timelineDefault`](#timelinedefault-20)

<a id="timelinepadding-16"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`timelinePadding`](#timelinepadding-21)

<a id="title-22"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`title`](#title-28)

<a id="titleconfig-22"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`titleConfig`](#titleconfig-27)

<a id="titlepadding-16"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`titlePadding`](#titlepadding-20)

<a id="tooltip-16"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`tooltip`](#tooltip-21)

<a id="tooltipconfig-16"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`tooltipConfig`](#tooltipconfig-21)

<a id="total-16"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`total`](#total-20)

<a id="totalconfig-16"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`totalConfig`](#totalconfig-20)

<a id="totalformat-16"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): ((`d`: `number`) => `string`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

((`d`: `number`) => `string`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`totalFormat`](#totalformat-20)

<a id="totalpadding-16"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`totalPadding`](#totalpadding-20)

<a id="value-4"></a>

##### value()

> **value**(`_`: `any`): `any`

Defined in: [charts/Sankey.ts:349](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Sankey.ts#L349)

Width of the links.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Example

```ts
function value(d) {
return d.value;
}
```

<a id="width-26"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`width`](#width-33)

<a id="zoom-16"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`zoom`](#zoom-20)

<a id="zoombrushhandlesize-16"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleSize`](#zoombrushhandlesize-20)

<a id="zoombrushhandlestyle-16"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleStyle`](#zoombrushhandlestyle-20)

<a id="zoombrushselectionstyle-16"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`zoomBrushSelectionStyle`](#zoombrushselectionstyle-20)

<a id="zoomcontrolstyle-16"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyle`](#zoomcontrolstyle-20)

<a id="zoomcontrolstyleactive-16"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleActive`](#zoomcontrolstyleactive-20)

<a id="zoomcontrolstylehover-16"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleHover`](#zoomcontrolstylehover-20)

<a id="zoomfactor-16"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`zoomFactor`](#zoomfactor-20)

<a id="zoommax-16"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`zoomMax`](#zoommax-20)

<a id="zoompadding-16"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`zoomPadding`](#zoompadding-20)

<a id="zoompan-16"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`zoomPan`](#zoompan-20)

<a id="zoomscroll-16"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`Sankey`](#sankey)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Sankey`](#sankey)

###### Inherited from

[`Viz`](#viz).[`zoomScroll`](#zoomscroll-20)

***

<a id="shape-23"></a>

### Shape

Defined in: [shapes/Shape.ts:56](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L56)

An abstracted class for generating shapes.

#### Extends

- [`BaseClass`](#baseclass)

#### Extended by

- [`Area`](#area)
- [`Bar`](#bar)
- [`Circle`](#circle)
- [`Line`](#line)
- [`Path`](#path)
- [`Rect`](#rect)

#### Methods

<a id="_datafilter-4"></a>

##### \_dataFilter()?

> `optional` **\_dataFilter**(`data`: `DataPoint`[]): `DataPoint`[]

Defined in: [shapes/Shape.ts:105](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L105)

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `data` | `DataPoint`[] | The raw data array to filter. |

###### Returns

`DataPoint`[]

<a id="active-25"></a>

##### active()

###### Call Signature

> **active**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

Defined in: [shapes/Shape.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1019)

The active callback function for highlighting shapes.

###### Returns

((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

###### Call Signature

> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1020](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1020)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` |

###### Returns

`this`

<a id="activeopacity-6"></a>

##### activeOpacity()

###### Call Signature

> **activeOpacity**(): `number`

Defined in: [shapes/Shape.ts:1037](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1037)

When shapes are active, this is the opacity of any shape that is not active.

###### Returns

`number`

###### Call Signature

> **activeOpacity**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1038](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1038)

When shapes are active, this is the opacity of any shape that is not active.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="activestyle-6"></a>

##### activeStyle()

###### Call Signature

> **activeStyle**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1048](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1048)

The style to apply to active shapes.

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **activeStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1049](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1049)

The style to apply to active shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="arialabel-6"></a>

##### ariaLabel()

###### Call Signature

> **ariaLabel**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1059](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1059)

The aria-label attribute for each shape.

###### Returns

`AccessorFn`

###### Call Signature

> **ariaLabel**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1060](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1060)

The aria-label attribute for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

<a id="backgroundimage-6"></a>

##### backgroundImage()

###### Call Signature

> **backgroundImage**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1070](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1070)

The background-image accessor for each shape.

###### Returns

`AccessorFn`

###### Call Signature

> **backgroundImage**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1071](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1071)

The background-image accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

<a id="config-15"></a>

##### config()

###### Call Signature

> **config**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L91)

Methods that correspond to the key/value pairs and returns this class.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`BaseClass`](#baseclass).[`config`](#config-7)

###### Call Signature

> **config**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L92)

Methods that correspond to the key/value pairs and returns this class.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`config`](#config-7)

<a id="data-32"></a>

##### data()

###### Call Signature

> **data**(): `DataPoint`[]

Defined in: [shapes/Shape.ts:1082](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1082)

The data array used to create shapes. A shape will be drawn for each object in the array.

###### Returns

`DataPoint`[]

###### Call Signature

> **data**(`_`: `DataPoint`[]): `this`

Defined in: [shapes/Shape.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1083)

The data array used to create shapes. A shape will be drawn for each object in the array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `DataPoint`[] |

###### Returns

`this`

<a id="discrete-23"></a>

##### discrete()

###### Call Signature

> **discrete**(): `string` \| `undefined`

Defined in: [shapes/Shape.ts:1091](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1091)

Determines if either the X or Y position is discrete along a Line, which helps in determining the nearest data point on a line for a hit area event.

###### Returns

`string` \| `undefined`

###### Call Signature

> **discrete**(`_`: `string`): `this`

Defined in: [shapes/Shape.ts:1092](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1092)

Determines if either the X or Y position is discrete along a Line, which helps in determining the nearest data point on a line for a hit area event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="duration-31"></a>

##### duration()

###### Call Signature

> **duration**(): `number`

Defined in: [shapes/Shape.ts:1100](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1100)

The animation duration in milliseconds.

###### Returns

`number`

###### Call Signature

> **duration**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1101](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1101)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="fill-6"></a>

##### fill()

###### Call Signature

> **fill**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1109](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1109)

The fill color accessor for each shape.

###### Returns

`AccessorFn`

###### Call Signature

> **fill**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1110](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1110)

The fill color accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

<a id="fillopacity-6"></a>

##### fillOpacity()

###### Call Signature

> **fillOpacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1120](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1120)

Defines the "fill-opacity" attribute for the shapes.

###### Returns

`AccessorFn`

###### Call Signature

> **fillOpacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1121](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1121)

Defines the "fill-opacity" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

<a id="hitarea-6"></a>

##### hitArea()

###### Call Signature

> **hitArea**(): ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) \| `null`

Defined in: [shapes/Shape.ts:1180](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1180)

The mouse hit area accessor function.

###### Returns

((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) \| `null`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Call Signature

> **hitArea**(`_`: `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>)): `this`

Defined in: [shapes/Shape.ts:1187](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1187)

The mouse hit area accessor function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `Record`\<`string`, `unknown`\>) |

###### Returns

`this`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

<a id="hover-25"></a>

##### hover()

###### Call Signature

> **hover**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

Defined in: [shapes/Shape.ts:1131](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1131)

The hover callback function for highlighting shapes on mouseover.

###### Returns

((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`

###### Call Signature

> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1132](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1132)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` |

###### Returns

`this`

<a id="hoveropacity-6"></a>

##### hoverOpacity()

###### Call Signature

> **hoverOpacity**(): `number`

Defined in: [shapes/Shape.ts:1160](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1160)

The opacity of non-hovered shapes when any shape is hovered.

###### Returns

`number`

###### Call Signature

> **hoverOpacity**(`_`: `number`): `this`

Defined in: [shapes/Shape.ts:1161](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1161)

The opacity of non-hovered shapes when any shape is hovered.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="hoverstyle-6"></a>

##### hoverStyle()

###### Call Signature

> **hoverStyle**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1149](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1149)

The style to apply to hovered shapes.

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **hoverStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1150)

The style to apply to hovered shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="id-8"></a>

##### id()

###### Call Signature

> **id**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1220](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1220)

The unique id accessor for each shape.

###### Returns

`AccessorFn`

###### Call Signature

> **id**(`_`: `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1221](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1221)

The unique id accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `AccessorFn` |

###### Returns

`this`

<a id="label-24"></a>

##### label()

###### Call Signature

> **label**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1229](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1229)

The text label accessor for each shape.

###### Returns

`AccessorFn`

###### Call Signature

> **label**(`_`: `string` \| `string`[] \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1230](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1230)

The text label accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `string`[] \| `AccessorFn` |

###### Returns

`this`

<a id="labelbounds-6"></a>

##### labelBounds()

###### Call Signature

> **labelBounds**(): ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null`

Defined in: [shapes/Shape.ts:1251](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1251)

The label bounds accessor function.

###### Returns

((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

###### Call Signature

> **labelBounds**(`_`: `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`)): `this`

Defined in: [shapes/Shape.ts:1258](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1258)

The label bounds accessor function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `Record`\<`string`, `unknown`\>) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) |

###### Returns

`this`

###### Example

```ts
function(d, i, shape) {
return {
"width": shape.width,
"height": shape.height,
"x": -shape.width / 2,
"y": -shape.height / 2
};
}
```

<a id="labelconfig-7"></a>

##### labelConfig()

###### Call Signature

> **labelConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1291](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1291)

A pass-through to the config method of the TextBox class used to create a shape's labels.

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1292](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1292)

A pass-through to the config method of the TextBox class used to create a shape's labels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="locale-15"></a>

##### locale()

###### Call Signature

> **locale**(): `string`

Defined in: [utils/BaseClass.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L156)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Returns

`string`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`BaseClass`](#baseclass).[`locale`](#locale-7)

###### Call Signature

> **locale**(`_`: `string` \| `object`): `this`

Defined in: [utils/BaseClass.ts:157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L157)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `object` |

###### Returns

`this`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`BaseClass`](#baseclass).[`locale`](#locale-7)

<a id="on-15"></a>

##### on()

###### Call Signature

> **on**(): `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

Defined in: [utils/BaseClass.ts:176](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L176)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Returns

`Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `string`): ((...`args`: `unknown`[]) => `unknown`) \| `undefined`

Defined in: [utils/BaseClass.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L177)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

((...`args`: `unknown`[]) => `unknown`) \| `undefined`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `string`, `f`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [utils/BaseClass.ts:178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L178)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |
| `f` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:179](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L179)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

<a id="opacity-7"></a>

##### opacity()

###### Call Signature

> **opacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1302](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1302)

The opacity accessor for each shape.

###### Returns

`AccessorFn`

###### Call Signature

> **opacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1303](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1303)

The opacity accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

<a id="parent-15"></a>

##### parent()

###### Call Signature

> **parent**(): `Record`\<`string`, `unknown`\>

Defined in: [utils/BaseClass.ts:200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L200)

Parent config used by the wrapper.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`BaseClass`](#baseclass).[`parent`](#parent-7)

###### Call Signature

> **parent**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L201)

Parent config used by the wrapper.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`parent`](#parent-7)

<a id="pointerevents-7"></a>

##### pointerEvents()

###### Call Signature

> **pointerEvents**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1313](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1313)

The pointer-events CSS property for each shape.

###### Returns

`AccessorFn`

###### Call Signature

> **pointerEvents**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1314](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1314)

The pointer-events CSS property for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

<a id="render-32"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [shapes/Shape.ts:783](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L783)

Renders the current Shape to the page. If a *callback* is specified, it will be called once the shapes are done drawing.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

<a id="role-6"></a>

##### role()

###### Call Signature

> **role**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1325](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1325)

The role attribute.

###### Returns

`AccessorFn`

###### Call Signature

> **role**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1326](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1326)

The role attribute.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

<a id="rotate-6"></a>

##### rotate()

###### Call Signature

> **rotate**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1336](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1336)

The rotation angle in degrees for each shape.

###### Returns

`AccessorFn`

###### Call Signature

> **rotate**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1337](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1337)

The rotation angle in degrees for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

<a id="rx-6"></a>

##### rx()

###### Call Signature

> **rx**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1347](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1347)

Defines the "rx" attribute for the shapes.

###### Returns

`AccessorFn`

###### Call Signature

> **rx**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1348](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1348)

Defines the "rx" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

<a id="ry-6"></a>

##### ry()

###### Call Signature

> **ry**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1358](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1358)

Defines the "rx" attribute for the shapes.

###### Returns

`AccessorFn`

###### Call Signature

> **ry**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1359](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1359)

Defines the "rx" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

<a id="scale-12"></a>

##### scale()

###### Call Signature

> **scale**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1369](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1369)

The scale transform accessor for each shape.

###### Returns

`AccessorFn`

###### Call Signature

> **scale**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1370](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1370)

The scale transform accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

<a id="select-32"></a>

##### select()

###### Call Signature

> **select**(): `Selection`

Defined in: [shapes/Shape.ts:1380](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1380)

The SVG container element as a d3 selector or DOM element.

###### Returns

`Selection`

###### Call Signature

> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`

Defined in: [shapes/Shape.ts:1381](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1381)

The SVG container element as a d3 selector or DOM element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `HTMLElement` \| `SVGElement` \| `null` |

###### Returns

`this`

<a id="shapeconfig-33"></a>

##### shapeConfig()

###### Call Signature

> **shapeConfig**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L225)

Configuration object with key/value pairs applied as method calls on each shape.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`BaseClass`](#baseclass).[`shapeConfig`](#shapeconfig-9)

###### Call Signature

> **shapeConfig**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:226](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L226)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`shapeConfig`](#shapeconfig-9)

<a id="shaperendering-6"></a>

##### shapeRendering()

###### Call Signature

> **shapeRendering**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1396](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1396)

The shape-rendering.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Call Signature

> **shapeRendering**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1397)

The shape-rendering.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.x;
}
```

<a id="sort-9"></a>

##### sort()

###### Call Signature

> **sort**(): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`

Defined in: [shapes/Shape.ts:1408](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1408)

A comparator function used to sort shapes for layering order.

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`

###### Call Signature

> **sort**(`_`: ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`): `this`

Defined in: [shapes/Shape.ts:1409](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1409)

A comparator function used to sort shapes for layering order.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` |

###### Returns

`this`

<a id="stroke-6"></a>

##### stroke()

###### Call Signature

> **stroke**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1419](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1419)

The stroke color accessor for each shape.

###### Returns

`AccessorFn`

###### Call Signature

> **stroke**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1420](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1420)

The stroke color accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

<a id="strokedasharray-6"></a>

##### strokeDasharray()

###### Call Signature

> **strokeDasharray**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1430](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1430)

Defines the "stroke-dasharray" attribute for the shapes.

###### Returns

`AccessorFn`

###### Call Signature

> **strokeDasharray**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1431](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1431)

Defines the "stroke-dasharray" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

<a id="strokelinecap-6"></a>

##### strokeLinecap()

###### Call Signature

> **strokeLinecap**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1442](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1442)

Defines the "stroke-linecap" attribute for the shapes. Accepted values are `"butt"`, `"round"`, and `"square"`.

###### Returns

`AccessorFn`

###### Call Signature

> **strokeLinecap**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1443](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1443)

Defines the "stroke-linecap" attribute for the shapes. Accepted values are `"butt"`, `"round"`, and `"square"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

<a id="strokeopacity-6"></a>

##### strokeOpacity()

###### Call Signature

> **strokeOpacity**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1454](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1454)

Defines the "stroke-opacity" attribute for the shapes.

###### Returns

`AccessorFn`

###### Call Signature

> **strokeOpacity**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1455](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1455)

Defines the "stroke-opacity" attribute for the shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

<a id="strokewidth-6"></a>

##### strokeWidth()

###### Call Signature

> **strokeWidth**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1466](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1466)

The stroke-width.

###### Returns

`AccessorFn`

###### Call Signature

> **strokeWidth**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1467](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1467)

The stroke-width.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

<a id="textanchor-6"></a>

##### textAnchor()

###### Call Signature

> **textAnchor**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1477](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1477)

The text-anchor.

###### Returns

`AccessorFn`

###### Call Signature

> **textAnchor**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1478](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1478)

The text-anchor.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

<a id="texture-6"></a>

##### texture()

###### Call Signature

> **texture**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1488](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1488)

Defines the texture used inside of each shape. This uses the [textures.js](https://riccardoscalco.it/textures/) package, and expects either a simple string (`"lines"` or `"circles"`) or a more complex Object containing the various properties of the texture (ie. `{texture: "lines", orientation: "3/8", stroke: "darkorange"}`). If multiple textures are necessary, provide an accsesor Function that returns the correct String/Object for each given data point and index.

###### Returns

`AccessorFn`

###### Call Signature

> **texture**(`_`: `string` \| `Record`\<`string`, `unknown`\> \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1489](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1489)

Defines the texture used inside of each shape. This uses the [textures.js](https://riccardoscalco.it/textures/) package, and expects either a simple string (`"lines"` or `"circles"`) or a more complex Object containing the various properties of the texture (ie. `{texture: "lines", orientation: "3/8", stroke: "darkorange"}`). If multiple textures are necessary, provide an accsesor Function that returns the correct String/Object for each given data point and index.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `Record`\<`string`, `unknown`\> \| `AccessorFn` |

###### Returns

`this`

<a id="texturedefault-6"></a>

##### textureDefault()

###### Call Signature

> **textureDefault**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Shape.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1503)

A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **textureDefault**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Shape.ts:1504](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1504)

A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="translate-15"></a>

##### translate()

###### Call Signature

> **translate**(): (`d`: `string`, `locale?`: `string`) => `string`

Defined in: [utils/BaseClass.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L214)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Returns

(`d`: `string`, `locale?`: `string`) => `string`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`translate`](#translate-7)

###### Call Signature

> **translate**(`_`: (`d`: `string`, `locale?`: `string`) => `string`): `this`

Defined in: [utils/BaseClass.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L215)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `string`, `locale?`: `string`) => `string` |

###### Returns

`this`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`translate`](#translate-7)

<a id="vectoreffect-6"></a>

##### vectorEffect()

###### Call Signature

> **vectorEffect**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1514](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1514)

The vector-effect.

###### Returns

`AccessorFn`

###### Call Signature

> **vectorEffect**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1515](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1515)

The vector-effect.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

<a id="verticalalign-7"></a>

##### verticalAlign()

###### Call Signature

> **verticalAlign**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1525](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1525)

The vertical alignment.

###### Returns

`AccessorFn`

###### Call Signature

> **verticalAlign**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1526](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1526)

The vertical alignment.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

<a id="x-15"></a>

##### x()

###### Call Signature

> **x**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1542](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1542)

The x position accessor for each shape.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Call Signature

> **x**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1543)

The x position accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.x;
}
```

<a id="y-15"></a>

##### y()

###### Call Signature

> **y**(): `AccessorFn`

Defined in: [shapes/Shape.ts:1558](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1558)

The y position accessor for each shape.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.y;
}
```

###### Call Signature

> **y**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Shape.ts:1559](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L1559)

The y position accessor for each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.y;
}
```

#### Properties

| Property | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="property-_active-6"></a> `_active` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | - | [shapes/Shape.ts:116](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L116) |
| <a id="property-_activegroup-6"></a> `_activeGroup` | `Selection` | - | [shapes/Shape.ts:112](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L112) |
| <a id="property-_activeopacity-6"></a> `_activeOpacity` | `number` | - | [shapes/Shape.ts:57](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L57) |
| <a id="property-_activestyle-6"></a> `_activeStyle` | `Record`\<`string`, `unknown`\> | - | [shapes/Shape.ts:58](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L58) |
| <a id="property-_arialabel-6"></a> `_ariaLabel` | `AccessorFn` | - | [shapes/Shape.ts:59](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L59) |
| <a id="property-_backgroundimage-6"></a> `_backgroundImage` | `AccessorFn` | - | [shapes/Shape.ts:60](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L60) |
| <a id="property-_backgroundimageclass-6"></a> `_backgroundImageClass` | [`Image`](#image) | - | [shapes/Shape.ts:61](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L61) |
| <a id="property-_configdefault-15"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | [`BaseClass`](#baseclass).[`_configDefault`](#property-_configdefault-7) | [utils/BaseClass.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L69) |
| <a id="property-_curve-6"></a> `_curve` | `AccessorFn` | - | [shapes/Shape.ts:121](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L121) |
| <a id="property-_data-15"></a> `_data` | `DataPoint`[] | - | [shapes/Shape.ts:62](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L62) |
| <a id="property-_defined-6"></a> `_defined` | `AccessorFn` | - | [shapes/Shape.ts:120](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L120) |
| <a id="property-_discrete-6"></a> `_discrete` | `string` \| *required* | - | [shapes/Shape.ts:118](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L118) |
| <a id="property-_duration-15"></a> `_duration` | `number` | - | [shapes/Shape.ts:63](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L63) |
| <a id="property-_enter-6"></a> `_enter` | `Selection` | - | [shapes/Shape.ts:109](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L109) |
| <a id="property-_exit-6"></a> `_exit` | `Selection` | - | [shapes/Shape.ts:110](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L110) |
| <a id="property-_fill-6"></a> `_fill` | `AccessorFn` | - | [shapes/Shape.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L64) |
| <a id="property-_fillopacity-6"></a> `_fillOpacity` | `AccessorFn` | - | [shapes/Shape.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L65) |
| <a id="property-_group-13"></a> `_group` | `Selection` | - | [shapes/Shape.ts:107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L107) |
| <a id="property-_hitarea-6"></a> `_hitArea` | ((`d`: `DataPoint`, `i`: `number`, `aes`: `ShapeAes`) => `Record`\<`string`, `unknown`\>) \| `null` | - | [shapes/Shape.ts:113](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L113) |
| <a id="property-_hover-6"></a> `_hover` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | - | [shapes/Shape.ts:117](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L117) |
| <a id="property-_hovergroup-6"></a> `_hoverGroup` | `Selection` | - | [shapes/Shape.ts:111](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L111) |
| <a id="property-_hoveropacity-6"></a> `_hoverOpacity` | `number` | - | [shapes/Shape.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L66) |
| <a id="property-_hoverstyle-6"></a> `_hoverStyle` | `Record`\<`string`, `unknown`\> | - | [shapes/Shape.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L67) |
| <a id="property-_id-8"></a> `_id` | `AccessorFn` | - | [shapes/Shape.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L68) |
| <a id="property-_label-7"></a> `_label` | `AccessorFn` | - | [shapes/Shape.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L69) |
| <a id="property-_labelbounds-6"></a> `_labelBounds` | ((`d`: `DataPoint`, `i`: `number`, `aes`: `ShapeAes`) => `false` \| `Record`\<`string`, `unknown`\> \| `null`) \| `null` | - | [shapes/Shape.ts:72](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L72) |
| <a id="property-_labelclass-7"></a> `_labelClass` | [`TextBox`](#textbox) | - | [shapes/Shape.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L70) |
| <a id="property-_labelconfig-7"></a> `_labelConfig` | `Record`\<`string`, `unknown`\> | - | [shapes/Shape.ts:71](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L71) |
| <a id="property-_locale-15"></a> `_locale` | `string` | [`BaseClass`](#baseclass).[`_locale`](#property-_locale-7) | [utils/BaseClass.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L64) |
| <a id="property-_name-6"></a> `_name` | `string` | - | [shapes/Shape.ts:79](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L79) |
| <a id="property-_on-15"></a> `_on` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | [`BaseClass`](#baseclass).[`_on`](#property-_on-7) | [utils/BaseClass.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L65) |
| <a id="property-_opacity-7"></a> `_opacity` | `AccessorFn` | - | [shapes/Shape.ts:80](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L80) |
| <a id="property-_parent-15"></a> `_parent` | `Record`\<`string`, `unknown`\> | [`BaseClass`](#baseclass).[`_parent`](#property-_parent-7) | [utils/BaseClass.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L66) |
| <a id="property-_path-6"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [shapes/Shape.ts:119](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L119) |
| <a id="property-_pointerevents-7"></a> `_pointerEvents` | `AccessorFn` | - | [shapes/Shape.ts:81](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L81) |
| <a id="property-_role-6"></a> `_role` | `AccessorFn` | - | [shapes/Shape.ts:82](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L82) |
| <a id="property-_rotate-6"></a> `_rotate` | `AccessorFn` | - | [shapes/Shape.ts:83](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L83) |
| <a id="property-_rx-6"></a> `_rx` | `AccessorFn` | - | [shapes/Shape.ts:84](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L84) |
| <a id="property-_ry-6"></a> `_ry` | `AccessorFn` | - | [shapes/Shape.ts:85](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L85) |
| <a id="property-_scale-12"></a> `_scale` | `AccessorFn` | - | [shapes/Shape.ts:86](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L86) |
| <a id="property-_select-15"></a> `_select` | `Selection` | - | [shapes/Shape.ts:102](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L102) |
| <a id="property-_shapeconfig-15"></a> `_shapeConfig?` | [`D3plusConfig`](#d3plusconfig) | [`BaseClass`](#baseclass).[`_shapeConfig`](#property-_shapeconfig-7) | [utils/BaseClass.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L70) |
| <a id="property-_shaperendering-6"></a> `_shapeRendering` | `AccessorFn` | - | [shapes/Shape.ts:87](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L87) |
| <a id="property-_sort-6"></a> `_sort` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | - | [shapes/Shape.ts:106](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L106) |
| <a id="property-_stroke-6"></a> `_stroke` | `AccessorFn` | - | [shapes/Shape.ts:88](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L88) |
| <a id="property-_strokedasharray-6"></a> `_strokeDasharray` | `AccessorFn` | - | [shapes/Shape.ts:89](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L89) |
| <a id="property-_strokelinecap-6"></a> `_strokeLinecap` | `AccessorFn` | - | [shapes/Shape.ts:90](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L90) |
| <a id="property-_strokeopacity-6"></a> `_strokeOpacity` | `AccessorFn` | - | [shapes/Shape.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L91) |
| <a id="property-_strokewidth-6"></a> `_strokeWidth` | `AccessorFn` | - | [shapes/Shape.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L92) |
| <a id="property-_tagname-6"></a> `_tagName` | `string` | - | [shapes/Shape.ts:93](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L93) |
| <a id="property-_textanchor-6"></a> `_textAnchor` | `AccessorFn` | - | [shapes/Shape.ts:94](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L94) |
| <a id="property-_texture-6"></a> `_texture` | `AccessorFn` | - | [shapes/Shape.ts:95](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L95) |
| <a id="property-_texturedefault-6"></a> `_textureDefault` | `Record`\<`string`, `unknown`\> | - | [shapes/Shape.ts:96](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L96) |
| <a id="property-_texturedefs-6"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [shapes/Shape.ts:97](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L97) |
| <a id="property-_transition-11"></a> `_transition` | `Transition`\<`BaseType`\> | - | [shapes/Shape.ts:103](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L103) |
| <a id="property-_translate-15"></a> `_translate` | (`d`: `string`, `locale?`: `string`) => `string` | [`BaseClass`](#baseclass).[`_translate`](#property-_translate-7) | [utils/BaseClass.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L67) |
| <a id="property-_update-6"></a> `_update` | `Selection` | - | [shapes/Shape.ts:108](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L108) |
| <a id="property-_uuid-15"></a> `_uuid` | `string` | [`BaseClass`](#baseclass).[`_uuid`](#property-_uuid-7) | [utils/BaseClass.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L68) |
| <a id="property-_vectoreffect-6"></a> `_vectorEffect` | `AccessorFn` | - | [shapes/Shape.ts:98](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L98) |
| <a id="property-_verticalalign-7"></a> `_verticalAlign` | `AccessorFn` | - | [shapes/Shape.ts:99](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L99) |
| <a id="property-_x-8"></a> `_x` | `AccessorFn` | - | [shapes/Shape.ts:100](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L100) |
| <a id="property-_y-8"></a> `_y` | `AccessorFn` | - | [shapes/Shape.ts:101](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Shape.ts#L101) |

***

<a id="stackedarea"></a>

### StackedArea

Defined in: [charts/StackedArea.ts:9](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/StackedArea.ts#L9)

Creates a stacked area plot based on an array of data.

#### Example

```ts
new d3plus.AreaPlot()
.stacked(true)
```

#### Extends

- [`AreaPlot`](#areaplot)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-26"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`active`](#active-1)

<a id="aggs-17"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`aggs`](#aggs)

<a id="annotations-6"></a>

##### annotations()

> **annotations**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2004](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2004)

Allows drawing custom shapes to be used as annotations in the provided x/y plot. This method accepts custom config objects for the [Shape](http://d3plus.org/docs/#Shape) class, either a single config object or an array of config objects. Each config object requires an additional parameter, the "shape", which denotes which [Shape](http://d3plus.org/docs/#Shape) sub-class to use ([Rect](http://d3plus.org/docs/#Rect), [Line](http://d3plus.org/docs/#Line), etc).

Additionally, each config object can also contain an optional "layer" key, which defines whether the annotations will be displayed in "front" or in "back" of the primary visualization shapes. This value defaults to "back" if not present.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`annotations`](#annotations)

<a id="ariahidden-17"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`ariaHidden`](#ariahidden)

<a id="attribution-17"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`attribution`](#attribution)

<a id="attributionstyle-17"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`attributionStyle`](#attributionstyle)

<a id="axispersist-6"></a>

##### axisPersist()

> **axisPersist**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2013](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2013)

Determines whether the x and y axes should have their scales persist while users filter the data, the timeline being the prime example (set this to `true` to make the axes stay consistent when the timeline changes).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`axisPersist`](#axispersist)

<a id="backconfig-17"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`backConfig`](#backconfig)

<a id="backgroundconfig-6"></a>

##### backgroundConfig()

> **backgroundConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2022](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2022)

A d3plus-shape configuration Object used for styling the background rectangle of the inner x/y plot (behind all of the shapes and gridlines).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`backgroundConfig`](#backgroundconfig)

<a id="barpadding-6"></a>

##### barPadding()

> **barPadding**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2031](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2031)

The pixel space between each bar in a group of bars.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`barPadding`](#barpadding)

<a id="baseline-6"></a>

##### baseline()

> **baseline**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2038](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2038)

The baseline for the x/y plot.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`baseline`](#baseline)

<a id="buffer-6"></a>

##### buffer()

> **buffer**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2045](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2045)

Determines whether or not to add additional padding at the ends of x or y scales. The most commone use for this is in Scatter Plots, so that the shapes do not appear directly on the axis itself. The value provided can either be `true` or `false` to toggle the behavior for all shape types, or a keyed Object for each shape type (ie. `{Bar: false, Circle: true, Line: false}`).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`buffer`](#buffer)

<a id="cache-17"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`cache`](#cache)

<a id="color-18"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`color`](#color)

<a id="colorscale-18"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`colorScale`](#colorscale)

<a id="colorscaleconfig-18"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`colorScaleConfig`](#colorscaleconfig)

<a id="colorscalemaxsize-17"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`colorScaleMaxSize`](#colorscalemaxsize)

<a id="colorscalepadding-18"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`colorScalePadding`](#colorscalepadding)

<a id="colorscaleposition-17"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| (() => `string` \| `boolean`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| (() => `string` \| `boolean`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`colorScalePosition`](#colorscaleposition)

<a id="confidence-6"></a>

##### confidence()

> **confidence**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2073](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2073)

The confidence interval as an array of [lower, upper] bounds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Example

```ts
var data = {id: "alpha", value: 10, lci: 9, hci: 11};
...
// Accessor functions
.confidence([function(d) { return d.lci }, function(d) { return d.hci }])

// Or static keys
.confidence(["lci", "hci"])
```

###### Inherited from

[`AreaPlot`](#areaplot).[`confidence`](#confidence)

<a id="confidenceconfig-6"></a>

##### confidenceConfig()

> **confidenceConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2090](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2090)

Configuration object for shapes rendered as confidence intervals.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`confidenceConfig`](#confidenceconfig)

<a id="data-33"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): `DataPoint`[] \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

`DataPoint`[] \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`data`](#data-1)

<a id="datacutoff-17"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`dataCutoff`](#datacutoff)

<a id="depth-17"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`depth`](#depth)

<a id="destroy-17"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

###### Inherited from

[`AreaPlot`](#areaplot).[`destroy`](#destroy)

<a id="detectresize-17"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`detectResize`](#detectresize)

<a id="detectresizedelay-17"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`detectResizeDelay`](#detectresizedelay)

<a id="detectvisible-17"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`detectVisible`](#detectvisible)

<a id="detectvisibleinterval-17"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`detectVisibleInterval`](#detectvisibleinterval)

<a id="discrete-24"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`discrete`](#discrete-1)

<a id="discretecutoff-6"></a>

##### discreteCutoff()

> **discreteCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2099](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2099)

When the width or height of the chart is less than or equal to this pixel value, the discrete axis will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`discreteCutoff`](#discretecutoff)

<a id="downloadbutton-17"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`downloadButton`](#downloadbutton)

<a id="downloadconfig-17"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`downloadConfig`](#downloadconfig)

<a id="downloadposition-17"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`downloadPosition`](#downloadposition)

<a id="duration-32"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`duration`](#duration-1)

<a id="filter-17"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`filter`](#filter)

<a id="fontfamily-17"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| `string`[] \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| `string`[] \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`fontFamily`](#fontfamily)

<a id="groupby-17"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

(`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`groupBy`](#groupby)

<a id="grouppadding-6"></a>

##### groupPadding()

> **groupPadding**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2108](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2108)

The pixel space between groups of bars.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`groupPadding`](#grouppadding)

<a id="height-27"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`height`](#height)

<a id="hiddencolor-17"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`hiddenColor`](#hiddencolor)

<a id="hiddenopacity-17"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`hiddenOpacity`](#hiddenopacity)

<a id="hover-26"></a>

##### hover()

> **hover**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `this`

Defined in: [charts/Viz.ts:1350](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1350)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`this`

###### Inherited from

[`AreaPlot`](#areaplot).[`hover`](#hover-1)

<a id="label-25"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`label`](#label-1)

<a id="labelconnectorconfig-6"></a>

##### labelConnectorConfig()

> **labelConnectorConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2117](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2117)

The d3plus-shape config used on the Line shapes created to connect lineLabels to the end of their associated Line path.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`labelConnectorConfig`](#labelconnectorconfig)

<a id="labelposition-6"></a>

##### labelPosition()

> **labelPosition**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2127](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2127)

The behavior to be used when calculating the position and size of each shape's label(s). The value passed can either be the _String_ name of the behavior to be used for all shapes, or an accessor _Function_ that will be provided each data point and will be expected to return the behavior to be used for that data point. The availability and options for this method depend on the default logic for each Shape. As an example, the values "outside" or "inside" can be set for Bar shapes, whose "auto" default will calculate the best position dynamically based on the available space.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`labelPosition`](#labelposition)

<a id="legend-18"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`legend`](#legend)

<a id="legendconfig-19"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`legendConfig`](#legendconfig)

<a id="legendfilterinvert-17"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`legendFilterInvert`](#legendfilterinvert)

<a id="legendpadding-18"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`legendPadding`](#legendpadding)

<a id="legendposition-17"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| (() => `string`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| (() => `string`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`legendPosition`](#legendposition)

<a id="legendsort-17"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`legendSort`](#legendsort)

<a id="legendtooltip-17"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`legendTooltip`](#legendtooltip)

<a id="linelabels-6"></a>

##### lineLabels()

> **lineLabels**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2137](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2137)

Draws labels on the right side of any Line shapes that are drawn on the plot.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`lineLabels`](#linelabels)

<a id="linemarkerconfig-6"></a>

##### lineMarkerConfig()

> **lineMarkerConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2144](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2144)

Shape config for the Circle shapes drawn by the lineMarkers method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`lineMarkerConfig`](#linemarkerconfig)

<a id="linemarkers-6"></a>

##### lineMarkers()

> **lineMarkers**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2153](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2153)

Draws circle markers on each vertex of a Line.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`lineMarkers`](#linemarkers)

<a id="loadinghtml-17"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`loadingHTML`](#loadinghtml)

<a id="loadingmessage-17"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`loadingMessage`](#loadingmessage)

<a id="messagemask-17"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`messageMask`](#messagemask)

<a id="messagestyle-17"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`messageStyle`](#messagestyle)

<a id="nodatahtml-17"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`noDataHTML`](#nodatahtml)

<a id="nodatamessage-17"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`noDataMessage`](#nodatamessage)

<a id="render-33"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`AreaPlot`](#areaplot).[`render`](#render-1)

<a id="scrollcontainer-17"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| `HTMLElement` \| `Window` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| `HTMLElement` \| `Window` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`scrollContainer`](#scrollcontainer)

<a id="select-33"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

`Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`select`](#select-1)

<a id="shape-24"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`shape`](#shape)

<a id="shapeconfig-34"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`shapeConfig`](#shapeconfig-1)

<a id="shapesort-7"></a>

##### shapeSort()

> **shapeSort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2162](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2162)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) that receives each shape Class (ie. "Circle", "Line", etc) as it's comparator arguments. Shapes are drawn in groups based on their type, so you are defining the layering order for all shapes of said type.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`shapeSort`](#shapesort)

<a id="size-9"></a>

##### size()

> **size**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2169](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2169)

Sets the size of bubbles to the given Number, data key, or function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`size`](#size)

<a id="sizemax-8"></a>

##### sizeMax()

> **sizeMax**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2178)

Sets the size scale maximum to the specified number.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`sizeMax`](#sizemax)

<a id="sizemin-8"></a>

##### sizeMin()

> **sizeMin**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2185](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2185)

Sets the size scale minimum to the specified number.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`sizeMin`](#sizemin)

<a id="sizescale-8"></a>

##### sizeScale()

> **sizeScale**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2192](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2192)

Sets the size scale to the specified string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`sizeScale`](#sizescale)

<a id="stacked-6"></a>

##### stacked()

> **stacked**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2199](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2199)

If *value* is specified, toggles shape stacking. If *value* is not specified, returns the current stack value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`stacked`](#stacked)

<a id="stackoffset-6"></a>

##### stackOffset()

> **stackOffset**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2206](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2206)

Sets the stack offset. If *value* is not specified, returns the current stack offset function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`stackOffset`](#stackoffset)

<a id="stackorder-6"></a>

##### stackOrder()

> **stackOrder**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2219](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2219)

Sets the stack order. If *value* is not specified, returns the current stack order function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`stackOrder`](#stackorder)

<a id="subtitle-17"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`subtitle`](#subtitle)

<a id="subtitleconfig-17"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`subtitleConfig`](#subtitleconfig)

<a id="subtitlepadding-17"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`subtitlePadding`](#subtitlepadding)

<a id="svgdesc-17"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`svgDesc`](#svgdesc)

<a id="svgtitle-17"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`svgTitle`](#svgtitle)

<a id="threshold-17"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| ((`data`: `DataPoint`[]) => `number`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| ((`data`: `DataPoint`[]) => `number`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`threshold`](#threshold)

<a id="thresholdkey-17"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`thresholdKey`](#thresholdkey)

<a id="thresholdname-17"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`thresholdName`](#thresholdname)

<a id="time-17"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`time`](#time)

<a id="timefilter-17"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`timeFilter`](#timefilter)

<a id="timeline-17"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`timeline`](#timeline)

<a id="timelineconfig-17"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`timelineConfig`](#timelineconfig)

<a id="timelinedefault-17"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): `Date`[] \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

`Date`[] \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`timelineDefault`](#timelinedefault)

<a id="timelinepadding-17"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`timelinePadding`](#timelinepadding)

<a id="title-23"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`title`](#title)

<a id="titleconfig-23"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`titleConfig`](#titleconfig)

<a id="titlepadding-17"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`titlePadding`](#titlepadding)

<a id="tooltip-17"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`tooltip`](#tooltip)

<a id="tooltipconfig-17"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`tooltipConfig`](#tooltipconfig)

<a id="total-17"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`total`](#total)

<a id="totalconfig-17"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`totalConfig`](#totalconfig)

<a id="totalformat-17"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): ((`d`: `number`) => `string`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

((`d`: `number`) => `string`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`totalFormat`](#totalformat)

<a id="totalpadding-17"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`totalPadding`](#totalpadding)

<a id="width-27"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`width`](#width)

<a id="x-16"></a>

##### x()

> **x**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2236](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2236)

Accessor function or string key for the x-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`x`](#x-1)

<a id="x2-6"></a>

##### x2()

> **x2**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2250)

Accessor function or string key for the secondary x-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`x2`](#x2)

<a id="x2config-6"></a>

##### x2Config()

> **x2Config**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2280](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2280)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the secondary x-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`x2Config`](#x2config)

<a id="x2domain-6"></a>

##### x2Domain()

> **x2Domain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2296](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2296)

The x2 domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`x2Domain`](#x2domain)

<a id="x2sort-6"></a>

##### x2Sort()

> **x2Sort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2310](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2310)

Defines a custom sorting comparitor function to be used for discrete x2 axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`x2Sort`](#x2sort)

<a id="xconfig-6"></a>

##### xConfig()

> **xConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2264](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2264)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the x-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`xConfig`](#xconfig)

<a id="xcutoff-6"></a>

##### xCutoff()

> **xCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2273](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2273)

When the width of the chart is less than or equal to this pixel value, and the x-axis is not the discrete axis, it will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`xCutoff`](#xcutoff)

<a id="xdomain-6"></a>

##### xDomain()

> **xDomain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2289](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2289)

The x domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`xDomain`](#xdomain)

<a id="xsort-6"></a>

##### xSort()

> **xSort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2303](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2303)

Defines a custom sorting comparitor function to be used for discrete x axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`xSort`](#xsort)

<a id="y-16"></a>

##### y()

> **y**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2317](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2317)

Accessor function or string key for the y-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`y`](#y-1)

<a id="y2-6"></a>

##### y2()

> **y2**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2331](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2331)

Accessor function or string key for the secondary y-axis value of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`y2`](#y2)

<a id="y2config-6"></a>

##### y2Config()

> **y2Config**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2366](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2366)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the secondary y-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`y2Config`](#y2config)

<a id="y2domain-6"></a>

##### y2Domain()

> **y2Domain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2385](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2385)

The y2 domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`y2Domain`](#y2domain)

<a id="y2sort-6"></a>

##### y2Sort()

> **y2Sort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2399](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2399)

Defines a custom sorting comparitor function to be used for discrete y2 axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`y2Sort`](#y2sort)

<a id="yconfig-6"></a>

##### yConfig()

> **yConfig**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2347](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2347)

A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the y-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.

*Note:* If a "domain" array is passed to the y-axis config, it will be reversed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`yConfig`](#yconfig)

<a id="ycutoff-6"></a>

##### yCutoff()

> **yCutoff**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2359](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2359)

When the height of the chart is less than or equal to this pixel value, and the y-axis is not the discrete axis, it will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`yCutoff`](#ycutoff)

<a id="ydomain-6"></a>

##### yDomain()

> **yDomain**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2378](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2378)

The y domain as an array. If either value is undefined, it will be calculated from the data.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`yDomain`](#ydomain)

<a id="ysort-6"></a>

##### ySort()

> **ySort**(`_`: `any`): `any`

Defined in: [charts/Plot.ts:2392](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Plot.ts#L2392)

Defines a custom sorting comparitor function to be used for discrete y axes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Inherited from

[`AreaPlot`](#areaplot).[`ySort`](#ysort)

<a id="zoom-17"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`zoom`](#zoom)

<a id="zoombrushhandlesize-17"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`zoomBrushHandleSize`](#zoombrushhandlesize)

<a id="zoombrushhandlestyle-17"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`zoomBrushHandleStyle`](#zoombrushhandlestyle)

<a id="zoombrushselectionstyle-17"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`zoomBrushSelectionStyle`](#zoombrushselectionstyle)

<a id="zoomcontrolstyle-17"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`zoomControlStyle`](#zoomcontrolstyle)

<a id="zoomcontrolstyleactive-17"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`zoomControlStyleActive`](#zoomcontrolstyleactive)

<a id="zoomcontrolstylehover-17"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`zoomControlStyleHover`](#zoomcontrolstylehover)

<a id="zoomfactor-17"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`zoomFactor`](#zoomfactor)

<a id="zoommax-17"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`zoomMax`](#zoommax)

<a id="zoompadding-17"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`zoomPadding`](#zoompadding)

<a id="zoompan-17"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`zoomPan`](#zoompan)

<a id="zoomscroll-17"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`StackedArea`](#stackedarea)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`StackedArea`](#stackedarea)

###### Inherited from

[`AreaPlot`](#areaplot).[`zoomScroll`](#zoomscroll)

***

<a id="textbox"></a>

### TextBox

Defined in: [components/TextBox.ts:54](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L54)

Creates a wrapped text box for each point in an array of data. See [this example](https://d3plus.org/examples/d3plus-text/getting-started/) for help getting started using the TextBox class.

#### Extends

- [`BaseClass`](#baseclass)

#### Methods

<a id="ariahidden-18"></a>

##### ariaHidden()

###### Call Signature

> **ariaHidden**(): (`d`: `DataPoint`, `i?`: `number`) => `string`

Defined in: [components/TextBox.ts:525](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L525)

The aria-hidden attribute.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string`

###### Call Signature

> **ariaHidden**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string`)): `this`

Defined in: [components/TextBox.ts:526](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L526)

The aria-hidden attribute.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string`) |

###### Returns

`this`

<a id="config-16"></a>

##### config()

###### Call Signature

> **config**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L91)

Methods that correspond to the key/value pairs and returns this class.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`BaseClass`](#baseclass).[`config`](#config-7)

###### Call Signature

> **config**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L92)

Methods that correspond to the key/value pairs and returns this class.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`config`](#config-7)

<a id="data-34"></a>

##### data()

###### Call Signature

> **data**(): `DataPoint`[]

Defined in: [components/TextBox.ts:536](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L536)

The data array used to draw text boxes. A text box will be drawn for each object in the array.

###### Returns

`DataPoint`[]

###### Call Signature

> **data**(`_`: `DataPoint`[]): `this`

Defined in: [components/TextBox.ts:537](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L537)

The data array used to draw text boxes. A text box will be drawn for each object in the array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `DataPoint`[] |

###### Returns

`this`

<a id="delay"></a>

##### delay()

###### Call Signature

> **delay**(): `number`

Defined in: [components/TextBox.ts:545](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L545)

The animation delay in milliseconds.

###### Returns

`number`

###### Call Signature

> **delay**(`_`: `number`): `this`

Defined in: [components/TextBox.ts:546](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L546)

The animation delay in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="duration-33"></a>

##### duration()

###### Call Signature

> **duration**(): `number`

Defined in: [components/TextBox.ts:554](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L554)

The animation duration in milliseconds.

###### Returns

`number`

###### Call Signature

> **duration**(`_`: `number`): `this`

Defined in: [components/TextBox.ts:555](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L555)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="ellipsis"></a>

##### ellipsis()

###### Call Signature

> **ellipsis**(): (`text`: `string`, `line`: `number`) => `string`

Defined in: [components/TextBox.ts:568](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L568)

The function that handles truncated lines. It should return the new value for the line, and is passed 2 arguments: the String of text for the line in question, and the number of the line. By default, an ellipsis is added to the end of any line except if it is the first word that cannot fit (in that case, an empty string is returned).

###### Returns

(`text`: `string`, `line`: `number`) => `string`

###### Example

```ts
function(text, line) {
return line ? text.replace(/\.|,$/g, "") + "..." : "";
}
```

###### Call Signature

> **ellipsis**(`_`: `string` \| ((`text`: `string`, `line`: `number`) => `string`)): `this`

Defined in: [components/TextBox.ts:569](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L569)

The function that handles truncated lines. It should return the new value for the line, and is passed 2 arguments: the String of text for the line in question, and the number of the line. By default, an ellipsis is added to the end of any line except if it is the first word that cannot fit (in that case, an empty string is returned).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`text`: `string`, `line`: `number`) => `string`) |

###### Returns

`this`

###### Example

```ts
function(text, line) {
return line ? text.replace(/\.|,$/g, "") + "..." : "";
}
```

<a id="fontcolor"></a>

##### fontColor()

###### Call Signature

> **fontColor**(): (`d`: `DataPoint`, `i?`: `number`) => `string`

Defined in: [components/TextBox.ts:579](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L579)

The font color as an accessor function or static string. Inferred from the [DOM selection](#textBox.select) by default.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string`

###### Call Signature

> **fontColor**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string`)): `this`

Defined in: [components/TextBox.ts:580](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L580)

The font color as an accessor function or static string. Inferred from the [DOM selection](#textBox.select) by default.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string`) |

###### Returns

`this`

<a id="fontfamily-18"></a>

##### fontFamily()

###### Call Signature

> **fontFamily**(): (`d`: `DataPoint`, `i?`: `number`) => `string`

Defined in: [components/TextBox.ts:590](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L590)

Defines the font-family to be used. The value passed can be either a *String* name of a font, a comma-separated list of font-family fallbacks, an *Array* of fallbacks, or a *Function* that returns either a *String* or an *Array*. If supplying multiple fallback fonts, the [fontExists](#fontExists) function will be used to determine the first available font on the client's machine.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string`

###### Call Signature

> **fontFamily**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string`)): `this`

Defined in: [components/TextBox.ts:591](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L591)

Defines the font-family to be used. The value passed can be either a *String* name of a font, a comma-separated list of font-family fallbacks, an *Array* of fallbacks, or a *Function* that returns either a *String* or an *Array*. If supplying multiple fallback fonts, the [fontExists](#fontExists) function will be used to determine the first available font on the client's machine.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string`) |

###### Returns

`this`

<a id="fontmax"></a>

##### fontMax()

###### Call Signature

> **fontMax**(): (`d`: `DataPoint`, `i?`: `number`) => `number`

Defined in: [components/TextBox.ts:601](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L601)

The maximum font size in pixels, used when [dynamically resizing fonts](#textBox.fontResize).

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `number`

###### Call Signature

> **fontMax**(`_`: `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`)): `this`

Defined in: [components/TextBox.ts:602](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L602)

The maximum font size in pixels, used when [dynamically resizing fonts](#textBox.fontResize).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`) |

###### Returns

`this`

<a id="fontmin"></a>

##### fontMin()

###### Call Signature

> **fontMin**(): (`d`: `DataPoint`, `i?`: `number`) => `number`

Defined in: [components/TextBox.ts:612](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L612)

The minimum font size in pixels, used when [dynamically resizing fonts](#textBox.fontResize).

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `number`

###### Call Signature

> **fontMin**(`_`: `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`)): `this`

Defined in: [components/TextBox.ts:613](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L613)

The minimum font size in pixels, used when [dynamically resizing fonts](#textBox.fontResize).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`) |

###### Returns

`this`

<a id="fontopacity"></a>

##### fontOpacity()

###### Call Signature

> **fontOpacity**(): (`d`: `DataPoint`, `i?`: `number`) => `number`

Defined in: [components/TextBox.ts:623](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L623)

The font opacity as an accessor function or static number between 0 and 1.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `number`

###### Call Signature

> **fontOpacity**(`_`: `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`)): `this`

Defined in: [components/TextBox.ts:624](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L624)

The font opacity as an accessor function or static number between 0 and 1.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`) |

###### Returns

`this`

<a id="fontresize"></a>

##### fontResize()

###### Call Signature

> **fontResize**(): (`d`: `DataPoint`, `i?`: `number`) => `boolean`

Defined in: [components/TextBox.ts:634](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L634)

Toggles font resizing, which can either be defined as a static boolean for all data points, or an accessor function that returns a boolean. See [this example](http://d3plus.org/examples/d3plus-text/resizing-text/) for a side-by-side comparison.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `boolean`

###### Call Signature

> **fontResize**(`_`: `boolean` \| ((`d`: `DataPoint`, `i?`: `number`) => `boolean`)): `this`

Defined in: [components/TextBox.ts:635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L635)

Toggles font resizing, which can either be defined as a static boolean for all data points, or an accessor function that returns a boolean. See [this example](http://d3plus.org/examples/d3plus-text/resizing-text/) for a side-by-side comparison.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` \| ((`d`: `DataPoint`, `i?`: `number`) => `boolean`) |

###### Returns

`this`

<a id="fontsize"></a>

##### fontSize()

###### Call Signature

> **fontSize**(): (`d`: `DataPoint`, `i?`: `number`) => `number`

Defined in: [components/TextBox.ts:645](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L645)

The font size in pixels. Inferred from the [DOM selection](#textBox.select) by default.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `number`

###### Call Signature

> **fontSize**(`_`: `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`)): `this`

Defined in: [components/TextBox.ts:646](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L646)

The font size in pixels. Inferred from the [DOM selection](#textBox.select) by default.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`) |

###### Returns

`this`

<a id="fontstroke"></a>

##### fontStroke()

###### Call Signature

> **fontStroke**(): (`d`: `DataPoint`, `i?`: `number`) => `string`

Defined in: [components/TextBox.ts:656](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L656)

The font stroke color for the rendered text.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string`

###### Call Signature

> **fontStroke**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string`)): `this`

Defined in: [components/TextBox.ts:657](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L657)

The font stroke color for the rendered text.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string`) |

###### Returns

`this`

<a id="fontstrokewidth"></a>

##### fontStrokeWidth()

###### Call Signature

> **fontStrokeWidth**(): (`d`: `DataPoint`, `i?`: `number`) => `number`

Defined in: [components/TextBox.ts:667](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L667)

The font stroke width for the rendered text.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `number`

###### Call Signature

> **fontStrokeWidth**(`_`: `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`)): `this`

Defined in: [components/TextBox.ts:668](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L668)

The font stroke width for the rendered text.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`) |

###### Returns

`this`

<a id="fontweight"></a>

##### fontWeight()

###### Call Signature

> **fontWeight**(): (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number`

Defined in: [components/TextBox.ts:679](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L679)

The font weight. Inferred from the [DOM selection](#textBox.select) by default.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string` \| `number`

###### Call Signature

> **fontWeight**(`_`: `string` \| `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number`)): `this`

Defined in: [components/TextBox.ts:680](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L680)

The font weight. Inferred from the [DOM selection](#textBox.select) by default.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number`) |

###### Returns

`this`

<a id="height-28"></a>

##### height()

###### Call Signature

> **height**(): (`d`: `DataPoint`, `i?`: `number`) => `number`

Defined in: [components/TextBox.ts:695](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L695)

The height for each text box.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `number`

###### Example

```ts
function(d) {
return d.height || 200;
}
```

###### Call Signature

> **height**(`_`: `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`)): `this`

Defined in: [components/TextBox.ts:696](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L696)

The height for each text box.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`) |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.height || 200;
}
```

<a id="html"></a>

##### html()

###### Call Signature

> **html**(): `false` \| `Record`\<`string`, `string`\>

Defined in: [components/TextBox.ts:706](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L706)

Configures the ability to render simple HTML tags. Defaults to supporting `<b>`, `<strong>`, `<i>`, and `<em>`, set to false to disable or provide a mapping of tags to svg styles

###### Returns

`false` \| `Record`\<`string`, `string`\>

###### Call Signature

> **html**(`_`: `boolean` \| `Record`\<`string`, `string`\>): `this`

Defined in: [components/TextBox.ts:707](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L707)

Configures the ability to render simple HTML tags. Defaults to supporting `<b>`, `<strong>`, `<i>`, and `<em>`, set to false to disable or provide a mapping of tags to svg styles

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` \| `Record`\<`string`, `string`\> |

###### Returns

`this`

<a id="id-9"></a>

##### id()

###### Call Signature

> **id**(): (`d`: `DataPoint`, `i`: `number`) => `string`

Defined in: [components/TextBox.ts:724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L724)

The unique id for each text box.

###### Returns

(`d`: `DataPoint`, `i`: `number`) => `string`

###### Example

```ts
function(d, i) {
return d.id || i + "";
}
```

###### Call Signature

> **id**(`_`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `this`

Defined in: [components/TextBox.ts:725](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L725)

The unique id for each text box.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`this`

###### Example

```ts
function(d, i) {
return d.id || i + "";
}
```

<a id="lineheight"></a>

##### lineHeight()

###### Call Signature

> **lineHeight**(): (`d`: `DataPoint`, `i?`: `number`) => `number`

Defined in: [components/TextBox.ts:735](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L735)

The line height, which is 1.2 times the [font size](#textBox.fontSize) by default.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `number`

###### Call Signature

> **lineHeight**(`_`: `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`)): `this`

Defined in: [components/TextBox.ts:736](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L736)

The line height, which is 1.2 times the [font size](#textBox.fontSize) by default.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`) |

###### Returns

`this`

<a id="locale-16"></a>

##### locale()

###### Call Signature

> **locale**(): `string`

Defined in: [utils/BaseClass.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L156)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Returns

`string`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`BaseClass`](#baseclass).[`locale`](#locale-7)

###### Call Signature

> **locale**(`_`: `string` \| `object`): `this`

Defined in: [utils/BaseClass.ts:157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L157)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `object` |

###### Returns

`this`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`BaseClass`](#baseclass).[`locale`](#locale-7)

<a id="maxlines"></a>

##### maxLines()

###### Call Signature

> **maxLines**(): (`d`: `DataPoint`, `i?`: `number`) => `number` \| `null`

Defined in: [components/TextBox.ts:746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L746)

Restricts the maximum number of lines to wrap onto, which is null (unlimited) by default.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `number` \| `null`

###### Call Signature

> **maxLines**(`_`: `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number` \| `null`) \| `null`): `this`

Defined in: [components/TextBox.ts:747](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L747)

Restricts the maximum number of lines to wrap onto, which is null (unlimited) by default.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number` \| `null`) \| `null` |

###### Returns

`this`

<a id="on-16"></a>

##### on()

###### Call Signature

> **on**(): `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

Defined in: [utils/BaseClass.ts:176](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L176)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Returns

`Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `string`): ((...`args`: `unknown`[]) => `unknown`) \| `undefined`

Defined in: [utils/BaseClass.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L177)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

((...`args`: `unknown`[]) => `unknown`) \| `undefined`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `string`, `f`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [utils/BaseClass.ts:178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L178)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |
| `f` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:179](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L179)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

<a id="overflow"></a>

##### overflow()

###### Call Signature

> **overflow**(): (`d`: `DataPoint`, `i?`: `number`) => `boolean`

Defined in: [components/TextBox.ts:757](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L757)

Whether text is allowed to overflow its bounding box.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `boolean`

###### Call Signature

> **overflow**(`_`: `boolean` \| ((`d`: `DataPoint`, `i?`: `number`) => `boolean`)): `this`

Defined in: [components/TextBox.ts:758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L758)

Whether text is allowed to overflow its bounding box.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` \| ((`d`: `DataPoint`, `i?`: `number`) => `boolean`) |

###### Returns

`this`

<a id="padding-7"></a>

##### padding()

###### Call Signature

> **padding**(): (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number`

Defined in: [components/TextBox.ts:768](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L768)

The padding as a CSS shorthand string or number. Defaults to 0.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string` \| `number`

###### Call Signature

> **padding**(`_`: `string` \| `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number`)): `this`

Defined in: [components/TextBox.ts:769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L769)

The padding as a CSS shorthand string or number. Defaults to 0.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number`) |

###### Returns

`this`

<a id="parent-16"></a>

##### parent()

###### Call Signature

> **parent**(): `Record`\<`string`, `unknown`\>

Defined in: [utils/BaseClass.ts:200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L200)

Parent config used by the wrapper.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`BaseClass`](#baseclass).[`parent`](#parent-7)

###### Call Signature

> **parent**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L201)

Parent config used by the wrapper.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`parent`](#parent-7)

<a id="pointerevents-8"></a>

##### pointerEvents()

###### Call Signature

> **pointerEvents**(): (`d`: `DataPoint`, `i?`: `number`) => `string`

Defined in: [components/TextBox.ts:779](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L779)

The pointer-events CSS property for each text box.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string`

###### Call Signature

> **pointerEvents**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string`)): `this`

Defined in: [components/TextBox.ts:780](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L780)

The pointer-events CSS property for each text box.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string`) |

###### Returns

`this`

<a id="render-34"></a>

##### render()

> **render**(`callback?`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [components/TextBox.ts:182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L182)

Renders the text boxes. If a *callback* is specified, it will be called once the shapes are done drawing.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | (...`args`: `unknown`[]) => `unknown` | Optional callback invoked after rendering completes. |

###### Returns

`this`

<a id="rotate-7"></a>

##### rotate()

###### Call Signature

> **rotate**(): (`d`: `DataPoint`, `i?`: `number`) => `number`

Defined in: [components/TextBox.ts:791](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L791)

The rotation angle in degrees for each text box.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `number`

###### Call Signature

> **rotate**(`_`: `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`)): `this`

Defined in: [components/TextBox.ts:792](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L792)

The rotation angle in degrees for each text box.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`) |

###### Returns

`this`

<a id="rotateanchor"></a>

##### rotateAnchor()

###### Call Signature

> **rotateAnchor**(): (`d`: `DataPoint`, `i?`: `number`) => \[`number`, `number`\]

Defined in: [components/TextBox.ts:802](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L802)

The anchor point around which to rotate the text box.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => \[`number`, `number`\]

###### Call Signature

> **rotateAnchor**(`_`: \[`number`, `number`\] \| ((`d`: `DataPoint`, `i?`: `number`) => \[`number`, `number`\])): `this`

Defined in: [components/TextBox.ts:803](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L803)

The anchor point around which to rotate the text box.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | \[`number`, `number`\] \| ((`d`: `DataPoint`, `i?`: `number`) => \[`number`, `number`\]) |

###### Returns

`this`

<a id="select-34"></a>

##### select()

###### Call Signature

> **select**(): `Selection`

Defined in: [components/TextBox.ts:818](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L818)

The SVG container element as a d3 selector or DOM element. If not specified, an SVG element will be added to the page.

###### Returns

`Selection`

###### Call Signature

> **select**(`_`: `string` \| `HTMLElement`): `this`

Defined in: [components/TextBox.ts:819](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L819)

The SVG container element as a d3 selector or DOM element. If not specified, an SVG element will be added to the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `HTMLElement` |

###### Returns

`this`

<a id="shapeconfig-35"></a>

##### shapeConfig()

###### Call Signature

> **shapeConfig**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L225)

Configuration object with key/value pairs applied as method calls on each shape.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`BaseClass`](#baseclass).[`shapeConfig`](#shapeconfig-9)

###### Call Signature

> **shapeConfig**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:226](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L226)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`shapeConfig`](#shapeconfig-9)

<a id="split"></a>

##### split()

###### Call Signature

> **split**(): (`text`: `string`, `i?`: `number`) => `string`[]

Defined in: [components/TextBox.ts:829](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L829)

The word split function, which when passed a string is expected to return that string split into an array of words.

###### Returns

(`text`: `string`, `i?`: `number`) => `string`[]

###### Call Signature

> **split**(`_`: (`text`: `string`, `i?`: `number`) => `string`[]): `this`

Defined in: [components/TextBox.ts:830](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L830)

The word split function, which when passed a string is expected to return that string split into an array of words.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`text`: `string`, `i?`: `number`) => `string`[] |

###### Returns

`this`

<a id="text"></a>

##### text()

###### Call Signature

> **text**(): (`d`: `DataPoint`, `i?`: `number`) => `string` \| `undefined`

Defined in: [components/TextBox.ts:843](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L843)

The text content for each box.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string` \| `undefined`

###### Example

```ts
function(d) {
return d.text;
}
```

###### Call Signature

> **text**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `undefined`)): `this`

Defined in: [components/TextBox.ts:844](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L844)

The text content for each box.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `undefined`) |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.text;
}
```

<a id="textanchor-7"></a>

##### textAnchor()

###### Call Signature

> **textAnchor**(): (`d`: `DataPoint`, `i?`: `number`) => `string`

Defined in: [components/TextBox.ts:854](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L854)

The horizontal text anchor, analagous to the SVG [text-anchor](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/text-anchor) property.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string`

###### Call Signature

> **textAnchor**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string`)): `this`

Defined in: [components/TextBox.ts:855](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L855)

The horizontal text anchor, analagous to the SVG [text-anchor](https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/text-anchor) property.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string`) |

###### Returns

`this`

<a id="translate-16"></a>

##### translate()

###### Call Signature

> **translate**(): (`d`: `string`, `locale?`: `string`) => `string`

Defined in: [utils/BaseClass.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L214)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Returns

(`d`: `string`, `locale?`: `string`) => `string`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`translate`](#translate-7)

###### Call Signature

> **translate**(`_`: (`d`: `string`, `locale?`: `string`) => `string`): `this`

Defined in: [utils/BaseClass.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L215)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `string`, `locale?`: `string`) => `string` |

###### Returns

`this`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`translate`](#translate-7)

<a id="verticalalign-8"></a>

##### verticalAlign()

###### Call Signature

> **verticalAlign**(): (`d`: `DataPoint`, `i?`: `number`) => `string`

Defined in: [components/TextBox.ts:865](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L865)

The vertical alignment. Accepts `"top"`, `"middle"`, and `"bottom"`.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string`

###### Call Signature

> **verticalAlign**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string`)): `this`

Defined in: [components/TextBox.ts:866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L866)

The vertical alignment. Accepts `"top"`, `"middle"`, and `"bottom"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string`) |

###### Returns

`this`

<a id="width-28"></a>

##### width()

###### Call Signature

> **width**(): (`d`: `DataPoint`, `i?`: `number`) => `number`

Defined in: [components/TextBox.ts:882](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L882)

The width for each text box.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `number`

###### Example

```ts
function(d) {
return d.width || 200;
}
```

###### Call Signature

> **width**(`_`: `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`)): `this`

Defined in: [components/TextBox.ts:883](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L883)

The width for each text box.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`) |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.width || 200;
}
```

<a id="x-17"></a>

##### x()

###### Call Signature

> **x**(): (`d`: `DataPoint`, `i?`: `number`) => `number`

Defined in: [components/TextBox.ts:898](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L898)

The x position for each text box. The number given should correspond to the left side of the textBox.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `number`

###### Example

```ts
function(d) {
return d.x || 0;
}
```

###### Call Signature

> **x**(`_`: `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`)): `this`

Defined in: [components/TextBox.ts:899](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L899)

The x position for each text box. The number given should correspond to the left side of the textBox.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`) |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.x || 0;
}
```

<a id="y-17"></a>

##### y()

###### Call Signature

> **y**(): (`d`: `DataPoint`, `i?`: `number`) => `number`

Defined in: [components/TextBox.ts:914](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L914)

The y position for each text box. The number given should correspond to the top side of the textBox.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `number`

###### Example

```ts
function(d) {
return d.y || 0;
}
```

###### Call Signature

> **y**(`_`: `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`)): `this`

Defined in: [components/TextBox.ts:915](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L915)

The y position for each text box. The number given should correspond to the top side of the textBox.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `number`) |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.y || 0;
}
```

#### Properties

| Property | Type | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="property-_ariahidden"></a> `_ariaHidden` | (`d`: `DataPoint`, `i?`: `number`) => `string` | - | - | [components/TextBox.ts:59](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L59) |
| <a id="property-_configdefault-16"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | - | [`BaseClass`](#baseclass).[`_configDefault`](#property-_configdefault-7) | [utils/BaseClass.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L69) |
| <a id="property-_data-16"></a> `_data` | `DataPoint`[] | - | - | [components/TextBox.ts:57](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L57) |
| <a id="property-_delay"></a> `_delay` | `number` | - | - | [components/TextBox.ts:60](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L60) |
| <a id="property-_duration-16"></a> `_duration` | `number` | - | - | [components/TextBox.ts:61](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L61) |
| <a id="property-_ellipsis"></a> `_ellipsis` | (`text`: `string`, `line`: `number`) => `string` | - | - | [components/TextBox.ts:62](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L62) |
| <a id="property-_fontcolor"></a> `_fontColor` | (`d`: `DataPoint`, `i?`: `number`) => `string` | - | - | [components/TextBox.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L64) |
| <a id="property-_fontfamily"></a> `_fontFamily` | (`d`: `DataPoint`, `i?`: `number`) => `string` | - | - | [components/TextBox.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L66) |
| <a id="property-_fontmax"></a> `_fontMax` | (`d`: `DataPoint`, `i?`: `number`) => `number` | - | - | [components/TextBox.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L68) |
| <a id="property-_fontmin"></a> `_fontMin` | (`d`: `DataPoint`, `i?`: `number`) => `number` | - | - | [components/TextBox.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L70) |
| <a id="property-_fontopacity"></a> `_fontOpacity` | (`d`: `DataPoint`, `i?`: `number`) => `number` | - | - | [components/TextBox.ts:72](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L72) |
| <a id="property-_fontresize"></a> `_fontResize` | (`d`: `DataPoint`, `i?`: `number`) => `boolean` | - | - | [components/TextBox.ts:74](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L74) |
| <a id="property-_fontsize"></a> `_fontSize` | (`d`: `DataPoint`, `i?`: `number`) => `number` | - | - | [components/TextBox.ts:76](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L76) |
| <a id="property-_fontstroke"></a> `_fontStroke` | (`d`: `DataPoint`, `i?`: `number`) => `string` | - | - | [components/TextBox.ts:78](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L78) |
| <a id="property-_fontstrokewidth"></a> `_fontStrokeWidth` | (`d`: `DataPoint`, `i?`: `number`) => `number` | - | - | [components/TextBox.ts:80](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L80) |
| <a id="property-_fontweight"></a> `_fontWeight` | (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` | - | - | [components/TextBox.ts:82](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L82) |
| <a id="property-_height-10"></a> `_height` | (`d`: `DataPoint`, `i?`: `number`) => `number` | - | - | [components/TextBox.ts:84](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L84) |
| <a id="property-_html"></a> `_html` | `false` \| `Record`\<`string`, `string`\> | - | - | [components/TextBox.ts:86](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L86) |
| <a id="property-_id-9"></a> `_id` | (`d`: `DataPoint`, `i`: `number`) => `string` | - | - | [components/TextBox.ts:87](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L87) |
| <a id="property-_lineheight"></a> `_lineHeight` | (`d`: `DataPoint`, `i?`: `number`) => `number` | - | - | [components/TextBox.ts:88](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L88) |
| <a id="property-_locale-16"></a> `_locale` | `string` | - | [`BaseClass`](#baseclass).[`_locale`](#property-_locale-7) | [utils/BaseClass.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L64) |
| <a id="property-_maxlines"></a> `_maxLines` | (`d`: `DataPoint`, `i?`: `number`) => `number` \| `null` | - | - | [components/TextBox.ts:90](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L90) |
| <a id="property-_on-16"></a> `_on` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | [`BaseClass`](#baseclass).[`_on`](#property-_on-7) | - | [components/TextBox.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L92) |
| <a id="property-_overflow"></a> `_overflow` | (`d`: `DataPoint`, `i?`: `number`) => `boolean` | - | - | [components/TextBox.ts:94](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L94) |
| <a id="property-_padding-7"></a> `_padding` | (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` | - | - | [components/TextBox.ts:96](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L96) |
| <a id="property-_parent-16"></a> `_parent` | `Record`\<`string`, `unknown`\> | - | [`BaseClass`](#baseclass).[`_parent`](#property-_parent-7) | [utils/BaseClass.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L66) |
| <a id="property-_pointerevents-8"></a> `_pointerEvents` | (`d`: `DataPoint`, `i?`: `number`) => `string` | - | - | [components/TextBox.ts:98](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L98) |
| <a id="property-_rotate-7"></a> `_rotate` | (`d`: `DataPoint`, `i?`: `number`) => `number` | - | - | [components/TextBox.ts:100](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L100) |
| <a id="property-_rotateanchor"></a> `_rotateAnchor` | (`d`: `TextBoxDatum`, `i?`: `number`) => \[`number`, `number`\] | - | - | [components/TextBox.ts:101](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L101) |
| <a id="property-_select-16"></a> `_select` | `Selection` | - | - | [components/TextBox.ts:55](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L55) |
| <a id="property-_shapeconfig-16"></a> `_shapeConfig?` | [`D3plusConfig`](#d3plusconfig) | - | [`BaseClass`](#baseclass).[`_shapeConfig`](#property-_shapeconfig-7) | [utils/BaseClass.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L70) |
| <a id="property-_split"></a> `_split` | (`text`: `string`, `i?`: `number`) => `string`[] | - | - | [components/TextBox.ts:103](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L103) |
| <a id="property-_text"></a> `_text` | (`d`: `DataPoint`, `i?`: `number`) => `string` \| *required* | - | - | [components/TextBox.ts:105](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L105) |
| <a id="property-_textanchor-7"></a> `_textAnchor` | (`d`: `DataPoint`, `i?`: `number`) => `string` | - | - | [components/TextBox.ts:107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L107) |
| <a id="property-_translate-16"></a> `_translate` | (`d`: `string`, `locale?`: `string`) => `string` | - | [`BaseClass`](#baseclass).[`_translate`](#property-_translate-7) | [utils/BaseClass.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L67) |
| <a id="property-_uuid-16"></a> `_uuid` | `string` | - | [`BaseClass`](#baseclass).[`_uuid`](#property-_uuid-7) | [utils/BaseClass.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L68) |
| <a id="property-_verticalalign-8"></a> `_verticalAlign` | (`d`: `DataPoint`, `i?`: `number`) => `string` | - | - | [components/TextBox.ts:109](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L109) |
| <a id="property-_width-10"></a> `_width` | (`d`: `DataPoint`, `i?`: `number`) => `number` | - | - | [components/TextBox.ts:111](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L111) |
| <a id="property-_x-9"></a> `_x` | (`d`: `DataPoint`, `i?`: `number`) => `number` | - | - | [components/TextBox.ts:113](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L113) |
| <a id="property-_y-9"></a> `_y` | (`d`: `DataPoint`, `i?`: `number`) => `number` | - | - | [components/TextBox.ts:115](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/TextBox.ts#L115) |

***

<a id="timeline-18"></a>

### Timeline

Defined in: [components/Timeline.ts:21](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L21)

Creates an interactive timeline brush component for selecting time periods within a visualization.

#### Extends

- [`Axis`](#axis)

#### Methods

<a id="align-7"></a>

##### align()

###### Call Signature

> **align**(): `string`

Defined in: [components/Axis.ts:1520](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1520)

The horizontal alignment.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`align`](#align)

###### Call Signature

> **align**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1521](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1521)

The horizontal alignment.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`align`](#align)

<a id="barconfig-6"></a>

##### barConfig()

###### Call Signature

> **barConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Axis.ts:1529](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1529)

Axis line style.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Axis`](#axis).[`barConfig`](#barconfig)

###### Call Signature

> **barConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1530](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1530)

Axis line style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`barConfig`](#barconfig)

<a id="brushfilter"></a>

##### brushFilter()

###### Call Signature

> **brushFilter**(): (`event`: `unknown`) => `boolean`

Defined in: [components/Timeline.ts:756](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L756)

Brush event filter.

###### Returns

(`event`: `unknown`) => `boolean`

###### Example

```ts
function() {
return !event.button && event.detail < 2;
}
```

###### Call Signature

> **brushFilter**(`_`: (`event`: `unknown`) => `boolean`): `this`

Defined in: [components/Timeline.ts:758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L758)

Brush event filter.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`event`: `unknown`) => `boolean` |

###### Returns

`this`

###### Example

```ts
function() {
return !event.button && event.detail < 2;
}
```

<a id="brushing"></a>

##### brushing()

###### Call Signature

> **brushing**(): `boolean`

Defined in: [components/Timeline.ts:741](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L741)

Toggles the brushing value.

###### Returns

`boolean`

###### Call Signature

> **brushing**(`_`: `boolean`): `this`

Defined in: [components/Timeline.ts:742](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L742)

Toggles the brushing value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

<a id="brushmin"></a>

##### brushMin()

###### Call Signature

> **brushMin**(): () => `number`

Defined in: [components/Timeline.ts:769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L769)

The minimum number of ticks that can be highlighted when using "ticks" buttonBehavior. Helpful when using x/y plots where you don't want the user to select less than 2 time periods.

###### Returns

() => `number`

###### Call Signature

> **brushMin**(`_`: `number` \| (() => `number`)): `this`

Defined in: [components/Timeline.ts:770](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L770)

The minimum number of ticks that can be highlighted when using "ticks" buttonBehavior. Helpful when using x/y plots where you don't want the user to select less than 2 time periods.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| (() => `number`) |

###### Returns

`this`

<a id="buttonalign"></a>

##### buttonAlign()

###### Call Signature

> **buttonAlign**(): `string`

Defined in: [components/Timeline.ts:780](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L780)

Toggles the horizontal alignment of the button timeline. Accepted values are `"start"`, `"middle"` and `"end"`.

###### Returns

`string`

###### Call Signature

> **buttonAlign**(`_`: `string`): `this`

Defined in: [components/Timeline.ts:781](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L781)

Toggles the horizontal alignment of the button timeline. Accepted values are `"start"`, `"middle"` and `"end"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="buttonbehavior"></a>

##### buttonBehavior()

###### Call Signature

> **buttonBehavior**(): `string`

Defined in: [components/Timeline.ts:791](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L791)

Toggles the style of the timeline. Accepted values are `"auto"`, `"buttons"` and `"ticks"`.

###### Returns

`string`

###### Call Signature

> **buttonBehavior**(`_`: `string`): `this`

Defined in: [components/Timeline.ts:792](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L792)

Toggles the style of the timeline. Accepted values are `"auto"`, `"buttons"` and `"ticks"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="buttonheight"></a>

##### buttonHeight()

###### Call Signature

> **buttonHeight**(): `number`

Defined in: [components/Timeline.ts:802](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L802)

Button height.

###### Returns

`number`

###### Call Signature

> **buttonHeight**(`_`: `number`): `this`

Defined in: [components/Timeline.ts:803](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L803)

Button height.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="buttonpadding"></a>

##### buttonPadding()

###### Call Signature

> **buttonPadding**(): `number`

Defined in: [components/Timeline.ts:730](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L730)

Button padding.

###### Returns

`number`

###### Call Signature

> **buttonPadding**(`_`: `number`): `this`

Defined in: [components/Timeline.ts:731](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L731)

Button padding.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="config-17"></a>

##### config()

###### Call Signature

> **config**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L91)

Methods that correspond to the key/value pairs and returns this class.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`Axis`](#axis).[`config`](#config-1)

###### Call Signature

> **config**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L92)

Methods that correspond to the key/value pairs and returns this class.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`config`](#config-1)

<a id="data-35"></a>

##### data()

###### Call Signature

> **data**(): `any`[]

Defined in: [components/Axis.ts:1541](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1541)

An array of data points, which helps determine which ticks should be shown and which time resolution should be displayed.

###### Returns

`any`[]

###### Inherited from

[`Axis`](#axis).[`data`](#data-2)

###### Call Signature

> **data**(`_`: `any`[]): `this`

Defined in: [components/Axis.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1543)

An array of data points, which helps determine which ticks should be shown and which time resolution should be displayed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`data`](#data-2)

<a id="domain-6"></a>

##### domain()

###### Call Signature

> **domain**(): `any`[]

Defined in: [components/Axis.ts:1553](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1553)

Scale domain of the axis.

###### Returns

`any`[]

###### Inherited from

[`Axis`](#axis).[`domain`](#domain)

###### Call Signature

> **domain**(`_`: `any`[]): `this`

Defined in: [components/Axis.ts:1555](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1555)

Scale domain of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`domain`](#domain)

<a id="duration-34"></a>

##### duration()

###### Call Signature

> **duration**(): `number`

Defined in: [components/Axis.ts:1564](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1564)

Transition duration of the axis.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`duration`](#duration-2)

###### Call Signature

> **duration**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1565](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1565)

Transition duration of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`duration`](#duration-2)

<a id="grid-5"></a>

##### grid()

###### Call Signature

> **grid**(): `unknown`[] \| `undefined`

Defined in: [components/Axis.ts:1573](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1573)

Grid values of the axis.

###### Returns

`unknown`[] \| `undefined`

###### Inherited from

[`Axis`](#axis).[`grid`](#grid)

###### Call Signature

> **grid**(`_`: `unknown`[]): `this`

Defined in: [components/Axis.ts:1574](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1574)

Grid values of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`grid`](#grid)

<a id="gridconfig-5"></a>

##### gridConfig()

###### Call Signature

> **gridConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Axis.ts:1582](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1582)

Grid config of the axis.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Axis`](#axis).[`gridConfig`](#gridconfig)

###### Call Signature

> **gridConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1583)

Grid config of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`gridConfig`](#gridconfig)

<a id="gridlog-5"></a>

##### gridLog()

###### Call Signature

> **gridLog**(): `boolean`

Defined in: [components/Axis.ts:1593](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1593)

Grid behavior of the axis when scale is logarithmic.

###### Returns

`boolean`

###### Inherited from

[`Axis`](#axis).[`gridLog`](#gridlog)

###### Call Signature

> **gridLog**(`_`: `boolean`): `this`

Defined in: [components/Axis.ts:1594](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1594)

Grid behavior of the axis when scale is logarithmic.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`gridLog`](#gridlog)

<a id="gridsize-5"></a>

##### gridSize()

###### Call Signature

> **gridSize**(): `number` \| `undefined`

Defined in: [components/Axis.ts:1602](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1602)

Grid size of the axis.

###### Returns

`number` \| `undefined`

###### Inherited from

[`Axis`](#axis).[`gridSize`](#gridsize)

###### Call Signature

> **gridSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1603](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1603)

Grid size of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`gridSize`](#gridsize)

<a id="handleconfig"></a>

##### handleConfig()

###### Call Signature

> **handleConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Timeline.ts:813](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L813)

Handle style.

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **handleConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Timeline.ts:814](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L814)

Handle style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="handlesize"></a>

##### handleSize()

###### Call Signature

> **handleSize**(): `number`

Defined in: [components/Timeline.ts:824](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L824)

Handle size.

###### Returns

`number`

###### Call Signature

> **handleSize**(`_`: `number`): `this`

Defined in: [components/Timeline.ts:825](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L825)

Handle size.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="height-29"></a>

##### height()

###### Call Signature

> **height**(): `number`

Defined in: [components/Axis.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1611)

Overall height of the axis.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`height`](#height-1)

###### Call Signature

> **height**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1612](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1612)

Overall height of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`height`](#height-1)

<a id="labeloffset-5"></a>

##### labelOffset()

###### Call Signature

> **labelOffset**(): `boolean`

Defined in: [components/Axis.ts:1629](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1629)

Whether to offset overlapping labels further from the axis to prevent collisions.

###### Returns

`boolean`

###### Inherited from

[`Axis`](#axis).[`labelOffset`](#labeloffset)

###### Call Signature

> **labelOffset**(`_`: `boolean`): `this`

Defined in: [components/Axis.ts:1630](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1630)

Whether to offset overlapping labels further from the axis to prevent collisions.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`labelOffset`](#labeloffset)

<a id="labelrotation-5"></a>

##### labelRotation()

###### Call Signature

> **labelRotation**(): `boolean` \| `undefined`

Defined in: [components/Axis.ts:1640](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1640)

Whether to rotate horizontal axis labels -90 degrees.

###### Returns

`boolean` \| `undefined`

###### Inherited from

[`Axis`](#axis).[`labelRotation`](#labelrotation)

###### Call Signature

> **labelRotation**(`_`: `boolean`): `this`

Defined in: [components/Axis.ts:1641](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1641)

Whether to rotate horizontal axis labels -90 degrees.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`labelRotation`](#labelrotation)

<a id="labels-5"></a>

##### labels()

###### Call Signature

> **labels**(): `unknown`[] \| `undefined`

Defined in: [components/Axis.ts:1620](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1620)

Visible tick labels of the axis.

###### Returns

`unknown`[] \| `undefined`

###### Inherited from

[`Axis`](#axis).[`labels`](#labels)

###### Call Signature

> **labels**(`_`: `unknown`[]): `this`

Defined in: [components/Axis.ts:1621](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1621)

Visible tick labels of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`labels`](#labels)

<a id="locale-17"></a>

##### locale()

###### Call Signature

> **locale**(): `string`

Defined in: [utils/BaseClass.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L156)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Returns

`string`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Axis`](#axis).[`locale`](#locale-1)

###### Call Signature

> **locale**(`_`: `string` \| `object`): `this`

Defined in: [utils/BaseClass.ts:157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L157)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `object` |

###### Returns

`this`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`Axis`](#axis).[`locale`](#locale-1)

<a id="maxsize-5"></a>

##### maxSize()

###### Call Signature

> **maxSize**(): `number`

Defined in: [components/Axis.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1651)

Maximum size allowed for the space that contains the axis tick labels and title.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`maxSize`](#maxsize)

###### Call Signature

> **maxSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1652](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1652)

Maximum size allowed for the space that contains the axis tick labels and title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`maxSize`](#maxsize)

<a id="minsize-5"></a>

##### minSize()

###### Call Signature

> **minSize**(): `number`

Defined in: [components/Axis.ts:1660](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1660)

Minimum size alloted for the space that contains the axis tick labels and title.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`minSize`](#minsize)

###### Call Signature

> **minSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1661](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1661)

Minimum size alloted for the space that contains the axis tick labels and title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`minSize`](#minsize)

<a id="on-17"></a>

##### on()

###### Call Signature

> **on**(): `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

Defined in: [components/Timeline.ts:836](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L836)

Event listener for the specified brush event *typename*. Mirrors the core [d3-brush](https://github.com/d3/d3-brush#brush_on) behavior.

###### Returns

`Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

###### Overrides

[`Axis`](#axis).[`on`](#on-1)

###### Call Signature

> **on**(`_`: `string`): ((...`args`: `unknown`[]) => `unknown`) \| `undefined`

Defined in: [components/Timeline.ts:837](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L837)

Event listener for the specified brush event *typename*. Mirrors the core [d3-brush](https://github.com/d3/d3-brush#brush_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

((...`args`: `unknown`[]) => `unknown`) \| `undefined`

###### Overrides

[`Axis`](#axis).[`on`](#on-1)

###### Call Signature

> **on**(`_`: `string`, `f`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [components/Timeline.ts:838](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L838)

Event listener for the specified brush event *typename*. Mirrors the core [d3-brush](https://github.com/d3/d3-brush#brush_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |
| `f` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

`this`

###### Overrides

[`Axis`](#axis).[`on`](#on-1)

###### Call Signature

> **on**(`_`: `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>): `this`

Defined in: [components/Timeline.ts:839](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L839)

Event listener for the specified brush event *typename*. Mirrors the core [d3-brush](https://github.com/d3/d3-brush#brush_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> |

###### Returns

`this`

###### Overrides

[`Axis`](#axis).[`on`](#on-1)

<a id="orient-7"></a>

##### orient()

###### Call Signature

> **orient**(): `string`

Defined in: [components/Axis.ts:1669](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1669)

The orientation of the shape.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`orient`](#orient)

###### Call Signature

> **orient**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1670](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1670)

The orientation of the shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`orient`](#orient)

<a id="outerbounds-7"></a>

##### outerBounds()

> **outerBounds**(): `Record`\<`string`, `number`\>

Defined in: [components/Axis.ts:1700](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1700)

Returns the outer bounds of the axis content. Must be called after rendering.

###### Returns

`Record`\<`string`, `number`\>

###### Example

```ts
{"width": 180, "height": 24, "x": 10, "y": 20}
```

###### Inherited from

[`Axis`](#axis).[`outerBounds`](#outerbounds)

<a id="padding-8"></a>

##### padding()

###### Call Signature

> **padding**(): `number`

Defined in: [components/Axis.ts:1707](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1707)

The padding between each tick label.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`padding`](#padding)

###### Call Signature

> **padding**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1708)

The padding between each tick label.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`padding`](#padding)

<a id="paddinginner-6"></a>

##### paddingInner()

###### Call Signature

> **paddingInner**(): `number`

Defined in: [components/Axis.ts:1716](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1716)

The inner padding of band scale.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`paddingInner`](#paddinginner)

###### Call Signature

> **paddingInner**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1717)

The inner padding of band scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`paddingInner`](#paddinginner)

<a id="paddingouter-6"></a>

##### paddingOuter()

###### Call Signature

> **paddingOuter**(): `number`

Defined in: [components/Axis.ts:1727](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1727)

The outer padding of band scales.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`paddingOuter`](#paddingouter)

###### Call Signature

> **paddingOuter**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1728](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1728)

The outer padding of band scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`paddingOuter`](#paddingouter)

<a id="parent-17"></a>

##### parent()

###### Call Signature

> **parent**(): `Record`\<`string`, `unknown`\>

Defined in: [utils/BaseClass.ts:200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L200)

Parent config used by the wrapper.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Axis`](#axis).[`parent`](#parent-1)

###### Call Signature

> **parent**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L201)

Parent config used by the wrapper.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`parent`](#parent-1)

<a id="playbutton"></a>

##### playButton()

###### Call Signature

> **playButton**(): `boolean`

Defined in: [components/Timeline.ts:856](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L856)

Determines the visibility of the play button to the left the of timeline, which will cycle through the available periods at a rate defined by the playButtonInterval method.

###### Returns

`boolean`

###### Call Signature

> **playButton**(`_`: `boolean`): `this`

Defined in: [components/Timeline.ts:857](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L857)

Determines the visibility of the play button to the left the of timeline, which will cycle through the available periods at a rate defined by the playButtonInterval method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

<a id="playbuttonconfig"></a>

##### playButtonConfig()

###### Call Signature

> **playButtonConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Timeline.ts:867](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L867)

The config Object for the Rect class used to create the playButton.

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **playButtonConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Timeline.ts:868](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L868)

The config Object for the Rect class used to create the playButton.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="playbuttoninterval"></a>

##### playButtonInterval()

###### Call Signature

> **playButtonInterval**(): `number`

Defined in: [components/Timeline.ts:878](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L878)

The value, in milliseconds, to use when cycling through the available time periods when the user clicks the playButton.

###### Returns

`number`

###### Call Signature

> **playButtonInterval**(`_`: `number`): `this`

Defined in: [components/Timeline.ts:879](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L879)

The value, in milliseconds, to use when cycling through the available time periods when the user clicks the playButton.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

<a id="range-5"></a>

##### range()

###### Call Signature

> **range**(): (`number` \| `undefined`)[] \| `undefined`

Defined in: [components/Axis.ts:1738](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1738)

Scale range (in pixels) of the axis. The given array must have 2 values, but one may be `undefined` to allow the default behavior for that value.

###### Returns

(`number` \| `undefined`)[] \| `undefined`

###### Inherited from

[`Axis`](#axis).[`range`](#range)

###### Call Signature

> **range**(`_`: (`number` \| `undefined`)[]): `this`

Defined in: [components/Axis.ts:1739](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1739)

Scale range (in pixels) of the axis. The given array must have 2 values, but one may be `undefined` to allow the default behavior for that value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`number` \| `undefined`)[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`range`](#range)

<a id="render-35"></a>

##### render()

> **render**(`callback?`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [components/Timeline.ts:514](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L514)

Draws the timeline.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | (...`args`: `unknown`[]) => `unknown` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Overrides

[`Axis`](#axis).[`render`](#render-2)

<a id="rounding-5"></a>

##### rounding()

###### Call Signature

> **rounding**(): `string`

Defined in: [components/Axis.ts:1747](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1747)

The rounding method for more evenly spaced ticks at the extents of the scale. Can be "none" (default), "outside", or "inside".

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`rounding`](#rounding)

###### Call Signature

> **rounding**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1748](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1748)

The rounding method for more evenly spaced ticks at the extents of the scale. Can be "none" (default), "outside", or "inside".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`rounding`](#rounding)

<a id="roundinginsidemaxprefix-5"></a>

##### roundingInsideMaxPrefix()

###### Call Signature

> **roundingInsideMaxPrefix**(): `string`

Defined in: [components/Axis.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1778)

The prefix for the maximum value of "inside" rounding scales.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMaxPrefix`](#roundinginsidemaxprefix)

###### Call Signature

> **roundingInsideMaxPrefix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1779](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1779)

The prefix for the maximum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMaxPrefix`](#roundinginsidemaxprefix)

<a id="roundinginsidemaxsuffix-5"></a>

##### roundingInsideMaxSuffix()

###### Call Signature

> **roundingInsideMaxSuffix**(): `string`

Defined in: [components/Axis.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1789)

The suffix for the maximum value of "inside" rounding scales.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMaxSuffix`](#roundinginsidemaxsuffix)

###### Call Signature

> **roundingInsideMaxSuffix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1790](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1790)

The suffix for the maximum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMaxSuffix`](#roundinginsidemaxsuffix)

<a id="roundinginsideminprefix-5"></a>

##### roundingInsideMinPrefix()

###### Call Signature

> **roundingInsideMinPrefix**(): `string`

Defined in: [components/Axis.ts:1756](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1756)

The prefix for the minimum value of "inside" rounding scales.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMinPrefix`](#roundinginsideminprefix)

###### Call Signature

> **roundingInsideMinPrefix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1757](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1757)

The prefix for the minimum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMinPrefix`](#roundinginsideminprefix)

<a id="roundinginsideminsuffix-5"></a>

##### roundingInsideMinSuffix()

###### Call Signature

> **roundingInsideMinSuffix**(): `string`

Defined in: [components/Axis.ts:1767](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1767)

The suffix for the minimum value of "inside" rounding scales.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMinSuffix`](#roundinginsideminsuffix)

###### Call Signature

> **roundingInsideMinSuffix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1768](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1768)

The suffix for the minimum value of "inside" rounding scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`roundingInsideMinSuffix`](#roundinginsideminsuffix)

<a id="scale-13"></a>

##### scale()

###### Call Signature

> **scale**(): `string`

Defined in: [components/Axis.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1800)

Scale of the axis.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`scale`](#scale-1)

###### Call Signature

> **scale**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1801](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1801)

Scale of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`scale`](#scale-1)

<a id="scalepadding-5"></a>

##### scalePadding()

###### Call Signature

> **scalePadding**(): `number`

Defined in: [components/Axis.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1809)

The "padding" property of the scale, often used in point scales.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`scalePadding`](#scalepadding)

###### Call Signature

> **scalePadding**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1810](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1810)

The "padding" property of the scale, often used in point scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`scalePadding`](#scalepadding)

<a id="select-35"></a>

##### select()

###### Call Signature

> **select**(): `Selection`

Defined in: [components/Axis.ts:1820](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1820)

The SVG container element as a d3 selector or DOM element.

###### Returns

`Selection`

###### Inherited from

[`Axis`](#axis).[`select`](#select-2)

###### Call Signature

> **select**(`_`: `string` \| `HTMLElement`): `this`

Defined in: [components/Axis.ts:1821](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1821)

The SVG container element as a d3 selector or DOM element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `HTMLElement` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`select`](#select-2)

<a id="selection"></a>

##### selection()

###### Call Signature

> **selection**(): `unknown`

Defined in: [components/Timeline.ts:900](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L900)

Selection. Defaults to the most recent year in the timeline.

###### Returns

`unknown`

###### Call Signature

> **selection**(`_`: `unknown`): `this`

Defined in: [components/Timeline.ts:901](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L901)

Selection. Defaults to the most recent year in the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown` |

###### Returns

`this`

<a id="selectionconfig"></a>

##### selectionConfig()

###### Call Signature

> **selectionConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Timeline.ts:889](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L889)

Selection style.

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **selectionConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Timeline.ts:890](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L890)

Selection style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="shape-25"></a>

##### shape()

###### Call Signature

> **shape**(): `string`

Defined in: [components/Axis.ts:1831](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1831)

Tick shape constructor.

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`shape`](#shape-1)

###### Call Signature

> **shape**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1832)

Tick shape constructor.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`shape`](#shape-1)

<a id="shapeconfig-36"></a>

##### shapeConfig()

###### Call Signature

> **shapeConfig**(): `Record`\<`string`, `any`\>

Defined in: [components/Axis.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1841)

Tick style of the axis.

###### Returns

`Record`\<`string`, `any`\>

###### Inherited from

[`Axis`](#axis).[`shapeConfig`](#shapeconfig-2)

###### Call Signature

> **shapeConfig**(`_`: `Record`\<`string`, `any`\>): `this`

Defined in: [components/Axis.ts:1843](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1843)

Tick style of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `any`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`shapeConfig`](#shapeconfig-2)

<a id="snapping"></a>

##### snapping()

###### Call Signature

> **snapping**(): `boolean`

Defined in: [components/Timeline.ts:909](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L909)

Toggles the snapping value.

###### Returns

`boolean`

###### Call Signature

> **snapping**(`_`: `boolean`): `this`

Defined in: [components/Timeline.ts:910](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L910)

Toggles the snapping value.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `boolean` |

###### Returns

`this`

<a id="tickformat-5"></a>

##### tickFormat()

###### Call Signature

> **tickFormat**(): `any`

Defined in: [components/Axis.ts:1855](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1855)

Tick formatter.

###### Returns

`any`

###### Inherited from

[`Axis`](#axis).[`tickFormat`](#tickformat)

###### Call Signature

> **tickFormat**(`_`: `any`): `this`

Defined in: [components/Axis.ts:1857](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1857)

Tick formatter.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`tickFormat`](#tickformat)

<a id="ticks-5"></a>

##### ticks()

###### Call Signature

> **ticks**(): `unknown`[] \| `undefined`

Defined in: [components/Axis.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1866)

Tick values of the axis.

###### Returns

`unknown`[] \| `undefined`

###### Inherited from

[`Axis`](#axis).[`ticks`](#ticks)

###### Call Signature

> **ticks**(`_`: `unknown`[]): `this`

Defined in: [components/Axis.ts:1867](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1867)

Tick values of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown`[] |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`ticks`](#ticks)

<a id="ticksize-5"></a>

##### tickSize()

###### Call Signature

> **tickSize**(): `number`

Defined in: [components/Axis.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1875)

Tick size of the axis.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`tickSize`](#ticksize)

###### Call Signature

> **tickSize**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1876](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1876)

Tick size of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`tickSize`](#ticksize)

<a id="ticksuffix-5"></a>

##### tickSuffix()

###### Call Signature

> **tickSuffix**(): `string`

Defined in: [components/Axis.ts:1884](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1884)

The tick abbreviation behavior for linear scales. Accepts "normal" (uses formatAbbreviate) or "smallest" (uses the suffix from the smallest tick as reference for every tick).

###### Returns

`string`

###### Inherited from

[`Axis`](#axis).[`tickSuffix`](#ticksuffix)

###### Call Signature

> **tickSuffix**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1885](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1885)

The tick abbreviation behavior for linear scales. Accepts "normal" (uses formatAbbreviate) or "smallest" (uses the suffix from the smallest tick as reference for every tick).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`tickSuffix`](#ticksuffix)

<a id="timelocale-5"></a>

##### timeLocale()

###### Call Signature

> **timeLocale**(): `Record`\<`string`, `unknown`\> \| `undefined`

Defined in: [components/Axis.ts:1895](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1895)

Defines a custom locale object to be used in time scale. This object must include the following properties: dateTime, date, time, periods, days, shortDays, months, shortMonths. For more information, you can revise [d3p.d3-time-format](https://github.com/d3/d3-time-format/blob/master/README.md#timeFormatLocale).

###### Returns

`Record`\<`string`, `unknown`\> \| `undefined`

###### Inherited from

[`Axis`](#axis).[`timeLocale`](#timelocale)

###### Call Signature

> **timeLocale**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1896](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1896)

Defines a custom locale object to be used in time scale. This object must include the following properties: dateTime, date, time, periods, days, shortDays, months, shortMonths. For more information, you can revise [d3p.d3-time-format](https://github.com/d3/d3-time-format/blob/master/README.md#timeFormatLocale).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`timeLocale`](#timelocale)

<a id="title-24"></a>

##### title()

###### Call Signature

> **title**(): `string` \| `undefined`

Defined in: [components/Axis.ts:1904](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1904)

Title of the axis.

###### Returns

`string` \| `undefined`

###### Inherited from

[`Axis`](#axis).[`title`](#title-1)

###### Call Signature

> **title**(`_`: `string`): `this`

Defined in: [components/Axis.ts:1905](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1905)

Title of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`title`](#title-1)

<a id="titleconfig-24"></a>

##### titleConfig()

###### Call Signature

> **titleConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Axis.ts:1913](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1913)

Title configuration of the axis.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`Axis`](#axis).[`titleConfig`](#titleconfig-1)

###### Call Signature

> **titleConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Axis.ts:1914](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1914)

Title configuration of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`titleConfig`](#titleconfig-1)

<a id="translate-17"></a>

##### translate()

###### Call Signature

> **translate**(): (`d`: `string`, `locale?`: `string`) => `string`

Defined in: [utils/BaseClass.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L214)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Returns

(`d`: `string`, `locale?`: `string`) => `string`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Axis`](#axis).[`translate`](#translate-1)

###### Call Signature

> **translate**(`_`: (`d`: `string`, `locale?`: `string`) => `string`): `this`

Defined in: [utils/BaseClass.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L215)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `string`, `locale?`: `string`) => `string` |

###### Returns

`this`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`Axis`](#axis).[`translate`](#translate-1)

<a id="width-29"></a>

##### width()

###### Call Signature

> **width**(): `number`

Defined in: [components/Axis.ts:1924](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1924)

Overall width of the axis.

###### Returns

`number`

###### Inherited from

[`Axis`](#axis).[`width`](#width-1)

###### Call Signature

> **width**(`_`: `number`): `this`

Defined in: [components/Axis.ts:1925](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L1925)

Overall width of the axis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` |

###### Returns

`this`

###### Inherited from

[`Axis`](#axis).[`width`](#width-1)

#### Properties

| Property | Type | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="property-_align-7"></a> `_align` | `string` | - | [`Axis`](#axis).[`_align`](#property-_align) | [components/Axis.ts:206](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L206) |
| <a id="property-_availableticks-5"></a> `_availableTicks` | `unknown`[] | - | [`Axis`](#axis).[`_availableTicks`](#property-_availableticks) | [components/Axis.ts:271](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L271) |
| <a id="property-_barconfig-5"></a> `_barConfig` | `Record`\<`string`, `unknown`\> | - | [`Axis`](#axis).[`_barConfig`](#property-_barconfig) | [components/Axis.ts:207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L207) |
| <a id="property-_brush"></a> `_brush` | `any` | - | - | [components/Timeline.ts:49](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L49) |
| <a id="property-_brushfilter"></a> `_brushFilter` | (`event`: `unknown`) => `boolean` | - | - | [components/Timeline.ts:24](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L24) |
| <a id="property-_brushgroup"></a> `_brushGroup` | `any` | - | - | [components/Timeline.ts:51](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L51) |
| <a id="property-_brushing"></a> `_brushing` | `boolean` | - | - | [components/Timeline.ts:22](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L22) |
| <a id="property-_brushmin"></a> `_brushMin` | () => `number` | - | - | [components/Timeline.ts:25](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L25) |
| <a id="property-_buttonalign"></a> `_buttonAlign` | `string` | - | - | [components/Timeline.ts:26](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L26) |
| <a id="property-_buttonbehavior"></a> `_buttonBehavior` | `string` | - | - | [components/Timeline.ts:27](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L27) |
| <a id="property-_buttonbehaviorcurrent"></a> `_buttonBehaviorCurrent` | `string` | - | - | [components/Timeline.ts:28](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L28) |
| <a id="property-_buttonheight"></a> `_buttonHeight` | `number` | - | - | [components/Timeline.ts:30](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L30) |
| <a id="property-_buttonpadding"></a> `_buttonPadding` | `number` | - | - | [components/Timeline.ts:29](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L29) |
| <a id="property-_configdefault-17"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | - | [`Axis`](#axis).[`_configDefault`](#property-_configdefault-1) | [utils/BaseClass.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L69) |
| <a id="property-_d3scale-5"></a> `_d3Scale` | `any` | - | [`Axis`](#axis).[`_d3Scale`](#property-_d3scale) | [components/Axis.ts:266](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L266) |
| <a id="property-_d3scalenegative-5"></a> `_d3ScaleNegative` | `any` | - | [`Axis`](#axis).[`_d3ScaleNegative`](#property-_d3scalenegative) | [components/Axis.ts:268](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L268) |
| <a id="property-_data-17"></a> `_data` | `any`[] | - | [`Axis`](#axis).[`_data`](#property-_data-1) | [components/Axis.ts:209](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L209) |
| <a id="property-_domain-6"></a> `_domain` | `any`[] | - | [`Axis`](#axis).[`_domain`](#property-_domain) | [components/Axis.ts:211](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L211) |
| <a id="property-_duration-17"></a> `_duration` | `number` | - | [`Axis`](#axis).[`_duration`](#property-_duration-1) | [components/Axis.ts:212](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L212) |
| <a id="property-_grid-5"></a> `_grid` | `unknown`[] \| *required* | - | [`Axis`](#axis).[`_grid`](#property-_grid) | [components/Axis.ts:216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L216) |
| <a id="property-_gridconfig-5"></a> `_gridConfig` | `Record`\<`string`, `unknown`\> | - | [`Axis`](#axis).[`_gridConfig`](#property-_gridconfig) | [components/Axis.ts:213](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L213) |
| <a id="property-_gridlog-5"></a> `_gridLog` | `boolean` | - | [`Axis`](#axis).[`_gridLog`](#property-_gridlog) | [components/Axis.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L214) |
| <a id="property-_gridsize-5"></a> `_gridSize` | `number` \| *required* | - | [`Axis`](#axis).[`_gridSize`](#property-_gridsize) | [components/Axis.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L215) |
| <a id="property-_group-14"></a> `_group` | `Selection` | - | [`Axis`](#axis).[`_group`](#property-_group-1) | [components/Axis.ts:269](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L269) |
| <a id="property-_handleconfig"></a> `_handleConfig` | `Record`\<`string`, `unknown`\> | - | - | [components/Timeline.ts:32](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L32) |
| <a id="property-_handlesize"></a> `_handleSize` | `number` | - | - | [components/Timeline.ts:33](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L33) |
| <a id="property-_height-11"></a> `_height` | `number` | - | [`Axis`](#axis).[`_height`](#property-_height) | [components/Axis.ts:217](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L217) |
| <a id="property-_hiddenhandles"></a> `_hiddenHandles` | `boolean` | - | - | [components/Timeline.ts:34](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L34) |
| <a id="property-_labeloffset-5"></a> `_labelOffset` | `boolean` | - | [`Axis`](#axis).[`_labelOffset`](#property-_labeloffset) | [components/Axis.ts:218](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L218) |
| <a id="property-_labelrotation-5"></a> `_labelRotation` | `boolean` \| *required* | - | [`Axis`](#axis).[`_labelRotation`](#property-_labelrotation) | [components/Axis.ts:219](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L219) |
| <a id="property-_labels-5"></a> `_labels` | `unknown`[] \| *required* | - | [`Axis`](#axis).[`_labels`](#property-_labels) | [components/Axis.ts:220](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L220) |
| <a id="property-_lastscale-5"></a> `_lastScale` | ((`d`: `unknown`) => `number`) \| *required* | - | [`Axis`](#axis).[`_lastScale`](#property-_lastscale) | [components/Axis.ts:270](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L270) |
| <a id="property-_locale-17"></a> `_locale` | `any` | - | [`Axis`](#axis).[`_locale`](#property-_locale-1) | [components/Axis.ts:223](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L223) |
| <a id="property-_margin-5"></a> `_margin` | `Record`\<`string`, `number`\> | - | [`Axis`](#axis).[`_margin`](#property-_margin) | [components/Axis.ts:224](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L224) |
| <a id="property-_maxsize-5"></a> `_maxSize` | `number` | - | [`Axis`](#axis).[`_maxSize`](#property-_maxsize) | [components/Axis.ts:225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L225) |
| <a id="property-_minsize-5"></a> `_minSize` | `number` | - | [`Axis`](#axis).[`_minSize`](#property-_minsize) | [components/Axis.ts:226](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L226) |
| <a id="property-_on-17"></a> `_on` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | [`Axis`](#axis).[`_on`](#property-_on-1) | - | [components/Timeline.ts:36](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L36) |
| <a id="property-_orient-7"></a> `_orient` | `string` | - | [`Axis`](#axis).[`_orient`](#property-_orient) | [components/Axis.ts:227](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L227) |
| <a id="property-_outerbounds-7"></a> `_outerBounds` | `Record`\<`string`, `number`\> | - | [`Axis`](#axis).[`_outerBounds`](#property-_outerbounds) | [components/Axis.ts:228](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L228) |
| <a id="property-_padding-8"></a> `_padding` | `number` | - | [`Axis`](#axis).[`_padding`](#property-_padding) | [components/Axis.ts:229](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L229) |
| <a id="property-_paddinginner-5"></a> `_paddingInner` | `number` | - | [`Axis`](#axis).[`_paddingInner`](#property-_paddinginner) | [components/Axis.ts:230](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L230) |
| <a id="property-_paddingleft"></a> `_paddingLeft` | `number` | - | - | [components/Timeline.ts:52](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L52) |
| <a id="property-_paddingouter-5"></a> `_paddingOuter` | `number` | - | [`Axis`](#axis).[`_paddingOuter`](#property-_paddingouter) | [components/Axis.ts:231](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L231) |
| <a id="property-_parent-17"></a> `_parent` | `Record`\<`string`, `unknown`\> | - | [`Axis`](#axis).[`_parent`](#property-_parent-1) | [utils/BaseClass.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L66) |
| <a id="property-_playbutton"></a> `_playButton` | `boolean` | - | - | [components/Timeline.ts:37](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L37) |
| <a id="property-_playbuttonclass"></a> `_playButtonClass` | [`TextBox`](#textbox) | - | - | [components/Timeline.ts:38](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L38) |
| <a id="property-_playbuttonconfig"></a> `_playButtonConfig` | `Record`\<`string`, `unknown`\> | - | - | [components/Timeline.ts:40](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L40) |
| <a id="property-_playbuttoninterval"></a> `_playButtonInterval` | `number` | - | - | [components/Timeline.ts:41](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L41) |
| <a id="property-_playtimer"></a> `_playTimer` | `number` \| `false` | - | - | [components/Timeline.ts:42](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L42) |
| <a id="property-_position-5"></a> `_position` | `object` | - | [`Axis`](#axis).[`_position`](#property-_position) | [components/Axis.ts:232](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L232) |
| `_position.height` | `string` | - | - | [components/Axis.ts:235](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L235) |
| `_position.horizontal` | `boolean` | - | - | [components/Axis.ts:233](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L233) |
| `_position.opposite` | `string` | - | - | [components/Axis.ts:238](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L238) |
| `_position.width` | `string` | - | - | [components/Axis.ts:234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L234) |
| `_position.x` | `string` | - | - | [components/Axis.ts:236](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L236) |
| `_position.y` | `string` | - | - | [components/Axis.ts:237](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L237) |
| <a id="property-_range-5"></a> `_range` | (`number` \| `undefined`)[] \| *required* | - | [`Axis`](#axis).[`_range`](#property-_range) | [components/Axis.ts:240](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L240) |
| <a id="property-_rounding-5"></a> `_rounding` | `string` | - | [`Axis`](#axis).[`_rounding`](#property-_rounding) | [components/Axis.ts:241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L241) |
| <a id="property-_roundinginsidemaxprefix-5"></a> `_roundingInsideMaxPrefix` | `string` | - | [`Axis`](#axis).[`_roundingInsideMaxPrefix`](#property-_roundinginsidemaxprefix) | [components/Axis.ts:244](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L244) |
| <a id="property-_roundinginsidemaxsuffix-5"></a> `_roundingInsideMaxSuffix` | `string` | - | [`Axis`](#axis).[`_roundingInsideMaxSuffix`](#property-_roundinginsidemaxsuffix) | [components/Axis.ts:245](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L245) |
| <a id="property-_roundinginsideminprefix-5"></a> `_roundingInsideMinPrefix` | `string` | - | [`Axis`](#axis).[`_roundingInsideMinPrefix`](#property-_roundinginsideminprefix) | [components/Axis.ts:242](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L242) |
| <a id="property-_roundinginsideminsuffix-5"></a> `_roundingInsideMinSuffix` | `string` | - | [`Axis`](#axis).[`_roundingInsideMinSuffix`](#property-_roundinginsideminsuffix) | [components/Axis.ts:243](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L243) |
| <a id="property-_scale-13"></a> `_scale` | `string` | - | [`Axis`](#axis).[`_scale`](#property-_scale-1) | [components/Axis.ts:246](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L246) |
| <a id="property-_scalepadding-5"></a> `_scalePadding` | `number` | - | [`Axis`](#axis).[`_scalePadding`](#property-_scalepadding) | [components/Axis.ts:247](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L247) |
| <a id="property-_select-17"></a> `_select` | `Selection` | - | [`Axis`](#axis).[`_select`](#property-_select-1) | [components/Axis.ts:205](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L205) |
| <a id="property-_selection"></a> `_selection` | `unknown` | - | - | [components/Timeline.ts:43](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L43) |
| <a id="property-_selectionconfig"></a> `_selectionConfig` | `Record`\<`string`, `unknown`\> | - | - | [components/Timeline.ts:45](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L45) |
| <a id="property-_shape-6"></a> `_shape` | `string` | - | [`Axis`](#axis).[`_shape`](#property-_shape) | [components/Axis.ts:248](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L248) |
| <a id="property-_shapeconfig-17"></a> `_shapeConfig` | `Record`\<`string`, `any`\> | - | [`Axis`](#axis).[`_shapeConfig`](#property-_shapeconfig-1) | [components/Axis.ts:251](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L251) |
| <a id="property-_snapping"></a> `_snapping` | `boolean` | - | - | [components/Timeline.ts:46](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L46) |
| <a id="property-_tickformat-5"></a> `_tickFormat` | `any` | - | [`Axis`](#axis).[`_tickFormat`](#property-_tickformat) | [components/Axis.ts:253](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L253) |
| <a id="property-_ticks-5"></a> `_ticks` | `unknown`[] \| *required* | - | [`Axis`](#axis).[`_ticks`](#property-_ticks) | [components/Axis.ts:254](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L254) |
| <a id="property-_ticksize-5"></a> `_tickSize` | `number` | - | [`Axis`](#axis).[`_tickSize`](#property-_ticksize) | [components/Axis.ts:255](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L255) |
| <a id="property-_ticksuffix-5"></a> `_tickSuffix` | `string` | - | [`Axis`](#axis).[`_tickSuffix`](#property-_ticksuffix) | [components/Axis.ts:256](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L256) |
| <a id="property-_tickswidth"></a> `_ticksWidth` | `number` | - | - | [components/Timeline.ts:53](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Timeline.ts#L53) |
| <a id="property-_tickunit-5"></a> `_tickUnit` | `number` | - | [`Axis`](#axis).[`_tickUnit`](#property-_tickunit) | [components/Axis.ts:257](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L257) |
| <a id="property-_timelocale-5"></a> `_timeLocale` | `Record`\<`string`, `unknown`\> \| *required* | - | [`Axis`](#axis).[`_timeLocale`](#property-_timelocale) | [components/Axis.ts:258](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L258) |
| <a id="property-_title-6"></a> `_title` | `string` \| *required* | - | [`Axis`](#axis).[`_title`](#property-_title) | [components/Axis.ts:259](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L259) |
| <a id="property-_titleclass-6"></a> `_titleClass` | [`TextBox`](#textbox) | - | [`Axis`](#axis).[`_titleClass`](#property-_titleclass) | [components/Axis.ts:260](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L260) |
| <a id="property-_titleconfig-6"></a> `_titleConfig` | `Record`\<`string`, `any`\> | - | [`Axis`](#axis).[`_titleConfig`](#property-_titleconfig) | [components/Axis.ts:262](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L262) |
| <a id="property-_transition-12"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Axis`](#axis).[`_transition`](#property-_transition-1) | [components/Axis.ts:273](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L273) |
| <a id="property-_translate-17"></a> `_translate` | (`d`: `string`, `locale?`: `string`) => `string` | - | [`Axis`](#axis).[`_translate`](#property-_translate-1) | [utils/BaseClass.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L67) |
| <a id="property-_userformat-5"></a> `_userFormat` | `false` \| ((`d`: `unknown`) => `string`) \| *required* | - | [`Axis`](#axis).[`_userFormat`](#property-_userformat) | [components/Axis.ts:274](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L274) |
| <a id="property-_uuid-17"></a> `_uuid` | `string` | - | [`Axis`](#axis).[`_uuid`](#property-_uuid-1) | [utils/BaseClass.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L68) |
| <a id="property-_visibleticks-5"></a> `_visibleTicks` | `unknown`[] | - | [`Axis`](#axis).[`_visibleTicks`](#property-_visibleticks) | [components/Axis.ts:272](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L272) |
| <a id="property-_width-11"></a> `_width` | `number` | - | [`Axis`](#axis).[`_width`](#property-_width) | [components/Axis.ts:263](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Axis.ts#L263) |

***

<a id="tooltip-18"></a>

### Tooltip

Defined in: [components/Tooltip.ts:81](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L81)

Creates HTML tooltips in the body of a webpage.

#### Extends

- [`BaseClass`](#baseclass)

#### Methods

<a id="arrow"></a>

##### arrow()

###### Call Signature

> **arrow**(): (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

Defined in: [components/Tooltip.ts:393](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L393)

The inner HTML content of the arrow element, empty by default.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

###### Example

```ts
function value(d) {
return d.arrow || "";
}
```

###### Call Signature

> **arrow**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `this`

Defined in: [components/Tooltip.ts:394](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L394)

The inner HTML content of the arrow element, empty by default.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`this`

###### Example

```ts
function value(d) {
return d.arrow || "";
}
```

<a id="arrowstyle"></a>

##### arrowStyle()

###### Call Signature

> **arrowStyle**(): `Record`\<`string`, `string`\>

Defined in: [components/Tooltip.ts:418](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L418)

CSS styles applied to the arrow element.

###### Returns

`Record`\<`string`, `string`\>

###### Example

```ts
{
  "content": "",
  "border-width": "10px",
  "border-style": "solid",
  "border-color": "rgba(255, 255, 255, 0.75) transparent transparent transparent",
  "position": "absolute"
}
```

###### Call Signature

> **arrowStyle**(`_`: `Record`\<`string`, `string`\>): `this`

Defined in: [components/Tooltip.ts:419](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L419)

CSS styles applied to the arrow element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `string`\> |

###### Returns

`this`

###### Example

```ts
{
  "content": "",
  "border-width": "10px",
  "border-style": "solid",
  "border-color": "rgba(255, 255, 255, 0.75) transparent transparent transparent",
  "position": "absolute"
}
```

<a id="background"></a>

##### background()

###### Call Signature

> **background**(): (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

Defined in: [components/Tooltip.ts:429](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L429)

The background color accessor for each tooltip.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

###### Call Signature

> **background**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `this`

Defined in: [components/Tooltip.ts:430](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L430)

The background color accessor for each tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`this`

<a id="body"></a>

##### body()

###### Call Signature

> **body**(): (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

Defined in: [components/Tooltip.ts:450](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L450)

The body content accessor for each tooltip.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

###### Example

```ts
function value(d) {
return d.body || "";
}
```

###### Call Signature

> **body**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `this`

Defined in: [components/Tooltip.ts:451](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L451)

The body content accessor for each tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`this`

###### Example

```ts
function value(d) {
return d.body || "";
}
```

<a id="bodystyle"></a>

##### bodyStyle()

###### Call Signature

> **bodyStyle**(): `Record`\<`string`, `string`\>

Defined in: [components/Tooltip.ts:472](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L472)

CSS styles applied to the body element.

###### Returns

`Record`\<`string`, `string`\>

###### Example

```ts
{
"font-size": "12px",
"font-weight": "400"
}
```

###### Call Signature

> **bodyStyle**(`_`: `Record`\<`string`, `string`\>): `this`

Defined in: [components/Tooltip.ts:473](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L473)

CSS styles applied to the body element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `string`\> |

###### Returns

`this`

###### Example

```ts
{
"font-size": "12px",
"font-weight": "400"
}
```

<a id="border"></a>

##### border()

###### Call Signature

> **border**(): (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

Defined in: [components/Tooltip.ts:483](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L483)

The border accessor for each tooltip.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

###### Call Signature

> **border**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `this`

Defined in: [components/Tooltip.ts:484](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L484)

The border accessor for each tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`this`

<a id="borderradius"></a>

##### borderRadius()

###### Call Signature

> **borderRadius**(): (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

Defined in: [components/Tooltip.ts:499](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L499)

The border-radius accessor for each tooltip.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

###### Call Signature

> **borderRadius**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `this`

Defined in: [components/Tooltip.ts:500](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L500)

The border-radius accessor for each tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`this`

<a id="classname"></a>

##### className()

###### Call Signature

> **className**(): `string`

Defined in: [components/Tooltip.ts:515](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L515)

The CSS class name applied to the tooltip container.

###### Returns

`string`

###### Call Signature

> **className**(`_`: `string`): `this`

Defined in: [components/Tooltip.ts:516](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L516)

The CSS class name applied to the tooltip container.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

`this`

<a id="config-18"></a>

##### config()

###### Call Signature

> **config**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L91)

Methods that correspond to the key/value pairs and returns this class.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`BaseClass`](#baseclass).[`config`](#config-7)

###### Call Signature

> **config**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L92)

Methods that correspond to the key/value pairs and returns this class.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`config`](#config-7)

<a id="data-36"></a>

##### data()

###### Call Signature

> **data**(): `DataPoint`[]

Defined in: [components/Tooltip.ts:524](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L524)

The data array used to create tooltips.

###### Returns

`DataPoint`[]

###### Call Signature

> **data**(`_`: `DataPoint`[]): `this`

Defined in: [components/Tooltip.ts:525](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L525)

The data array used to create tooltips.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `DataPoint`[] |

###### Returns

`this`

<a id="footer"></a>

##### footer()

###### Call Signature

> **footer**(): (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

Defined in: [components/Tooltip.ts:538](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L538)

The footer content accessor for each tooltip.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

###### Example

```ts
function value(d) {
return d.footer || "";
}
```

###### Call Signature

> **footer**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `this`

Defined in: [components/Tooltip.ts:539](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L539)

The footer content accessor for each tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`this`

###### Example

```ts
function value(d) {
return d.footer || "";
}
```

<a id="footerstyle"></a>

##### footerStyle()

###### Call Signature

> **footerStyle**(): `Record`\<`string`, `string`\>

Defined in: [components/Tooltip.ts:560](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L560)

CSS styles applied to the footer element.

###### Returns

`Record`\<`string`, `string`\>

###### Example

```ts
{
"font-size": "12px",
"font-weight": "400"
}
```

###### Call Signature

> **footerStyle**(`_`: `Record`\<`string`, `string`\>): `this`

Defined in: [components/Tooltip.ts:561](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L561)

CSS styles applied to the footer element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `string`\> |

###### Returns

`this`

###### Example

```ts
{
"font-size": "12px",
"font-weight": "400"
}
```

<a id="height-30"></a>

##### height()

###### Call Signature

> **height**(): (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

Defined in: [components/Tooltip.ts:571](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L571)

The height accessor for each tooltip.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

###### Call Signature

> **height**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `this`

Defined in: [components/Tooltip.ts:572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L572)

The height accessor for each tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`this`

<a id="id-10"></a>

##### id()

###### Call Signature

> **id**(): (`d`: `DataPoint`, `i`: `number`) => `string`

Defined in: [components/Tooltip.ts:592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L592)

The unique id accessor for each tooltip.

###### Returns

(`d`: `DataPoint`, `i`: `number`) => `string`

###### Example

```ts
function value(d, i) {
return d.id || "" + i;
}
```

###### Call Signature

> **id**(`_`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `this`

Defined in: [components/Tooltip.ts:593](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L593)

The unique id accessor for each tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`this`

###### Example

```ts
function value(d, i) {
return d.id || "" + i;
}
```

<a id="locale-18"></a>

##### locale()

###### Call Signature

> **locale**(): `string`

Defined in: [utils/BaseClass.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L156)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Returns

`string`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`BaseClass`](#baseclass).[`locale`](#locale-7)

###### Call Signature

> **locale**(`_`: `string` \| `object`): `this`

Defined in: [utils/BaseClass.ts:157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L157)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `object` |

###### Returns

`this`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`BaseClass`](#baseclass).[`locale`](#locale-7)

<a id="maxwidth"></a>

##### maxWidth()

###### Call Signature

> **maxWidth**(): (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

Defined in: [components/Tooltip.ts:851](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L851)

The max-width accessor for each tooltip.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

###### Call Signature

> **maxWidth**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `this`

Defined in: [components/Tooltip.ts:852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L852)

The max-width accessor for each tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`this`

<a id="minwidth"></a>

##### minWidth()

###### Call Signature

> **minWidth**(): (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

Defined in: [components/Tooltip.ts:867](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L867)

The min-width accessor for each tooltip.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

###### Call Signature

> **minWidth**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `this`

Defined in: [components/Tooltip.ts:868](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L868)

The min-width accessor for each tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`this`

<a id="offset"></a>

##### offset()

###### Call Signature

> **offset**(): (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

Defined in: [components/Tooltip.ts:604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L604)

The pixel offset between the tooltip and its anchor point.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

###### Call Signature

> **offset**(`_`: `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `this`

Defined in: [components/Tooltip.ts:605](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L605)

The pixel offset between the tooltip and its anchor point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`this`

<a id="on-18"></a>

##### on()

###### Call Signature

> **on**(): `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

Defined in: [utils/BaseClass.ts:176](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L176)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Returns

`Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `string`): ((...`args`: `unknown`[]) => `unknown`) \| `undefined`

Defined in: [utils/BaseClass.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L177)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

((...`args`: `unknown`[]) => `unknown`) \| `undefined`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `string`, `f`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [utils/BaseClass.ts:178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L178)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |
| `f` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:179](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L179)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

<a id="padding-9"></a>

##### padding()

###### Call Signature

> **padding**(): (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

Defined in: [components/Tooltip.ts:620](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L620)

The inner padding of each tooltip.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

###### Call Signature

> **padding**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `this`

Defined in: [components/Tooltip.ts:621](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L621)

The inner padding of each tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`this`

<a id="parent-18"></a>

##### parent()

###### Call Signature

> **parent**(): `Record`\<`string`, `unknown`\>

Defined in: [utils/BaseClass.ts:200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L200)

Parent config used by the wrapper.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`BaseClass`](#baseclass).[`parent`](#parent-7)

###### Call Signature

> **parent**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L201)

Parent config used by the wrapper.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`parent`](#parent-7)

<a id="pointerevents-9"></a>

##### pointerEvents()

###### Call Signature

> **pointerEvents**(): (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

Defined in: [components/Tooltip.ts:636](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L636)

The pointer-events CSS property for each tooltip.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

###### Call Signature

> **pointerEvents**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `this`

Defined in: [components/Tooltip.ts:637](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L637)

The pointer-events CSS property for each tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`this`

<a id="position"></a>

##### position()

###### Call Signature

> **position**(): (`d`: `DataPoint`, `i?`: `number`) => `HTMLElement` \| `number`[]

Defined in: [components/Tooltip.ts:658](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L658)

The position of each tooltip. Can be an HTMLElement to anchor to, a selection string, or coordinate points in reference to the client viewport (not the overall page).

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `HTMLElement` \| `number`[]

###### Example

```ts
function value(d) {
return [d.x, d.y];
}
```

###### Call Signature

> **position**(`_`: `string` \| `HTMLElement` \| `number`[] \| ((`d`: `DataPoint`, `i?`: `number`) => `HTMLElement` \| `number`[])): `this`

Defined in: [components/Tooltip.ts:659](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L659)

The position of each tooltip. Can be an HTMLElement to anchor to, a selection string, or coordinate points in reference to the client viewport (not the overall page).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `HTMLElement` \| `number`[] \| ((`d`: `DataPoint`, `i?`: `number`) => `HTMLElement` \| `number`[]) |

###### Returns

`this`

###### Example

```ts
function value(d) {
return [d.x, d.y];
}
```

<a id="shapeconfig-37"></a>

##### shapeConfig()

###### Call Signature

> **shapeConfig**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L225)

Configuration object with key/value pairs applied as method calls on each shape.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`BaseClass`](#baseclass).[`shapeConfig`](#shapeconfig-9)

###### Call Signature

> **shapeConfig**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:226](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L226)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`shapeConfig`](#shapeconfig-9)

<a id="tablestyle"></a>

##### tableStyle()

###### Call Signature

> **tableStyle**(): `Record`\<`string`, `string`\>

Defined in: [components/Tooltip.ts:700](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L700)

CSS styles applied to the table element.

###### Returns

`Record`\<`string`, `string`\>

###### Example

```ts
{
"border-collapse": "collapse",
"border-spacing": "0",
"width": "100%"
}
```

###### Call Signature

> **tableStyle**(`_`: `Record`\<`string`, `string`\>): `this`

Defined in: [components/Tooltip.ts:701](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L701)

CSS styles applied to the table element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `string`\> |

###### Returns

`this`

###### Example

```ts
{
"border-collapse": "collapse",
"border-spacing": "0",
"width": "100%"
}
```

<a id="tbody"></a>

##### tbody()

###### Call Signature

> **tbody**(): `unknown`[]

Defined in: [components/Tooltip.ts:711](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L711)

The table body contents as an array of functions or strings.

###### Returns

`unknown`[]

###### Call Signature

> **tbody**(`_`: `unknown`[]): `this`

Defined in: [components/Tooltip.ts:712](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L712)

The table body contents as an array of functions or strings.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown`[] |

###### Returns

`this`

<a id="tbodystyle"></a>

##### tbodyStyle()

###### Call Signature

> **tbodyStyle**(): `Record`\<`string`, `string`\>

Defined in: [components/Tooltip.ts:727](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L727)

CSS styles applied to the table body element.

###### Returns

`Record`\<`string`, `string`\>

###### Example

```ts
{
"font-size": "12px",
"font-weight": "600",
"text-align": "center"
}
```

###### Call Signature

> **tbodyStyle**(`_`: `Record`\<`string`, `string`\>): `this`

Defined in: [components/Tooltip.ts:728](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L728)

CSS styles applied to the table body element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `string`\> |

###### Returns

`this`

###### Example

```ts
{
"font-size": "12px",
"font-weight": "600",
"text-align": "center"
}
```

<a id="tdstyle"></a>

##### tdStyle()

###### Call Signature

> **tdStyle**(): `Record`\<`string`, `string`\>

Defined in: [components/Tooltip.ts:840](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L840)

An object with CSS keys and values to be applied to all <td> elements inside of each <tr>.

###### Returns

`Record`\<`string`, `string`\>

###### Call Signature

> **tdStyle**(`_`: `Record`\<`string`, `string`\>): `this`

Defined in: [components/Tooltip.ts:841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L841)

An object with CSS keys and values to be applied to all <td> elements inside of each <tr>.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `string`\> |

###### Returns

`this`

<a id="thead"></a>

##### thead()

###### Call Signature

> **thead**(): `unknown`[]

Defined in: [components/Tooltip.ts:738](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L738)

The table head contents as an array of functions or strings.

###### Returns

`unknown`[]

###### Call Signature

> **thead**(`_`: `unknown`[]): `this`

Defined in: [components/Tooltip.ts:739](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L739)

The table head contents as an array of functions or strings.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `unknown`[] |

###### Returns

`this`

<a id="theadstyle"></a>

##### theadStyle()

###### Call Signature

> **theadStyle**(): `Record`\<`string`, `string`\>

Defined in: [components/Tooltip.ts:754](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L754)

CSS styles applied to the table head element.

###### Returns

`Record`\<`string`, `string`\>

###### Example

```ts
{
"font-size": "12px",
"font-weight": "600",
"text-align": "center"
}
```

###### Call Signature

> **theadStyle**(`_`: `Record`\<`string`, `string`\>): `this`

Defined in: [components/Tooltip.ts:755](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L755)

CSS styles applied to the table head element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `string`\> |

###### Returns

`this`

###### Example

```ts
{
"font-size": "12px",
"font-weight": "600",
"text-align": "center"
}
```

<a id="title-25"></a>

##### title()

###### Call Signature

> **title**(): (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

Defined in: [components/Tooltip.ts:770](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L770)

The title content accessor for each tooltip.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

###### Example

```ts
function value(d) {
return d.title || "";
}
```

###### Call Signature

> **title**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `this`

Defined in: [components/Tooltip.ts:771](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L771)

The title content accessor for each tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`this`

###### Example

```ts
function value(d) {
return d.title || "";
}
```

<a id="titlestyle"></a>

##### titleStyle()

###### Call Signature

> **titleStyle**(): `Record`\<`string`, `string`\>

Defined in: [components/Tooltip.ts:793](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L793)

CSS styles applied to the title element.

###### Returns

`Record`\<`string`, `string`\>

###### Example

```ts
{
"font-size": "14px",
"font-weight": "600",
"padding-bottom": "5px"
}
```

###### Call Signature

> **titleStyle**(`_`: `Record`\<`string`, `string`\>): `this`

Defined in: [components/Tooltip.ts:794](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L794)

CSS styles applied to the title element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `string`\> |

###### Returns

`this`

###### Example

```ts
{
"font-size": "14px",
"font-weight": "600",
"padding-bottom": "5px"
}
```

<a id="tooltipstyle"></a>

##### tooltipStyle()

###### Call Signature

> **tooltipStyle**(): `Record`\<`string`, `string`\>

Defined in: [components/Tooltip.ts:812](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L812)

Overall CSS styles applied to the tooltip container.

###### Returns

`Record`\<`string`, `string`\>

###### Example

```ts
{
"font-family": "'Inter', 'Helvetica Neue', 'HelveticaNeue', 'Helvetica', 'Arial', sans-serif",
"font-size": "14px",
"font-weight": "600",
"padding-bottom": "5px"
}
```

###### Call Signature

> **tooltipStyle**(`_`: `Record`\<`string`, `string`\>): `this`

Defined in: [components/Tooltip.ts:813](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L813)

Overall CSS styles applied to the tooltip container.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `string`\> |

###### Returns

`this`

###### Example

```ts
{
"font-family": "'Inter', 'Helvetica Neue', 'HelveticaNeue', 'Helvetica', 'Arial', sans-serif",
"font-size": "14px",
"font-weight": "600",
"padding-bottom": "5px"
}
```

<a id="translate-18"></a>

##### translate()

###### Call Signature

> **translate**(): (`d`: `string`, `locale?`: `string`) => `string`

Defined in: [utils/BaseClass.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L214)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Returns

(`d`: `string`, `locale?`: `string`) => `string`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`translate`](#translate-7)

###### Call Signature

> **translate**(`_`: (`d`: `string`, `locale?`: `string`) => `string`): `this`

Defined in: [utils/BaseClass.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L215)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `string`, `locale?`: `string`) => `string` |

###### Returns

`this`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`translate`](#translate-7)

<a id="trstyle"></a>

##### trStyle()

###### Call Signature

> **trStyle**(): `Record`\<`string`, `unknown`\>

Defined in: [components/Tooltip.ts:829](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L829)

An object with CSS keys and values to be applied to all <tr> elements inside of each <tbody>.

###### Returns

`Record`\<`string`, `unknown`\>

###### Example

```ts
{
"border-top": "1px solid rgba(0, 0, 0, 0.1)"
}
```

###### Call Signature

> **trStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [components/Tooltip.ts:830](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L830)

An object with CSS keys and values to be applied to all <tr> elements inside of each <tbody>.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Example

```ts
{
"border-top": "1px solid rgba(0, 0, 0, 0.1)"
}
```

<a id="width-30"></a>

##### width()

###### Call Signature

> **width**(): (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

Defined in: [components/Tooltip.ts:883](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L883)

The width accessor for each tooltip.

###### Returns

(`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`

###### Call Signature

> **width**(`_`: `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `this`

Defined in: [components/Tooltip.ts:884](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L884)

The width accessor for each tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| ((`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`this`

#### Properties

| Property | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="property-_arrow"></a> `_arrow` | (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint` | - | [components/Tooltip.ts:82](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L82) |
| <a id="property-_arrowstyle"></a> `_arrowStyle` | `Record`\<`string`, `string`\> | - | [components/Tooltip.ts:83](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L83) |
| <a id="property-_background"></a> `_background` | (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint` | - | [components/Tooltip.ts:84](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L84) |
| <a id="property-_body"></a> `_body` | (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint` | - | [components/Tooltip.ts:85](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L85) |
| <a id="property-_bodystyle"></a> `_bodyStyle` | `Record`\<`string`, `string`\> | - | [components/Tooltip.ts:86](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L86) |
| <a id="property-_border"></a> `_border` | (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint` | - | [components/Tooltip.ts:87](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L87) |
| <a id="property-_borderradius"></a> `_borderRadius` | (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint` | - | [components/Tooltip.ts:88](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L88) |
| <a id="property-_classname"></a> `_className` | `string` | - | [components/Tooltip.ts:89](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L89) |
| <a id="property-_configdefault-18"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | [`BaseClass`](#baseclass).[`_configDefault`](#property-_configdefault-7) | [utils/BaseClass.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L69) |
| <a id="property-_data-18"></a> `_data` | `DataPoint`[] | - | [components/Tooltip.ts:90](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L90) |
| <a id="property-_footer"></a> `_footer` | (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint` | - | [components/Tooltip.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L91) |
| <a id="property-_footerstyle"></a> `_footerStyle` | `Record`\<`string`, `string`\> | - | [components/Tooltip.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L92) |
| <a id="property-_height-12"></a> `_height` | (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint` | - | [components/Tooltip.ts:93](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L93) |
| <a id="property-_id-10"></a> `_id` | (`d`: `DataPoint`, `i`: `number`) => `string` | - | [components/Tooltip.ts:94](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L94) |
| <a id="property-_locale-18"></a> `_locale` | `string` | [`BaseClass`](#baseclass).[`_locale`](#property-_locale-7) | [utils/BaseClass.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L64) |
| <a id="property-_maxwidth"></a> `_maxWidth` | (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint` | - | [components/Tooltip.ts:112](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L112) |
| <a id="property-_minwidth"></a> `_minWidth` | (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint` | - | [components/Tooltip.ts:113](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L113) |
| <a id="property-_offset"></a> `_offset` | (`d`: `DataPoint`, `i?`: `number`) => `number` | - | [components/Tooltip.ts:96](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L96) |
| <a id="property-_on-18"></a> `_on` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | [`BaseClass`](#baseclass).[`_on`](#property-_on-7) | [utils/BaseClass.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L65) |
| <a id="property-_padding-9"></a> `_padding` | (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint` | - | [components/Tooltip.ts:97](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L97) |
| <a id="property-_parent-18"></a> `_parent` | `Record`\<`string`, `unknown`\> | [`BaseClass`](#baseclass).[`_parent`](#property-_parent-7) | [utils/BaseClass.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L66) |
| <a id="property-_pointerevents-9"></a> `_pointerEvents` | (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint` | - | [components/Tooltip.ts:98](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L98) |
| <a id="property-_position-6"></a> `_position` | (`d`: `DataPoint`, `i?`: `number`) => `HTMLElement` \| `number`[] | - | [components/Tooltip.ts:100](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L100) |
| <a id="property-_shapeconfig-18"></a> `_shapeConfig?` | [`D3plusConfig`](#d3plusconfig) | [`BaseClass`](#baseclass).[`_shapeConfig`](#property-_shapeconfig-7) | [utils/BaseClass.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L70) |
| <a id="property-_tablestyle"></a> `_tableStyle` | `Record`\<`string`, `string`\> | - | [components/Tooltip.ts:101](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L101) |
| <a id="property-_tbody"></a> `_tbody` | `unknown`[] | - | [components/Tooltip.ts:102](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L102) |
| <a id="property-_tbodystyle"></a> `_tbodyStyle` | `Record`\<`string`, `string`\> | - | [components/Tooltip.ts:103](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L103) |
| <a id="property-_tdstyle"></a> `_tdStyle` | `Record`\<`string`, `string`\> | - | [components/Tooltip.ts:111](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L111) |
| <a id="property-_thead"></a> `_thead` | `unknown`[] | - | [components/Tooltip.ts:104](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L104) |
| <a id="property-_theadstyle"></a> `_theadStyle` | `Record`\<`string`, `string`\> | - | [components/Tooltip.ts:105](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L105) |
| <a id="property-_title-7"></a> `_title` | (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint` | - | [components/Tooltip.ts:106](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L106) |
| <a id="property-_titlestyle"></a> `_titleStyle` | `Record`\<`string`, `string`\> | - | [components/Tooltip.ts:107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L107) |
| <a id="property-_tooltiprefs"></a> `_tooltipRefs` | `Record`\<`string`, \{ `arrowDistance`: `number`; `arrowEl`: `HTMLElement`; `arrowHeight`: `number`; `reference`: `VirtualElement` \| `HTMLElement`; `tooltip`: `HTMLElement`; \}\> | - | [components/Tooltip.ts:99](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L99) |
| <a id="property-_tooltipstyle"></a> `_tooltipStyle` | `Record`\<`string`, `string`\> | - | [components/Tooltip.ts:108](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L108) |
| <a id="property-_translate-18"></a> `_translate` | (`d`: `string`, `locale?`: `string`) => `string` | [`BaseClass`](#baseclass).[`_translate`](#property-_translate-7) | [utils/BaseClass.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L67) |
| <a id="property-_trstyle"></a> `_trStyle` | `Record`\<`string`, `unknown`\> | - | [components/Tooltip.ts:110](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L110) |
| <a id="property-_uuid-18"></a> `_uuid` | `string` | [`BaseClass`](#baseclass).[`_uuid`](#property-_uuid-7) | [utils/BaseClass.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L68) |
| <a id="property-_width-12"></a> `_width` | (`d`: `DataPoint`, `i?`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint` | - | [components/Tooltip.ts:114](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/components/Tooltip.ts#L114) |

***

<a id="tree"></a>

### Tree

Defined in: [charts/Tree.ts:19](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Tree.ts#L19)

Uses d3's [tree layout](https://github.com/d3/d3-hierarchy#tree) to create a tidy tree chart based on an array of data.

#### Extends

- [`Viz`](#viz)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-27"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`active`](#active-29)

<a id="aggs-18"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`aggs`](#aggs-20)

<a id="ariahidden-19"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`ariaHidden`](#ariahidden-21)

<a id="attribution-18"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`attribution`](#attribution-20)

<a id="attributionstyle-18"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`attributionStyle`](#attributionstyle-20)

<a id="backconfig-18"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`backConfig`](#backconfig-20)

<a id="cache-18"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`cache`](#cache-20)

<a id="color-19"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`color`](#color-21)

<a id="colorscale-19"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`colorScale`](#colorscale-21)

<a id="colorscaleconfig-19"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`colorScaleConfig`](#colorscaleconfig-21)

<a id="colorscalemaxsize-18"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`colorScaleMaxSize`](#colorscalemaxsize-20)

<a id="colorscalepadding-19"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`colorScalePadding`](#colorscalepadding-21)

<a id="colorscaleposition-18"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`colorScalePosition`](#colorscaleposition-20)

<a id="data-37"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): `DataPoint`[] \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

`DataPoint`[] \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`data`](#data-39)

<a id="datacutoff-18"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`dataCutoff`](#datacutoff-20)

<a id="depth-18"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`depth`](#depth-20)

<a id="destroy-18"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`destroy`](#destroy-20)

<a id="detectresize-18"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`detectResize`](#detectresize-20)

<a id="detectresizedelay-18"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`detectResizeDelay`](#detectresizedelay-20)

<a id="detectvisible-18"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`detectVisible`](#detectvisible-20)

<a id="detectvisibleinterval-18"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`detectVisibleInterval`](#detectvisibleinterval-20)

<a id="discrete-25"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`discrete`](#discrete-27)

<a id="downloadbutton-18"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`downloadButton`](#downloadbutton-20)

<a id="downloadconfig-18"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`downloadConfig`](#downloadconfig-20)

<a id="downloadposition-18"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`downloadPosition`](#downloadposition-20)

<a id="duration-35"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`duration`](#duration-37)

<a id="filter-18"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`filter`](#filter-20)

<a id="fontfamily-19"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| `string`[] \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| `string`[] \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`fontFamily`](#fontfamily-21)

<a id="groupby-18"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

(`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`groupBy`](#groupby-20)

<a id="height-31"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`height`](#height-33)

<a id="hiddencolor-18"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`hiddenColor`](#hiddencolor-20)

<a id="hiddenopacity-18"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`hiddenOpacity`](#hiddenopacity-20)

<a id="hover-27"></a>

##### hover()

> **hover**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `this`

Defined in: [charts/Viz.ts:1350](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1350)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`hover`](#hover-29)

<a id="label-26"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`label`](#label-28)

<a id="legend-19"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`legend`](#legend-21)

<a id="legendconfig-20"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`legendConfig`](#legendconfig-22)

<a id="legendfilterinvert-18"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`legendFilterInvert`](#legendfilterinvert-20)

<a id="legendpadding-19"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`legendPadding`](#legendpadding-21)

<a id="legendposition-18"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| (() => `string`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| (() => `string`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`legendPosition`](#legendposition-20)

<a id="legendsort-18"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`legendSort`](#legendsort-20)

<a id="legendtooltip-18"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`legendTooltip`](#legendtooltip-20)

<a id="loadinghtml-18"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`loadingHTML`](#loadinghtml-20)

<a id="loadingmessage-18"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`loadingMessage`](#loadingmessage-20)

<a id="messagemask-18"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`messageMask`](#messagemask-20)

<a id="messagestyle-18"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`messageStyle`](#messagestyle-20)

<a id="nodatahtml-18"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`noDataHTML`](#nodatahtml-20)

<a id="nodatamessage-18"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`noDataMessage`](#nodatamessage-20)

<a id="orient-8"></a>

##### orient()

> **orient**(`_`: `any`): `any`

Defined in: [charts/Tree.ts:297](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Tree.ts#L297)

Changes the orientation of the entire Tree, either "vertical" (top to bottom) or "horizontal" (left to right).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="render-36"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`render`](#render-38)

<a id="scrollcontainer-18"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| `HTMLElement` \| `Window` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| `HTMLElement` \| `Window` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`scrollContainer`](#scrollcontainer-20)

<a id="select-36"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

`Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`select`](#select-38)

<a id="separation"></a>

##### separation()

> **separation**(`_`: `any`): `any`

Defined in: [charts/Tree.ts:312](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Tree.ts#L312)

The separation function between neighboring nodes.

From the [d3-hierarchy documentation](https://github.com/d3/d3-hierarchy#tree_separation):
> The separation accessor is used to separate neighboring nodes. The separation function is passed two nodes a and b, and must return the desired separation. The nodes are typically siblings, though the nodes may be more distantly related if the layout decides to place such nodes adjacent.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Example

```ts
function separation(a, b) {
return a.parent === b.parent ? 1 : 2;
}
```

<a id="shape-26"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`shape`](#shape-28)

<a id="shapeconfig-38"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`shapeConfig`](#shapeconfig-40)

<a id="subtitle-18"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`subtitle`](#subtitle-20)

<a id="subtitleconfig-18"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`subtitleConfig`](#subtitleconfig-20)

<a id="subtitlepadding-18"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`subtitlePadding`](#subtitlepadding-20)

<a id="svgdesc-18"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`svgDesc`](#svgdesc-20)

<a id="svgtitle-18"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`svgTitle`](#svgtitle-20)

<a id="threshold-18"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`threshold`](#threshold-20)

<a id="thresholdkey-18"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`thresholdKey`](#thresholdkey-20)

<a id="thresholdname-18"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`thresholdName`](#thresholdname-20)

<a id="time-18"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`time`](#time-20)

<a id="timefilter-18"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`timeFilter`](#timefilter-20)

<a id="timeline-19"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`timeline`](#timeline-21)

<a id="timelineconfig-19"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`timelineConfig`](#timelineconfig-21)

<a id="timelinedefault-18"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): `Date`[] \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

`Date`[] \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`timelineDefault`](#timelinedefault-20)

<a id="timelinepadding-19"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`timelinePadding`](#timelinepadding-21)

<a id="title-26"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`title`](#title-28)

<a id="titleconfig-25"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`titleConfig`](#titleconfig-27)

<a id="titlepadding-18"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`titlePadding`](#titlepadding-20)

<a id="tooltip-19"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`tooltip`](#tooltip-21)

<a id="tooltipconfig-19"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`tooltipConfig`](#tooltipconfig-21)

<a id="total-18"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`total`](#total-20)

<a id="totalconfig-18"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`totalConfig`](#totalconfig-20)

<a id="totalformat-18"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): ((`d`: `number`) => `string`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

((`d`: `number`) => `string`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`totalFormat`](#totalformat-20)

<a id="totalpadding-18"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`totalPadding`](#totalpadding-20)

<a id="width-31"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`width`](#width-33)

<a id="zoom-18"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`zoom`](#zoom-20)

<a id="zoombrushhandlesize-18"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleSize`](#zoombrushhandlesize-20)

<a id="zoombrushhandlestyle-18"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleStyle`](#zoombrushhandlestyle-20)

<a id="zoombrushselectionstyle-18"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`zoomBrushSelectionStyle`](#zoombrushselectionstyle-20)

<a id="zoomcontrolstyle-18"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyle`](#zoomcontrolstyle-20)

<a id="zoomcontrolstyleactive-18"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleActive`](#zoomcontrolstyleactive-20)

<a id="zoomcontrolstylehover-18"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleHover`](#zoomcontrolstylehover-20)

<a id="zoomfactor-18"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`zoomFactor`](#zoomfactor-20)

<a id="zoommax-18"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`zoomMax`](#zoommax-20)

<a id="zoompadding-18"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`zoomPadding`](#zoompadding-20)

<a id="zoompan-18"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`zoomPan`](#zoompan-20)

<a id="zoomscroll-18"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`Tree`](#tree)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Tree`](#tree)

###### Inherited from

[`Viz`](#viz).[`zoomScroll`](#zoomscroll-20)

***

<a id="treemap"></a>

### Treemap

Defined in: [charts/Treemap.ts:31](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Treemap.ts#L31)

Uses the [d3 treemap layout](https://github.com/mbostock/d3/wiki/Treemap-Layout) to creates SVG rectangles based on an array of data. See [this example](https://d3plus.org/examples/d3plus-hierarchy/getting-started/) for help getting started using the treemap generator.

#### Extends

- [`Viz`](#viz)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-28"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`active`](#active-29)

<a id="aggs-19"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`aggs`](#aggs-20)

<a id="ariahidden-20"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`ariaHidden`](#ariahidden-21)

<a id="attribution-19"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`attribution`](#attribution-20)

<a id="attributionstyle-19"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`attributionStyle`](#attributionstyle-20)

<a id="backconfig-19"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`backConfig`](#backconfig-20)

<a id="cache-19"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`cache`](#cache-20)

<a id="color-20"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`color`](#color-21)

<a id="colorscale-20"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`colorScale`](#colorscale-21)

<a id="colorscaleconfig-20"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`colorScaleConfig`](#colorscaleconfig-21)

<a id="colorscalemaxsize-19"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`colorScaleMaxSize`](#colorscalemaxsize-20)

<a id="colorscalepadding-20"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`colorScalePadding`](#colorscalepadding-21)

<a id="colorscaleposition-19"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| (() => `string` \| `boolean`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`colorScalePosition`](#colorscaleposition-20)

<a id="data-38"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): `DataPoint`[] \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

`DataPoint`[] \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`data`](#data-39)

<a id="datacutoff-19"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`dataCutoff`](#datacutoff-20)

<a id="depth-19"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`depth`](#depth-20)

<a id="destroy-19"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`destroy`](#destroy-20)

<a id="detectresize-19"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`detectResize`](#detectresize-20)

<a id="detectresizedelay-19"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`detectResizeDelay`](#detectresizedelay-20)

<a id="detectvisible-19"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`detectVisible`](#detectvisible-20)

<a id="detectvisibleinterval-19"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`detectVisibleInterval`](#detectvisibleinterval-20)

<a id="discrete-26"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`discrete`](#discrete-27)

<a id="downloadbutton-19"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`downloadButton`](#downloadbutton-20)

<a id="downloadconfig-19"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`downloadConfig`](#downloadconfig-20)

<a id="downloadposition-19"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`downloadPosition`](#downloadposition-20)

<a id="duration-36"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`duration`](#duration-37)

<a id="filter-19"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`filter`](#filter-20)

<a id="fontfamily-20"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| `string`[] \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| `string`[] \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`fontFamily`](#fontfamily-21)

<a id="groupby-19"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

(`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[] \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`groupBy`](#groupby-20)

<a id="height-32"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`height`](#height-33)

<a id="hiddencolor-19"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`hiddenColor`](#hiddencolor-20)

<a id="hiddenopacity-19"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`hiddenOpacity`](#hiddenopacity-20)

<a id="hover-28"></a>

##### hover()

> **hover**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `this`

Defined in: [charts/Viz.ts:1350](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1350)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`hover`](#hover-29)

<a id="label-27"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`label`](#label-28)

<a id="layoutpadding-1"></a>

##### layoutPadding()

> **layoutPadding**(`_`: `any`): `any`

Defined in: [charts/Treemap.ts:295](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Treemap.ts#L295)

The inner and outer padding.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="legend-20"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`legend`](#legend-21)

<a id="legendconfig-21"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`legendConfig`](#legendconfig-22)

<a id="legendfilterinvert-19"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`legendFilterInvert`](#legendfilterinvert-20)

<a id="legendpadding-20"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`legendPadding`](#legendpadding-21)

<a id="legendposition-19"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| (() => `string`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| (() => `string`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`legendPosition`](#legendposition-20)

<a id="legendsort-19"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`legendSort`](#legendsort-20)

<a id="legendtooltip-19"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`legendTooltip`](#legendtooltip-20)

<a id="loadinghtml-19"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`loadingHTML`](#loadinghtml-20)

<a id="loadingmessage-19"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`loadingMessage`](#loadingmessage-20)

<a id="messagemask-19"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`messageMask`](#messagemask-20)

<a id="messagestyle-19"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`messageStyle`](#messagestyle-20)

<a id="nodatahtml-19"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| ((`viz`: [`Viz`](#viz)) => `string`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`noDataHTML`](#nodatahtml-20)

<a id="nodatamessage-19"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`noDataMessage`](#nodatamessage-20)

<a id="render-37"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

###### Inherited from

[`Viz`](#viz).[`render`](#render-38)

<a id="scrollcontainer-19"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| `HTMLElement` \| `Window` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| `HTMLElement` \| `Window` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`scrollContainer`](#scrollcontainer-20)

<a id="select-37"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

`Selection`\<`BaseType`, `unknown`, `null`, `undefined`\> \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`select`](#select-38)

<a id="shape-27"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`shape`](#shape-28)

<a id="shapeconfig-39"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`shapeConfig`](#shapeconfig-40)

<a id="sort-10"></a>

##### sort()

> **sort**(`_`: `any`): `any`

Defined in: [charts/Treemap.ts:310](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Treemap.ts#L310)

Sort comparator function for the treemap layout. Defaults to descending order by the associated input data's numeric value attribute.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Example

```ts
function comparator(a, b) {
return b.value - a.value;
}
```

<a id="subtitle-19"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`subtitle`](#subtitle-20)

<a id="subtitleconfig-19"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`subtitleConfig`](#subtitleconfig-20)

<a id="subtitlepadding-19"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`subtitlePadding`](#subtitlepadding-20)

<a id="sum-1"></a>

##### sum()

> **sum**(`_`: `any`): `any`

Defined in: [charts/Treemap.ts:322](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Treemap.ts#L322)

The sum accessor used for sizing each rectangle in the treemap.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

###### Example

```ts
function sum(d) {
return d.sum;
}
```

<a id="svgdesc-19"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`svgDesc`](#svgdesc-20)

<a id="svgtitle-19"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`svgTitle`](#svgtitle-20)

<a id="threshold-19"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| ((`data`: `DataPoint`[]) => `number`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`threshold`](#threshold-20)

<a id="thresholdkey-19"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`thresholdKey`](#thresholdkey-20)

<a id="thresholdname-19"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`thresholdName`](#thresholdname-20)

<a id="tile"></a>

##### tile()

> **tile**(`_`: `any`): `any`

Defined in: [charts/Treemap.ts:335](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Treemap.ts#L335)

The tiling method used when calculating the size and position of the rectangles.

Can either be a string referring to a d3-hierarchy [tiling method](https://github.com/d3/d3-hierarchy#treemap-tiling), or a custom function in the same format.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `any` |

###### Returns

`any`

<a id="time-19"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`time`](#time-20)

<a id="timefilter-19"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`timeFilter`](#timefilter-20)

<a id="timeline-20"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`timeline`](#timeline-21)

<a id="timelineconfig-20"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`timelineConfig`](#timelineconfig-21)

<a id="timelinedefault-19"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): `Date`[] \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

`Date`[] \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`timelineDefault`](#timelinedefault-20)

<a id="timelinepadding-20"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`timelinePadding`](#timelinepadding-21)

<a id="title-27"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| ((`data`: `DataPoint`[]) => `string`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`title`](#title-28)

<a id="titleconfig-26"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`titleConfig`](#titleconfig-27)

<a id="titlepadding-19"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`titlePadding`](#titlepadding-20)

<a id="tooltip-20"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`tooltip`](#tooltip-21)

<a id="tooltipconfig-20"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`tooltipConfig`](#tooltipconfig-21)

<a id="total-19"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`total`](#total-20)

<a id="totalconfig-19"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

`Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`totalConfig`](#totalconfig-20)

<a id="totalformat-19"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): ((`d`: `number`) => `string`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

((`d`: `number`) => `string`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`totalFormat`](#totalformat-20)

<a id="totalpadding-19"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| (() => `boolean`) \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| (() => `boolean`) \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`totalPadding`](#totalpadding-20)

<a id="width-32"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`width`](#width-33)

<a id="zoom-19"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`zoom`](#zoom-20)

<a id="zoombrushhandlesize-19"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleSize`](#zoombrushhandlesize-20)

<a id="zoombrushhandlestyle-19"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`zoomBrushHandleStyle`](#zoombrushhandlestyle-20)

<a id="zoombrushselectionstyle-19"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`zoomBrushSelectionStyle`](#zoombrushselectionstyle-20)

<a id="zoomcontrolstyle-19"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyle`](#zoomcontrolstyle-20)

<a id="zoomcontrolstyleactive-19"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleActive`](#zoomcontrolstyleactive-20)

<a id="zoomcontrolstylehover-19"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| `Record`\<`string`, `unknown`\> \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`zoomControlStyleHover`](#zoomcontrolstylehover-20)

<a id="zoomfactor-19"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`zoomFactor`](#zoomfactor-20)

<a id="zoommax-19"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`zoomMax`](#zoommax-20)

<a id="zoompadding-19"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`zoomPadding`](#zoompadding-20)

<a id="zoompan-19"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`zoomPan`](#zoompan-20)

<a id="zoomscroll-19"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`Treemap`](#treemap)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Treemap`](#treemap)

###### Inherited from

[`Viz`](#viz).[`zoomScroll`](#zoomscroll-20)

***

<a id="viz"></a>

### Viz

Defined in: [charts/Viz.ts:136](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L136)

Creates an x/y plot based on an array of data. See [this example](https://d3plus.org/examples/d3plus-treemap/getting-started/) for help getting started using the treemap generator.

#### Extends

- `any`

#### Extended by

- [`Geomap`](#geomap)
- [`Matrix`](#matrix)
- [`Network`](#network)
- [`Pack`](#pack)
- [`Pie`](#pie)
- [`Plot`](#plot)
- [`Priestley`](#priestley)
- [`Radar`](#radar)
- [`RadialMatrix`](#radialmatrix)
- [`Rings`](#rings)
- [`Sankey`](#sankey)
- [`Tree`](#tree)
- [`Treemap`](#treemap)

#### Indexable

> \[`key`: `string`\]: `any`

#### Methods

<a id="active-29"></a>

##### active()

> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

Defined in: [charts/Viz.ts:967](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L967)

The active callback function for highlighting shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

<a id="aggs-20"></a>

##### aggs()

> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:983](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L983)

Custom aggregation methods for each data key.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

<a id="ariahidden-21"></a>

##### ariaHidden()

> **ariaHidden**(`_?`: `boolean`): `boolean` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:992](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L992)

The "aria-hidden" attribute of the containing SVG element. The default value is "false", but if you need to hide the SVG from screen readers set this property to "true".

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Viz`](#viz)

<a id="attribution-20"></a>

##### attribution()

> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:999](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L999)

Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Viz`](#viz)

<a id="attributionstyle-20"></a>

##### attributionStyle()

> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1008](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1008)

Configuration object for the attribution style.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

<a id="backconfig-20"></a>

##### backConfig()

> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1019](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1019)

Configuration object for the back button.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

<a id="cache-20"></a>

##### cache()

> **cache**(`_?`: `boolean`): `boolean` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1028](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1028)

Enables a lru cache that stores up to 5 previously loaded files/URLs. Helpful when constantly writing over the data array with a URL in the render function of a react component.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Viz`](#viz)

<a id="color-21"></a>

##### color()

> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

Defined in: [charts/Viz.ts:1035](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1035)

Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

<a id="colorscale-21"></a>

##### colorScale()

> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

Defined in: [charts/Viz.ts:1053](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1053)

Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

<a id="colorscaleconfig-21"></a>

##### colorScaleConfig()

> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1072](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1072)

A pass-through to the config method of ColorScale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

<a id="colorscalemaxsize-20"></a>

##### colorScaleMaxSize()

> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1107](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1107)

The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Viz`](#viz)

<a id="colorscalepadding-21"></a>

##### colorScalePadding()

> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Viz`](#viz) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1083](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1083)

Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`Viz`](#viz) \| (() => `boolean`)

<a id="colorscaleposition-20"></a>

##### colorScalePosition()

> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| [`Viz`](#viz) \| (() => `string` \| `boolean`)

Defined in: [charts/Viz.ts:1095](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1095)

Defines which side of the visualization to anchor the color scale. Acceptable values are `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| (() => `string` \| `boolean`) |

###### Returns

`string` \| `boolean` \| [`Viz`](#viz) \| (() => `string` \| `boolean`)

<a id="data-39"></a>

##### data()

> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): [`Viz`](#viz) \| `DataPoint`[]

Defined in: [charts/Viz.ts:1125](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1125)

The primary data array used to draw the visualization. The value passed should be an *Array* of objects or a *String* representing a filepath or URL to be loaded. The following filetypes are supported: `csv`, `tsv`, `txt`, and `json`.

If your data URL needs specific headers to be set, an Object with "url" and "headers" keys may also be passed.

Additionally, a custom formatting function can be passed as a second argument to this method. This custom function will be passed the data that has been loaded, as long as there are no errors. This function should return the final array of obejcts to be used as the primary data array. For example, some JSON APIs return the headers split from the data values to save bandwidth. These would need be joined using a custom formatter.

If you would like to specify certain configuration options based on the yet-to-be-loaded data, you can also return a full `config` object from the data formatter (including the new `data` array as a key in the object).

Defaults to an empty array (`[]`).

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `_?` | `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \} | - |
| `f?` | (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[] | The data array or a URL string to load data from. |

###### Returns

[`Viz`](#viz) \| `DataPoint`[]

<a id="datacutoff-20"></a>

##### dataCutoff()

> **dataCutoff**(`_?`: `number`): `number` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1150)

If the number of visible data points exceeds this number, the default hover behavior will be disabled (helpful for very large visualizations bogging down the DOM with opacity updates).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Viz`](#viz)

<a id="depth-20"></a>

##### depth()

> **depth**(`_?`: `number`): `number` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1157)

The current depth of the visualization. The value should correspond with an index in the [groupBy](#groupBy) array.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Viz`](#viz)

<a id="destroy-20"></a>

##### destroy()

> **destroy**(): `this`

Defined in: [charts/Viz.ts:957](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L957)

Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.

###### Returns

`this`

<a id="detectresize-20"></a>

##### detectResize()

> **detectResize**(`_?`: `boolean`): `boolean` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1164](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1164)

If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Viz`](#viz)

<a id="detectresizedelay-20"></a>

##### detectResizeDelay()

> **detectResizeDelay**(`_?`: `number`): `number` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1173)

When resizing the browser window, this is the millisecond delay to trigger the resize event.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Viz`](#viz)

<a id="detectvisible-20"></a>

##### detectVisible()

> **detectVisible**(`_?`: `boolean`): `boolean` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1182](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1182)

Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Viz`](#viz)

<a id="detectvisibleinterval-20"></a>

##### detectVisibleInterval()

> **detectVisibleInterval**(`_?`: `number`): `number` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1191)

The interval, in milliseconds, for checking if the visualization is visible on the page.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Viz`](#viz)

<a id="discrete-27"></a>

##### discrete()

> **discrete**(`_?`: `string`): `string` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1200)

If *value* is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Viz`](#viz)

<a id="downloadbutton-20"></a>

##### downloadButton()

> **downloadButton**(`_?`: `boolean`): `boolean` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1207)

Shows a button that allows for downloading the current visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Viz`](#viz)

<a id="downloadconfig-20"></a>

##### downloadConfig()

> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1216](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1216)

Sets specific options of the saveElement function used when downloading the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

<a id="downloadposition-20"></a>

##### downloadPosition()

> **downloadPosition**(`_?`: `string`): `string` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1225)

Defines which control group to add the download button into.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Viz`](#viz)

<a id="duration-37"></a>

##### duration()

> **duration**(`_?`: `number`): `number` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1234](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1234)

The animation duration in milliseconds.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Viz`](#viz)

<a id="filter-20"></a>

##### filter()

> **filter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

Defined in: [charts/Viz.ts:1241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1241)

A filter function applied to the data before drawing.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

<a id="fontfamily-21"></a>

##### fontFamily()

> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| [`Viz`](#viz) \| `string`[]

Defined in: [charts/Viz.ts:1250](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1250)

The font family used throughout the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `string`[] |

###### Returns

`string` \| [`Viz`](#viz) \| `string`[]

<a id="groupby-20"></a>

##### groupBy()

> **groupBy**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[]): [`Viz`](#viz) \| (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[]

Defined in: [charts/Viz.ts:1283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1283)

Defines the mapping between data and shape. The value can be a String matching a key in each data point (default is "id"), or an accessor Function that returns a unique value for each data point. Additionally, an Array of these values may be provided if the visualization supports nested hierarchies.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) \| (`string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`))[] |

###### Returns

[`Viz`](#viz) \| (`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`[]

<a id="height-33"></a>

##### height()

> **height**(`_?`: `number`): `number` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1320](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1320)

The overall height of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Viz`](#viz)

<a id="hiddencolor-20"></a>

##### hiddenColor()

> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

Defined in: [charts/Viz.ts:1327](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1327)

Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

<a id="hiddenopacity-20"></a>

##### hiddenOpacity()

> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `number`)

Defined in: [charts/Viz.ts:1338](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1338)

Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`number` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `number`)

<a id="hover-29"></a>

##### hover()

> **hover**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `this`

Defined in: [charts/Viz.ts:1350](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1350)

The hover callback function for highlighting shapes on mouseover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`this`

<a id="label-28"></a>

##### label()

> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

Defined in: [charts/Viz.ts:1386](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1386)

Accessor function or string key for the label of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

<a id="legend-21"></a>

##### legend()

> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| [`Viz`](#viz) \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)

Defined in: [charts/Viz.ts:1397](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1397)

Whether to display the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`) |

###### Returns

`boolean` \| [`Viz`](#viz) \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)

<a id="legendconfig-22"></a>

##### legendConfig()

> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1413](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1413)

Configuration object passed to the legend's config method.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

<a id="legendfilterinvert-20"></a>

##### legendFilterInvert()

> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Viz`](#viz) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1422](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1422)

Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`Viz`](#viz) \| (() => `boolean`)

<a id="legendpadding-21"></a>

##### legendPadding()

> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Viz`](#viz) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1434](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1434)

Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`Viz`](#viz) \| (() => `boolean`)

<a id="legendposition-20"></a>

##### legendPosition()

> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| [`Viz`](#viz) \| (() => `string`)

Defined in: [charts/Viz.ts:1446](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1446)

Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| (() => `string`) |

###### Returns

`string` \| [`Viz`](#viz) \| (() => `string`)

<a id="legendsort-20"></a>

##### legendSort()

> **legendSort**(`_?`: (`a`: `DataPoint`, `b`: `DataPoint`) => `number`): [`Viz`](#viz) \| ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`)

Defined in: [charts/Viz.ts:1456](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1456)

A JavaScript [sort comparator function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) used to sort the legend.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` |

###### Returns

[`Viz`](#viz) \| ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`)

<a id="legendtooltip-20"></a>

##### legendTooltip()

> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1465](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1465)

Configuration object for the legend tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

<a id="loadinghtml-20"></a>

##### loadingHTML()

> **loadingHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| [`Viz`](#viz) \| ((`viz`: [`Viz`](#viz)) => `string`)

Defined in: [charts/Viz.ts:1474](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1474)

The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| [`Viz`](#viz) \| ((`viz`: [`Viz`](#viz)) => `string`)

<a id="loadingmessage-20"></a>

##### loadingMessage()

> **loadingMessage**(`_?`: `boolean`): `boolean` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1485](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1485)

Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Viz`](#viz)

<a id="messagemask-20"></a>

##### messageMask()

> **messageMask**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1494](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1494)

The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` |

###### Returns

`string` \| `boolean` \| [`Viz`](#viz)

<a id="messagestyle-20"></a>

##### messageStyle()

> **messageStyle**(`_?`: `Record`\<`string`, `unknown`\>): [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1503](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1503)

Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

<a id="nodatahtml-20"></a>

##### noDataHTML()

> **noDataHTML**(`_?`: `string` \| ((`viz`: [`Viz`](#viz)) => `string`)): `string` \| [`Viz`](#viz) \| ((`viz`: [`Viz`](#viz)) => `string`)

Defined in: [charts/Viz.ts:1512](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1512)

The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`viz`: [`Viz`](#viz)) => `string`) |

###### Returns

`string` \| [`Viz`](#viz) \| ((`viz`: [`Viz`](#viz)) => `string`)

<a id="nodatamessage-20"></a>

##### noDataMessage()

> **noDataMessage**(`_?`: `boolean`): `boolean` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1523](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1523)

Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Viz`](#viz)

<a id="render-38"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [charts/Viz.ts:713](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L713)

Draws the visualization given the specified configuration.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

<a id="scrollcontainer-20"></a>

##### scrollContainer()

> **scrollContainer**(`_?`: `string` \| `HTMLElement` \| `Window`): `string` \| [`Viz`](#viz) \| `HTMLElement` \| `Window`

Defined in: [charts/Viz.ts:1532](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1532)

If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` \| `Window` |

###### Returns

`string` \| [`Viz`](#viz) \| `HTMLElement` \| `Window`

<a id="select-38"></a>

##### select()

> **select**(`_?`: `string` \| `HTMLElement`): [`Viz`](#viz) \| `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\>

Defined in: [charts/Viz.ts:1543](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1543)

The SVG container element as a d3 selector or DOM element. Defaults to `undefined`.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `HTMLElement` |

###### Returns

[`Viz`](#viz) \| `Selection`\<`BaseType`, `unknown`, `null`, `undefined`\>

<a id="shape-28"></a>

##### shape()

> **shape**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

Defined in: [charts/Viz.ts:1552](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1552)

Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

<a id="shapeconfig-40"></a>

##### shapeConfig()

> **shapeConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1563](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1563)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

<a id="subtitle-20"></a>

##### subtitle()

> **subtitle**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| [`Viz`](#viz) \| ((`data`: `DataPoint`[]) => `string`)

Defined in: [charts/Viz.ts:1572](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1572)

Accessor function or string for the visualization's subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| [`Viz`](#viz) \| ((`data`: `DataPoint`[]) => `string`)

<a id="subtitleconfig-20"></a>

##### subtitleConfig()

> **subtitleConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1583](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1583)

Configuration object for the subtitle.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

<a id="subtitlepadding-20"></a>

##### subtitlePadding()

> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Viz`](#viz) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1592](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1592)

Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`Viz`](#viz) \| (() => `boolean`)

<a id="svgdesc-20"></a>

##### svgDesc()

> **svgDesc**(`_?`: `string`): `string` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1604](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1604)

The description text for the SVG `<desc>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Viz`](#viz)

<a id="svgtitle-20"></a>

##### svgTitle()

> **svgTitle**(`_?`: `string`): `string` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1611](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1611)

The title text for the SVG `<title>` element, used for accessibility.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` |

###### Returns

`string` \| [`Viz`](#viz)

<a id="threshold-20"></a>

##### threshold()

> **threshold**(`_?`: `number` \| ((`data`: `DataPoint`[]) => `number`)): `number` \| [`Viz`](#viz) \| ((`data`: `DataPoint`[]) => `number`)

Defined in: [charts/Viz.ts:1618](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1618)

The threshold value for bucketing small data points together.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` \| ((`data`: `DataPoint`[]) => `number`) |

###### Returns

`number` \| [`Viz`](#viz) \| ((`data`: `DataPoint`[]) => `number`)

<a id="thresholdkey-20"></a>

##### thresholdKey()

> **thresholdKey**(`key?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

Defined in: [charts/Viz.ts:1635](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1635)

Accessor for the value used in the threshold algorithm.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) | The data key used to group values for thresholding. |

###### Returns

`string` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

<a id="thresholdname-20"></a>

##### thresholdName()

> **thresholdName**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

Defined in: [charts/Viz.ts:1651](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1651)

The label displayed for bucketed threshold items.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) |

###### Returns

`string` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)

<a id="time-20"></a>

##### time()

> **time**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

Defined in: [charts/Viz.ts:1663](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1663)

Accessor function or string key for the time dimension of each data point.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`) |

###### Returns

`string` \| `false` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)

<a id="timefilter-20"></a>

##### timeFilter()

> **timeFilter**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

Defined in: [charts/Viz.ts:1708](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1708)

A filter function that limits which time periods are shown.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`false` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

<a id="timeline-21"></a>

##### timeline()

> **timeline**(`_?`: `boolean`): `boolean` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1717](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1717)

Whether to display the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Viz`](#viz)

<a id="timelineconfig-21"></a>

##### timelineConfig()

> **timelineConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1724](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1724)

Configuration object for the timeline.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

<a id="timelinedefault-20"></a>

##### timelineDefault()

> **timelineDefault**(`_?`: `string` \| `Date` \| (`string` \| `Date`)[]): [`Viz`](#viz) \| `Date`[]

Defined in: [charts/Viz.ts:1733](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1733)

The starting time or range for the timeline. Can be a single Date/String, or an Array of 2 values representing the min and max.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `Date` \| (`string` \| `Date`)[] |

###### Returns

[`Viz`](#viz) \| `Date`[]

<a id="timelinepadding-21"></a>

##### timelinePadding()

> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Viz`](#viz) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1746](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1746)

Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`Viz`](#viz) \| (() => `boolean`)

<a id="title-28"></a>

##### title()

> **title**(`_?`: `string` \| ((`data`: `DataPoint`[]) => `string`)): `string` \| [`Viz`](#viz) \| ((`data`: `DataPoint`[]) => `string`)

Defined in: [charts/Viz.ts:1758](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1758)

Accessor function or string for the visualization's title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| ((`data`: `DataPoint`[]) => `string`) |

###### Returns

`string` \| [`Viz`](#viz) \| ((`data`: `DataPoint`[]) => `string`)

<a id="titleconfig-27"></a>

##### titleConfig()

> **titleConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1769](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1769)

Configuration object for the title.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

<a id="titlepadding-20"></a>

##### titlePadding()

> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Viz`](#viz) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1778](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1778)

Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`Viz`](#viz) \| (() => `boolean`)

<a id="tooltip-21"></a>

##### tooltip()

> **tooltip**(`_?`: `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `boolean` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

Defined in: [charts/Viz.ts:1789](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1789)

Whether to display tooltips on hover.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) |

###### Returns

`boolean` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)

<a id="tooltipconfig-21"></a>

##### tooltipConfig()

> **tooltipConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1800](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1800)

Configuration object for the tooltip.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

<a id="total-20"></a>

##### total()

> **total**(`_?`: `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `string` \| `boolean` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `number`)

Defined in: [charts/Viz.ts:1809](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1809)

Accessor function or string key for the total value displayed in the visualization.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `string` \| `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) |

###### Returns

`string` \| `boolean` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `number`)

<a id="totalconfig-20"></a>

##### totalConfig()

> **totalConfig**(`_?`: `Record`\<`string`, `unknown`\>): [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1823](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1823)

Configuration object for the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `Record`\<`string`, `unknown`\> |

###### Returns

[`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

<a id="totalformat-20"></a>

##### totalFormat()

> **totalFormat**(`_?`: (`d`: `number`) => `string`): [`Viz`](#viz) \| ((`d`: `number`) => `string`)

Defined in: [charts/Viz.ts:1832](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1832)

Formatter function for the value in the total bar.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | (`d`: `number`) => `string` |

###### Returns

[`Viz`](#viz) \| ((`d`: `number`) => `string`)

<a id="totalpadding-20"></a>

##### totalPadding()

> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Viz`](#viz) \| (() => `boolean`)

Defined in: [charts/Viz.ts:1841](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1841)

Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` \| (() => `boolean`) |

###### Returns

`boolean` \| [`Viz`](#viz) \| (() => `boolean`)

<a id="width-33"></a>

##### width()

> **width**(`_?`: `number`): `number` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1852](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1852)

The overall width of the visualization in pixels.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Viz`](#viz)

<a id="zoom-20"></a>

##### zoom()

> **zoom**(`_?`: `boolean`): `boolean` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1859](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1859)

Toggles the ability to zoom/pan the visualization. Certain parameters for zooming are required to be hooked up on a visualization by visualization basis.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Viz`](#viz)

<a id="zoombrushhandlesize-20"></a>

##### zoomBrushHandleSize()

> **zoomBrushHandleSize**(`_?`: `number`): `number` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1866](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1866)

The pixel stroke-width of the zoom brush area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Viz`](#viz)

<a id="zoombrushhandlestyle-20"></a>

##### zoomBrushHandleStyle()

> **zoomBrushHandleStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1875](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1875)

An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

<a id="zoombrushselectionstyle-20"></a>

##### zoomBrushSelectionStyle()

> **zoomBrushSelectionStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1886](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1886)

An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

<a id="zoomcontrolstyle-20"></a>

##### zoomControlStyle()

> **zoomControlStyle**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1897](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1897)

An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

<a id="zoomcontrolstyleactive-20"></a>

##### zoomControlStyleActive()

> **zoomControlStyleActive**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1908](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1908)

An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

<a id="zoomcontrolstylehover-20"></a>

##### zoomControlStyleHover()

> **zoomControlStyleHover**(`_?`: `false` \| `Record`\<`string`, `unknown`\>): `false` \| [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

Defined in: [charts/Viz.ts:1919](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1919)

An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `false` \| `Record`\<`string`, `unknown`\> |

###### Returns

`false` \| [`Viz`](#viz) \| `Record`\<`string`, `unknown`\>

<a id="zoomfactor-20"></a>

##### zoomFactor()

> **zoomFactor**(`_?`: `number`): `number` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1930](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1930)

The multiplier that is used in with the control buttons when zooming in and out.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Viz`](#viz)

<a id="zoommax-20"></a>

##### zoomMax()

> **zoomMax**(`_?`: `number`): `number` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1937](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1937)

The max zoom scale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Viz`](#viz)

<a id="zoompadding-20"></a>

##### zoomPadding()

> **zoomPadding**(`_?`: `number`): `number` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1951](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1951)

A pixel value to be used to pad all sides of a zoomed area.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `number` |

###### Returns

`number` \| [`Viz`](#viz)

<a id="zoompan-20"></a>

##### zoomPan()

> **zoomPan**(`_?`: `boolean`): `boolean` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1944](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1944)

Toggles panning.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Viz`](#viz)

<a id="zoomscroll-20"></a>

##### zoomScroll()

> **zoomScroll**(`_?`: `boolean`): `boolean` \| [`Viz`](#viz)

Defined in: [charts/Viz.ts:1960](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/charts/Viz.ts#L1960)

Toggles scroll zooming.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_?` | `boolean` |

###### Returns

`boolean` \| [`Viz`](#viz)

***

<a id="whisker"></a>

### Whisker

Defined in: [shapes/Whisker.ts:19](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L19)

Creates SVG whisker based on an array of data.

#### Extends

- [`BaseClass`](#baseclass)

#### Methods

<a id="active-30"></a>

##### active()

> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `void`

Defined in: [shapes/Whisker.ts:165](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L165)

The active highlight state for all sub-shapes in this Whisker.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` |

###### Returns

`void`

<a id="config-19"></a>

##### config()

###### Call Signature

> **config**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L91)

Methods that correspond to the key/value pairs and returns this class.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`BaseClass`](#baseclass).[`config`](#config-7)

###### Call Signature

> **config**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L92)

Methods that correspond to the key/value pairs and returns this class.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`config`](#config-7)

<a id="data-40"></a>

##### data()

###### Call Signature

> **data**(): `DataPoint`[]

Defined in: [shapes/Whisker.ts:176](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L176)

The data array used to create shapes.

###### Returns

`DataPoint`[]

###### Call Signature

> **data**(`_`: `DataPoint`[]): `this`

Defined in: [shapes/Whisker.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L177)

The data array used to create shapes.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `DataPoint`[] |

###### Returns

`this`

<a id="endpoint"></a>

##### endpoint()

###### Call Signature

> **endpoint**(): `AccessorFn`

Defined in: [shapes/Whisker.ts:185](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L185)

The endpoint shape type for each whisker.

###### Returns

`AccessorFn`

###### Call Signature

> **endpoint**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Whisker.ts:186](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L186)

The endpoint shape type for each whisker.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

<a id="endpointconfig"></a>

##### endpointConfig()

###### Call Signature

> **endpointConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Whisker.ts:196](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L196)

Configuration object for each endpoint.

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **endpointConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Whisker.ts:197](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L197)

Configuration object for each endpoint.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="hover-30"></a>

##### hover()

> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `void`

Defined in: [shapes/Whisker.ts:207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L207)

The hover highlight state for all sub-shapes in this Whisker.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` |

###### Returns

`void`

<a id="length"></a>

##### length()

###### Call Signature

> **length**(): `AccessorFn`

Defined in: [shapes/Whisker.ts:218](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L218)

Length accessor for whisker.

###### Returns

`AccessorFn`

###### Call Signature

> **length**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Whisker.ts:219](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L219)

Length accessor for whisker.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

<a id="lineconfig-1"></a>

##### lineConfig()

###### Call Signature

> **lineConfig**(): `Record`\<`string`, `unknown`\>

Defined in: [shapes/Whisker.ts:229](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L229)

Configuration object for the line shape.

###### Returns

`Record`\<`string`, `unknown`\>

###### Call Signature

> **lineConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [shapes/Whisker.ts:230](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L230)

Configuration object for the line shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

<a id="locale-19"></a>

##### locale()

###### Call Signature

> **locale**(): `string`

Defined in: [utils/BaseClass.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L156)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Returns

`string`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`BaseClass`](#baseclass).[`locale`](#locale-7)

###### Call Signature

> **locale**(`_`: `string` \| `object`): `this`

Defined in: [utils/BaseClass.ts:157](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L157)

The locale used for all text and number formatting. Supports the locales defined in [d3plus-format](https://github.com/d3plus/d3plus-format/blob/master/src/locale.js). The locale can be a complex Object, a locale code (like "en-US"), or a 2-digit language code (like "en"). If a 2-digit code is provided, the "findLocale" function is used to identify the most approximate locale.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `object` |

###### Returns

`this`

###### Example

```ts
{
        separator: "",
        suffixes: ["y", "z", "a", "f", "p", "n", "\u00b5", "m", "", "k", "M", "B", "t", "q", "Q", "Z", "Y"],
        grouping: [3],
        delimiters: {
          thousands: ",",
          decimal: "."
        },
        currency: ["$", ""]
      }
```

###### Inherited from

[`BaseClass`](#baseclass).[`locale`](#locale-7)

<a id="on-19"></a>

##### on()

###### Call Signature

> **on**(): `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

Defined in: [utils/BaseClass.ts:176](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L176)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Returns

`Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `string`): ((...`args`: `unknown`[]) => `unknown`) \| `undefined`

Defined in: [utils/BaseClass.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L177)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |

###### Returns

((...`args`: `unknown`[]) => `unknown`) \| `undefined`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `string`, `f`: (...`args`: `unknown`[]) => `unknown`): `this`

Defined in: [utils/BaseClass.ts:178](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L178)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` |
| `f` | (...`args`: `unknown`[]) => `unknown` |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

###### Call Signature

> **on**(`_`: `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:179](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L179)

Event listener for the specified event *typenames*. Mirrors the core [d3-selection](https://github.com/d3/d3-selection#selection_on) behavior.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> |

###### Returns

`this`

###### Example

```ts
new Plot
.on("click.Shape", function(d) {
console.log("data for shape clicked:", d);
})
.on("click.Legend", function(d) {
console.log("data for legend clicked:", d);
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`on`](#on-7)

<a id="orient-9"></a>

##### orient()

###### Call Signature

> **orient**(): `AccessorFn`

Defined in: [shapes/Whisker.ts:240](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L240)

The orientation of the whisker shape.

###### Returns

`AccessorFn`

###### Call Signature

> **orient**(`_`: `string` \| `AccessorFn`): `this`

Defined in: [shapes/Whisker.ts:241](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L241)

The orientation of the whisker shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `AccessorFn` |

###### Returns

`this`

<a id="parent-19"></a>

##### parent()

###### Call Signature

> **parent**(): `Record`\<`string`, `unknown`\>

Defined in: [utils/BaseClass.ts:200](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L200)

Parent config used by the wrapper.

###### Returns

`Record`\<`string`, `unknown`\>

###### Inherited from

[`BaseClass`](#baseclass).[`parent`](#parent-7)

###### Call Signature

> **parent**(`_`: `Record`\<`string`, `unknown`\>): `this`

Defined in: [utils/BaseClass.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L201)

Parent config used by the wrapper.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `Record`\<`string`, `unknown`\> |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`parent`](#parent-7)

<a id="render-39"></a>

##### render()

> **render**(`callback?`: () => `void`): `this`

Defined in: [shapes/Whisker.ts:57](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L57)

Draws the whisker.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback?` | () => `void` | Optional callback invoked after rendering completes. |

###### Returns

`this`

<a id="select-39"></a>

##### select()

###### Call Signature

> **select**(): `Selection`

Defined in: [shapes/Whisker.ts:251](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L251)

The SVG container element for this visualization. 3 selector or DOM element.

###### Returns

`Selection`

###### Call Signature

> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`

Defined in: [shapes/Whisker.ts:252](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L252)

The SVG container element for this visualization. 3 selector or DOM element.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `string` \| `HTMLElement` \| `SVGElement` \| `null` |

###### Returns

`this`

<a id="shapeconfig-41"></a>

##### shapeConfig()

###### Call Signature

> **shapeConfig**(): [`D3plusConfig`](#d3plusconfig)

Defined in: [utils/BaseClass.ts:225](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L225)

Configuration object with key/value pairs applied as method calls on each shape.

###### Returns

[`D3plusConfig`](#d3plusconfig)

###### Inherited from

[`BaseClass`](#baseclass).[`shapeConfig`](#shapeconfig-9)

###### Call Signature

> **shapeConfig**(`_`: [`D3plusConfig`](#d3plusconfig)): `this`

Defined in: [utils/BaseClass.ts:226](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L226)

Configuration object with key/value pairs applied as method calls on each shape.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | [`D3plusConfig`](#d3plusconfig) |

###### Returns

`this`

###### Inherited from

[`BaseClass`](#baseclass).[`shapeConfig`](#shapeconfig-9)

<a id="translate-19"></a>

##### translate()

###### Call Signature

> **translate**(): (`d`: `string`, `locale?`: `string`) => `string`

Defined in: [utils/BaseClass.ts:214](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L214)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Returns

(`d`: `string`, `locale?`: `string`) => `string`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`translate`](#translate-7)

###### Call Signature

> **translate**(`_`: (`d`: `string`, `locale?`: `string`) => `string`): `this`

Defined in: [utils/BaseClass.ts:215](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L215)

Defines how informational text strings should be displayed. By default, this function will try to find the string in question (which is the first argument provided to this function) inside of an internally managed translation Object. If you'd like to override to use custom text, simply pass this method your own custom formatting function.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | (`d`: `string`, `locale?`: `string`) => `string` |

###### Returns

`this`

###### Example

```ts
.translate(function(d) {
return d === "Back" ? "Get outta here" : d;
})
```

###### Inherited from

[`BaseClass`](#baseclass).[`translate`](#translate-7)

<a id="x-18"></a>

##### x()

###### Call Signature

> **x**(): `AccessorFn`

Defined in: [shapes/Whisker.ts:267](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L267)

The x position accessor for each whisker.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.x;
}
```

###### Call Signature

> **x**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Whisker.ts:268](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L268)

The x position accessor for each whisker.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.x;
}
```

<a id="y-18"></a>

##### y()

###### Call Signature

> **y**(): `AccessorFn`

Defined in: [shapes/Whisker.ts:283](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L283)

The y position accessor for each whisker.

###### Returns

`AccessorFn`

###### Example

```ts
function(d) {
return d.y;
}
```

###### Call Signature

> **y**(`_`: `number` \| `AccessorFn`): `this`

Defined in: [shapes/Whisker.ts:284](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L284)

The y position accessor for each whisker.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `_` | `number` \| `AccessorFn` |

###### Returns

`this`

###### Example

```ts
function(d) {
return d.y;
}
```

#### Properties

| Property | Type | Inherited from | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="property-_configdefault-19"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | [`BaseClass`](#baseclass).[`_configDefault`](#property-_configdefault-7) | [utils/BaseClass.ts:69](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L69) |
| <a id="property-_data-19"></a> `_data` | `DataPoint`[] | - | [shapes/Whisker.ts:27](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L27) |
| <a id="property-_endpoint"></a> `_endpoint` | `AccessorFn` | - | [shapes/Whisker.ts:20](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L20) |
| <a id="property-_endpointconfig"></a> `_endpointConfig` | `Record`\<`string`, `unknown`\> | - | [shapes/Whisker.ts:21](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L21) |
| <a id="property-_length"></a> `_length` | `AccessorFn` | - | [shapes/Whisker.ts:22](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L22) |
| <a id="property-_line"></a> `_line` | [`Line`](#line) | - | [shapes/Whisker.ts:29](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L29) |
| <a id="property-_lineconfig"></a> `_lineConfig` | `Record`\<`string`, `unknown`\> | - | [shapes/Whisker.ts:23](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L23) |
| <a id="property-_locale-19"></a> `_locale` | `string` | [`BaseClass`](#baseclass).[`_locale`](#property-_locale-7) | [utils/BaseClass.ts:64](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L64) |
| <a id="property-_on-19"></a> `_on` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | [`BaseClass`](#baseclass).[`_on`](#property-_on-7) | [utils/BaseClass.ts:65](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L65) |
| <a id="property-_orient-8"></a> `_orient` | `AccessorFn` | - | [shapes/Whisker.ts:24](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L24) |
| <a id="property-_parent-19"></a> `_parent` | `Record`\<`string`, `unknown`\> | [`BaseClass`](#baseclass).[`_parent`](#property-_parent-7) | [utils/BaseClass.ts:66](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L66) |
| <a id="property-_select-18"></a> `_select` | `Selection` | - | [shapes/Whisker.ts:28](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L28) |
| <a id="property-_shapeconfig-19"></a> `_shapeConfig?` | [`D3plusConfig`](#d3plusconfig) | [`BaseClass`](#baseclass).[`_shapeConfig`](#property-_shapeconfig-7) | [utils/BaseClass.ts:70](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L70) |
| <a id="property-_translate-19"></a> `_translate` | (`d`: `string`, `locale?`: `string`) => `string` | [`BaseClass`](#baseclass).[`_translate`](#property-_translate-7) | [utils/BaseClass.ts:67](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L67) |
| <a id="property-_uuid-19"></a> `_uuid` | `string` | [`BaseClass`](#baseclass).[`_uuid`](#property-_uuid-7) | [utils/BaseClass.ts:68](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/BaseClass.ts#L68) |
| <a id="property-_whiskerendpoint-1"></a> `_whiskerEndpoint` | ([`Rect`](#rect) \| [`Circle`](#circle))[] | - | [shapes/Whisker.ts:30](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L30) |
| <a id="property-_x-10"></a> `_x` | `AccessorFn` | - | [shapes/Whisker.ts:25](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L25) |
| <a id="property-_y-10"></a> `_y` | `AccessorFn` | - | [shapes/Whisker.ts:26](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/shapes/Whisker.ts#L26) |

## Functions

<a id="accessor"></a>

### accessor()

> **accessor**(`key`: `string`, `def?`: `string` \| `number` \| `boolean` \| `DataPoint`): (`d`: `DataPoint`) => `string` \| `number` \| `boolean` \| `DataPoint`

Defined in: [utils/accessor.ts:14](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/accessor.ts#L14)

Wraps an object key in a simple accessor function.

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `key` | `string` | The key to be returned from each Object passed to the function. |
| `def?` | `string` \| `number` \| `boolean` \| `DataPoint` | A default value to be returned if the key is not present. |

#### Returns

(`d`: `DataPoint`) => `string` \| `number` \| `boolean` \| `DataPoint`

#### Examples

```ts
accessor("id");
```

```ts
function(d) {
return d["id"];
}
```

***

<a id="configprep"></a>

### configPrep()

> **configPrep**(`this`: `VizContext`, `config?`: `ConfigObject`, `type?`: `string`, `nest?`: `string` \| `false`): `ConfigObject`

Defined in: [utils/configPrep.ts:43](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/configPrep.ts#L43)

Preps a config object for d3plus data, and optionally bubbles up a specific nested type. When using this function, you must bind a d3plus class' `this` context.

#### Parameters

| Parameter | Type | Default | Description |
| ------ | ------ | ------ | ------ |
| `this` | `VizContext` | *required* | - |
| `config` | `ConfigObject` | `...` | The configuration object to parse. |
| `type` | `string` | `"shape"` | The event classifier to user for "on" events. For example, the default event type of "shape" will apply all events in the "on" config object with that key, like "click.shape" and "mouseleave.shape", in addition to any gloval events like "click" and "mouseleave". |
| `nest` | `string` \| `false` | `false` | An optional nested key to bubble up to the parent config level. |

#### Returns

`ConfigObject`

***

<a id="constant"></a>

### constant()

> **constant**\<`T`\>(`value`: `T`): () => `T`

Defined in: [utils/constant.ts:11](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/constant.ts#L11)

Wraps non-function variables in a simple return function.

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `value` | `T` | The value to wrap in a return function. |

#### Returns

() => `T`

#### Examples

```ts
constant(42);
```

```ts
function() {
return 42;
}
```

## Variables

<a id="reset"></a>

### RESET

> `const` **RESET**: `string` = `"D3PLUS-COMMON-RESET"`

Defined in: [utils/RESET.ts:2](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/RESET.ts#L2)

String constant used to reset an individual config property.

## Interfaces

<a id="axisconfig-4"></a>

### AxisConfig

Defined in: [utils/D3plusConfig.ts:38](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L38)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="property-barconfig"></a> `barConfig?` | `Record`\<`string`, `string` \| `number`\> | [utils/D3plusConfig.ts:39](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L39) |
| <a id="property-gridconfig"></a> `gridConfig?` | `Record`\<`string`, `string` \| `number`\> | [utils/D3plusConfig.ts:40](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L40) |
| <a id="property-label"></a> `label?` | `string` | [utils/D3plusConfig.ts:41](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L41) |
| <a id="property-labeloffset"></a> `labelOffset?` | `number` \| `false` | [utils/D3plusConfig.ts:43](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L43) |
| <a id="property-labels"></a> `labels?` | `unknown`[] | [utils/D3plusConfig.ts:42](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L42) |
| <a id="property-maxsize"></a> `maxSize?` | `number` | [utils/D3plusConfig.ts:44](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L44) |
| <a id="property-scale"></a> `scale?` | `AxisScale` | [utils/D3plusConfig.ts:45](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L45) |
| <a id="property-tickformat"></a> `tickFormat?` | (`d`: `string` \| `number`) => `string` \| `number` | [utils/D3plusConfig.ts:46](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L46) |
| <a id="property-ticks"></a> `ticks?` | `unknown`[] | [utils/D3plusConfig.ts:47](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L47) |
| <a id="property-ticksize"></a> `tickSize?` | `number` | [utils/D3plusConfig.ts:48](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L48) |
| <a id="property-title"></a> `title?` | `string` | [utils/D3plusConfig.ts:49](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L49) |

***

<a id="d3plusconfig"></a>

### D3plusConfig

Defined in: [utils/D3plusConfig.ts:73](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L73)

#### Indexable

> \[`key`: `string`\]: `unknown`

Allows additional custom properties.

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="property-aggs"></a> `aggs?` | `object` | Custom aggregation functions keyed by data property. | [utils/D3plusConfig.ts:80](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L80) |
| <a id="property-barpadding"></a> `barPadding?` | `number` | Padding between bars in pixels. | [utils/D3plusConfig.ts:82](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L82) |
| <a id="property-colorscale"></a> `colorScale?` | `string` \| ((`d`: `number`) => `string`) | Color scale key or custom color function. | [utils/D3plusConfig.ts:84](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L84) |
| <a id="property-colorscaleconfig"></a> `colorScaleConfig?` | `object` | Configuration for the color scale component. | [utils/D3plusConfig.ts:86](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L86) |
| `colorScaleConfig.axisConfig?` | [`AxisConfig`](#axisconfig-4) | - | [utils/D3plusConfig.ts:87](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L87) |
| `colorScaleConfig.centered?` | `boolean` | - | [utils/D3plusConfig.ts:88](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L88) |
| `colorScaleConfig.colorMax?` | `string` | - | [utils/D3plusConfig.ts:92](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L92) |
| `colorScaleConfig.colorMid?` | `string` | - | [utils/D3plusConfig.ts:91](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L91) |
| `colorScaleConfig.colorMin?` | `string` | - | [utils/D3plusConfig.ts:90](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L90) |
| `colorScaleConfig.colors?` | `string`[] | - | [utils/D3plusConfig.ts:89](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L89) |
| `colorScaleConfig.scale?` | `AxisScale` | - | [utils/D3plusConfig.ts:93](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L93) |
| <a id="property-colorscaleposition"></a> `colorScalePosition?` | `false` \| `Position` | Position of the color scale, or false to hide it. | [utils/D3plusConfig.ts:96](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L96) |
| <a id="property-column"></a> `column?` | `string` | Column key for matrix-style layouts. | [utils/D3plusConfig.ts:98](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L98) |
| <a id="property-data"></a> `data?` | `string` \| `DataPoint`[] | Data array or URL string to load data from. | [utils/D3plusConfig.ts:75](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L75) |
| <a id="property-depth"></a> `depth?` | `number` | Active depth level for nested groupings. | [utils/D3plusConfig.ts:100](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L100) |
| <a id="property-discrete"></a> `discrete?` | `"x"` \| `"y"` | Sets orientation of main category axis. | [utils/D3plusConfig.ts:102](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L102) |
| <a id="property-fitfilter"></a> `fitFilter?` | `string` \| `number` \| ((`d`: `Record`\<`string`, `unknown`\>) => `boolean`) | Allows removing specific geographies from topojson file to improve zoom. | [utils/D3plusConfig.ts:104](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L104) |
| <a id="property-groupby"></a> `groupBy?` | `string` \| `string`[] \| ((`d`: `DataPoint`) => `string` \| `number`) \| (`d`: `DataPoint`) => `string` \| `number`[] | Grouping key(s) or accessor function(s). | [utils/D3plusConfig.ts:109](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L109) |
| <a id="property-grouppadding"></a> `groupPadding?` | `number` | Padding between groups of bars in pixels. | [utils/D3plusConfig.ts:115](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L115) |
| <a id="property-label-1"></a> `label?` | `string` \| ((...`args`: `unknown`[]) => `string`) | Label accessor for shapes. | [utils/D3plusConfig.ts:117](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L117) |
| <a id="property-legend"></a> `legend?` | `boolean` | Whether to show the legend. | [utils/D3plusConfig.ts:119](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L119) |
| <a id="property-legendconfig"></a> `legendConfig?` | `object` | Configuration for the legend component. | [utils/D3plusConfig.ts:121](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L121) |
| `legendConfig.label?` | `DataPointAccessor`\<`string`\> | - | [utils/D3plusConfig.ts:122](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L122) |
| `legendConfig.shapeConfig?` | `Record`\<`string`, `string` \| `number`\> | - | [utils/D3plusConfig.ts:123](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L123) |
| <a id="property-legendposition"></a> `legendPosition?` | `Position` | Position of the legend. | [utils/D3plusConfig.ts:126](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L126) |
| <a id="property-legendtooltip"></a> `legendTooltip?` | [`TooltipConfig`](#tooltipconfig-22) | Tooltip configuration for legend items. | [utils/D3plusConfig.ts:128](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L128) |
| <a id="property-linelabels"></a> `lineLabels?` | `boolean` | Whether to show labels on line charts. | [utils/D3plusConfig.ts:130](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L130) |
| <a id="property-loadinghtml"></a> `loadingHTML?` | `string` | Custom HTML content for the loading indicator. | [utils/D3plusConfig.ts:134](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L134) |
| <a id="property-loadingmessage"></a> `loadingMessage?` | `boolean` | Whether to show the loading message. | [utils/D3plusConfig.ts:132](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L132) |
| <a id="property-locale"></a> `locale?` | `string` | Locale code used for text and number formatting. | [utils/D3plusConfig.ts:77](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L77) |
| <a id="property-metric"></a> `metric?` | `string` | Metric key for the visualization. | [utils/D3plusConfig.ts:136](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L136) |
| <a id="property-ocean"></a> `ocean?` | `string` | Ocean color for geomaps (any CSS value including 'transparent'). | [utils/D3plusConfig.ts:138](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L138) |
| <a id="property-on"></a> `on?` | `Record`\<`string`, (`event`: `Event`) => `void`\> | Event listeners keyed by event name. | [utils/D3plusConfig.ts:140](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L140) |
| <a id="property-point"></a> `point?` | (`d`: `DataPoint`) => `number`[] | Coordinate accessor for point-based geomaps. | [utils/D3plusConfig.ts:142](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L142) |
| <a id="property-pointsize"></a> `pointSize?` | `string` \| ((`d`: `DataPoint`) => `number`) | Point size accessor for geomaps. | [utils/D3plusConfig.ts:144](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L144) |
| <a id="property-pointsizemax"></a> `pointSizeMax?` | `number` | Maximum point size for geomaps. | [utils/D3plusConfig.ts:148](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L148) |
| <a id="property-pointsizemin"></a> `pointSizeMin?` | `number` | Minimum point size for geomaps. | [utils/D3plusConfig.ts:146](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L146) |
| <a id="property-projection"></a> `projection?` | `string` \| ((`x`: `number`, `y`: `number`) => \[`number`, `number`\]) | Map projection name or function. | [utils/D3plusConfig.ts:150](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L150) |
| <a id="property-projectionpadding"></a> `projectionPadding?` | `string` \| `number` | Outer padding between the visualization edge and map shapes. | [utils/D3plusConfig.ts:152](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L152) |
| <a id="property-projectionrotate"></a> `projectionRotate?` | \[`number`, `number`\] | Rotation offset for the map projection center. | [utils/D3plusConfig.ts:154](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L154) |
| <a id="property-row"></a> `row?` | `string` | Row key for matrix-style layouts. | [utils/D3plusConfig.ts:156](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L156) |
| <a id="property-scrollcontainer"></a> `scrollContainer?` | `string` \| `Window` | Scrollable container selector for tooltip positioning. | [utils/D3plusConfig.ts:158](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L158) |
| <a id="property-shapeconfig"></a> `shapeConfig?` | `object` | Configuration for shape rendering. | [utils/D3plusConfig.ts:160](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L160) |
| `shapeConfig.duration?` | `number` | - | [utils/D3plusConfig.ts:161](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L161) |
| <a id="property-size"></a> `size?` | `string` | Size accessor key. | [utils/D3plusConfig.ts:165](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L165) |
| <a id="property-stacked"></a> `stacked?` | `boolean` | Whether to stack series. | [utils/D3plusConfig.ts:167](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L167) |
| <a id="property-stackorder"></a> `stackOrder?` | `string`[] | Custom order for stacked series. | [utils/D3plusConfig.ts:169](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L169) |
| <a id="property-sum"></a> `sum?` | `DataPointAccessor`\<`number`\> | Value accessor for treemaps and aggregation. | [utils/D3plusConfig.ts:171](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L171) |
| <a id="property-threshold"></a> `threshold?` | `number` | Threshold value for grouping small slices. | [utils/D3plusConfig.ts:173](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L173) |
| <a id="property-thresholdname"></a> `thresholdName?` | `string` | Label for the threshold group. | [utils/D3plusConfig.ts:175](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L175) |
| <a id="property-tiles"></a> `tiles?` | `boolean` | Whether to show map tiles. | [utils/D3plusConfig.ts:179](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L179) |
| <a id="property-tileurl"></a> `tileUrl?` | `string` | URL to XYZ map tiles. | [utils/D3plusConfig.ts:177](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L177) |
| <a id="property-time"></a> `time?` | `string` | Time key for temporal data. | [utils/D3plusConfig.ts:181](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L181) |
| <a id="property-title-1"></a> `title?` | `string` \| ((`data`: `DataPoint`[]) => `string`) | Chart title or title accessor function. | [utils/D3plusConfig.ts:183](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L183) |
| <a id="property-titleconfig"></a> `titleConfig?` | `Record`\<`string`, `string` \| `number`\> | CSS style configuration for the title. | [utils/D3plusConfig.ts:185](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L185) |
| <a id="property-tooltip"></a> `tooltip?` | `boolean` | Whether to show tooltips. | [utils/D3plusConfig.ts:187](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L187) |
| <a id="property-tooltipconfig"></a> `tooltipConfig?` | [`TooltipConfig`](#tooltipconfig-22) | Configuration for the tooltip component. | [utils/D3plusConfig.ts:189](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L189) |
| <a id="property-topojson"></a> `topojson?` | `string` \| `object` | Path or object for the topojson data. | [utils/D3plusConfig.ts:191](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L191) |
| <a id="property-topojsonfill"></a> `topojsonFill?` | `string` | CSS color to fill the map shapes. | [utils/D3plusConfig.ts:193](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L193) |
| <a id="property-topojsonid"></a> `topojsonId?` | (`obj`: `Record`\<`string`, `unknown`\>) => `string` | Accessor function for topojson feature IDs. | [utils/D3plusConfig.ts:195](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L195) |
| <a id="property-value"></a> `value?` | `DataPointAccessor`\<`number`\> | Value accessor for the visualization. | [utils/D3plusConfig.ts:197](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L197) |
| <a id="property-x"></a> `x?` | `string` \| `number` \| ((...`args`: `unknown`[]) => `unknown`) | Key, index, or accessor function for x-axis values. | [utils/D3plusConfig.ts:199](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L199) |
| <a id="property-xconfig"></a> `xConfig?` | [`AxisConfig`](#axisconfig-4) | Configuration for the x-axis. | [utils/D3plusConfig.ts:201](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L201) |
| <a id="property-xsort"></a> `xSort?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` | Custom sort function for x-axis values. | [utils/D3plusConfig.ts:203](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L203) |
| <a id="property-y"></a> `y?` | `string` \| `number` \| ((...`args`: `unknown`[]) => `unknown`) | Key, index, or accessor function for y-axis values. | [utils/D3plusConfig.ts:205](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L205) |
| <a id="property-yconfig"></a> `yConfig?` | [`AxisConfig`](#axisconfig-4) | Configuration for the y-axis. | [utils/D3plusConfig.ts:207](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L207) |
| <a id="property-ysort"></a> `ySort?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` | Custom sort function for y-axis values. | [utils/D3plusConfig.ts:209](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L209) |
| <a id="property-zoom"></a> `zoom?` | `false` | Set to false to disable zooming on geomaps. | [utils/D3plusConfig.ts:211](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L211) |

***

<a id="tooltipconfig-22"></a>

### TooltipConfig

Defined in: [utils/D3plusConfig.ts:52](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L52)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="property-body"></a> `body?` | `string` \| ((`d`: `DataPoint`) => `string`) | [utils/D3plusConfig.ts:54](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L54) |
| <a id="property-tbody"></a> `tbody?` | ((`d`: `DataPoint`) => \[`string`, `string`\][]) \| (`string` \| ((`d`: `DataPoint`, `i?`: `number`, `x?`: `object`) => `string`))[][] | [utils/D3plusConfig.ts:63](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L63) |
| <a id="property-thead"></a> `thead?` | ((`d`: `DataPoint`) => \[`string`, `string`\][]) \| (`string` \| ((`d`: `DataPoint`, `i?`: `number`, `x?`: `object`) => `string`))[][] | [utils/D3plusConfig.ts:55](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L55) |
| <a id="property-title-2"></a> `title?` | `string` \| ((`d`: `DataPoint`) => `string`) | [utils/D3plusConfig.ts:53](https://github.com/d3plus/d3plus/blob/fe174c3153bf379a226e4a41b6a8492a86c3a1b7/packages/core/src/utils/D3plusConfig.ts#L53) |
