@d3plus/core 4.0.0 → 4.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +303 -292
- package/es/src/charts/events/click.legend.js +1 -1
- package/es/src/charts/events/click.legend.js.map +1 -1
- package/es/src/charts/events/mousemove.legend.js +1 -1
- package/es/src/charts/events/mousemove.legend.js.map +1 -1
- package/es/src/charts/features/features.js +3 -3
- package/es/src/charts/features/features.js.map +1 -1
- package/es/src/charts/features/featuresLegend.js +1 -1
- package/es/src/charts/features/featuresLegend.js.map +1 -1
- package/es/src/charts/viz/VizBase.js.map +1 -1
- package/es/src/charts/viz/VizBaseConfig.js.map +1 -1
- package/es/src/components/TextBox.js +21 -5
- package/es/src/components/TextBox.js.map +1 -1
- package/es/src/shapes/Circle.js +12 -4
- package/es/src/shapes/Circle.js.map +1 -1
- package/es/src/shapes/buildLabelData.js +59 -4
- package/es/src/shapes/buildLabelData.js.map +1 -1
- package/es/src/utils/D3plusConfig.js.map +1 -1
- package/package.json +10 -10
- package/types/src/charts/viz/VizBase.d.ts +4 -4
- package/types/src/charts/viz/VizBaseConfig.d.ts +4 -3
- package/types/src/utils/D3plusConfig.d.ts +40 -12
- package/umd/d3plus-core.full.js +515 -264
- package/umd/d3plus-core.full.js.map +1 -1
- package/umd/d3plus-core.full.min.js +785 -699
- package/umd/d3plus-core.js +45 -16
- package/umd/d3plus-core.js.map +1 -1
- package/umd/d3plus-core.min.js +35 -12
package/README.md
CHANGED
|
@@ -7565,7 +7565,7 @@ The style to apply to active shapes.
|
|
|
7565
7565
|
|
|
7566
7566
|
> **config**(): [`CircleConfig`](#circleconfig-1)
|
|
7567
7567
|
|
|
7568
|
-
Defined in: [shapes/Circle.ts:
|
|
7568
|
+
Defined in: [shapes/Circle.ts:103](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Circle.ts#L103)
|
|
7569
7569
|
|
|
7570
7570
|
Narrowed `.config()` for Circle. Inherited surface from
|
|
7571
7571
|
`BaseClass.config()`; the override exists only to surface per-shape
|
|
@@ -7583,7 +7583,7 @@ keys (e.g. `width`/`height` for Rect) in autocomplete + type checks.
|
|
|
7583
7583
|
|
|
7584
7584
|
> **config**(`_`: `Partial`\<[`CircleConfig`](#circleconfig-1)\>): `this`
|
|
7585
7585
|
|
|
7586
|
-
Defined in: [shapes/Circle.ts:
|
|
7586
|
+
Defined in: [shapes/Circle.ts:104](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Circle.ts#L104)
|
|
7587
7587
|
|
|
7588
7588
|
Narrowed `.config()` for Circle. Inherited surface from
|
|
7589
7589
|
`BaseClass.config()`; the override exists only to surface per-shape
|
|
@@ -11789,7 +11789,7 @@ buckets this method wires, so SVG and Canvas behave identically.
|
|
|
11789
11789
|
|
|
11790
11790
|
> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)
|
|
11791
11791
|
|
|
11792
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
11792
|
+
Defined in: [charts/viz/VizBaseConfig.ts:29](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L29)
|
|
11793
11793
|
|
|
11794
11794
|
The active callback function for highlighting shapes.
|
|
11795
11795
|
|
|
@@ -11813,7 +11813,7 @@ The active callback function for highlighting shapes.
|
|
|
11813
11813
|
|
|
11814
11814
|
> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
11815
11815
|
|
|
11816
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
11816
|
+
Defined in: [charts/viz/VizBaseConfig.ts:48](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L48)
|
|
11817
11817
|
|
|
11818
11818
|
Custom aggregation methods for each data key.
|
|
11819
11819
|
|
|
@@ -11859,7 +11859,7 @@ Additionally, each config object can also contain an optional "layer" key, which
|
|
|
11859
11859
|
|
|
11860
11860
|
> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Plot`](#plot)
|
|
11861
11861
|
|
|
11862
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
11862
|
+
Defined in: [charts/viz/VizBaseConfig.ts:57](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L57)
|
|
11863
11863
|
|
|
11864
11864
|
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).
|
|
11865
11865
|
|
|
@@ -11883,7 +11883,7 @@ Sets text to be shown positioned absolute on top of the visualization in the bot
|
|
|
11883
11883
|
|
|
11884
11884
|
> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
11885
11885
|
|
|
11886
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
11886
|
+
Defined in: [charts/viz/VizBaseConfig.ts:66](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L66)
|
|
11887
11887
|
|
|
11888
11888
|
Configuration object for the attribution style.
|
|
11889
11889
|
|
|
@@ -11927,7 +11927,7 @@ Determines whether the x and y axes should have their scales persist while users
|
|
|
11927
11927
|
|
|
11928
11928
|
> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
11929
11929
|
|
|
11930
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
11930
|
+
Defined in: [charts/viz/VizBaseConfig.ts:77](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L77)
|
|
11931
11931
|
|
|
11932
11932
|
Configuration object for the back button.
|
|
11933
11933
|
|
|
@@ -11991,7 +11991,7 @@ Determines whether or not to add additional padding at the ends of x or y scales
|
|
|
11991
11991
|
|
|
11992
11992
|
> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)
|
|
11993
11993
|
|
|
11994
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
11994
|
+
Defined in: [charts/viz/VizBaseConfig.ts:86](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L86)
|
|
11995
11995
|
|
|
11996
11996
|
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.
|
|
11997
11997
|
|
|
@@ -12015,7 +12015,7 @@ Defines the main color to be used for each data point in a visualization. Can be
|
|
|
12015
12015
|
|
|
12016
12016
|
> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)
|
|
12017
12017
|
|
|
12018
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12018
|
+
Defined in: [charts/viz/VizBaseConfig.ts:104](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L104)
|
|
12019
12019
|
|
|
12020
12020
|
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.
|
|
12021
12021
|
|
|
@@ -12039,7 +12039,7 @@ Defines the value to be used for a color scale. Can be either an accessor functi
|
|
|
12039
12039
|
|
|
12040
12040
|
> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
12041
12041
|
|
|
12042
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12042
|
+
Defined in: [charts/viz/VizBaseConfig.ts:123](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L123)
|
|
12043
12043
|
|
|
12044
12044
|
A pass-through to the config method of ColorScale.
|
|
12045
12045
|
|
|
@@ -12063,7 +12063,7 @@ A pass-through to the config method of ColorScale.
|
|
|
12063
12063
|
|
|
12064
12064
|
> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`Plot`](#plot)
|
|
12065
12065
|
|
|
12066
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12066
|
+
Defined in: [charts/viz/VizBaseConfig.ts:158](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L158)
|
|
12067
12067
|
|
|
12068
12068
|
The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.
|
|
12069
12069
|
|
|
@@ -12085,9 +12085,9 @@ The maximum pixel size for drawing the color scale: width for horizontal scales
|
|
|
12085
12085
|
|
|
12086
12086
|
##### colorScalePadding()
|
|
12087
12087
|
|
|
12088
|
-
> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Plot`](#plot) \| (() => `boolean`)
|
|
12088
|
+
> **colorScalePadding**(`_?`: `boolean` \| ((`viz`: `VizBase`) => `boolean`)): `boolean` \| [`Plot`](#plot) \| ((`viz`: `VizBase`) => `boolean`)
|
|
12089
12089
|
|
|
12090
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12090
|
+
Defined in: [charts/viz/VizBaseConfig.ts:134](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L134)
|
|
12091
12091
|
|
|
12092
12092
|
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.
|
|
12093
12093
|
|
|
@@ -12095,11 +12095,11 @@ Tells the colorScale whether or not to use the internal padding defined by the v
|
|
|
12095
12095
|
|
|
12096
12096
|
| Parameter | Type |
|
|
12097
12097
|
| ------ | ------ |
|
|
12098
|
-
| `_?` | `boolean` \| (() => `boolean`) |
|
|
12098
|
+
| `_?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) |
|
|
12099
12099
|
|
|
12100
12100
|
###### Returns
|
|
12101
12101
|
|
|
12102
|
-
`boolean` \| [`Plot`](#plot) \| (() => `boolean`)
|
|
12102
|
+
`boolean` \| [`Plot`](#plot) \| ((`viz`: `VizBase`) => `boolean`)
|
|
12103
12103
|
|
|
12104
12104
|
###### Inherited from
|
|
12105
12105
|
|
|
@@ -12111,7 +12111,7 @@ Tells the colorScale whether or not to use the internal padding defined by the v
|
|
|
12111
12111
|
|
|
12112
12112
|
> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| [`Plot`](#plot) \| (() => `string` \| `boolean`)
|
|
12113
12113
|
|
|
12114
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12114
|
+
Defined in: [charts/viz/VizBaseConfig.ts:146](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L146)
|
|
12115
12115
|
|
|
12116
12116
|
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.
|
|
12117
12117
|
|
|
@@ -12229,7 +12229,7 @@ Methods that correspond to the key/value pairs and returns this class.
|
|
|
12229
12229
|
|
|
12230
12230
|
> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): [`Plot`](#plot) \| `DataPoint`[]
|
|
12231
12231
|
|
|
12232
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12232
|
+
Defined in: [charts/viz/VizBaseConfig.ts:176](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L176)
|
|
12233
12233
|
|
|
12234
12234
|
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`.
|
|
12235
12235
|
|
|
@@ -12280,7 +12280,7 @@ Tears down the visualization: disconnects the ResizeObserver and removes DOM eve
|
|
|
12280
12280
|
|
|
12281
12281
|
> **detectResize**(`_?`: `boolean`): `boolean` \| [`Plot`](#plot)
|
|
12282
12282
|
|
|
12283
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12283
|
+
Defined in: [charts/viz/VizBaseConfig.ts:204](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L204)
|
|
12284
12284
|
|
|
12285
12285
|
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.
|
|
12286
12286
|
|
|
@@ -12304,7 +12304,7 @@ If the width and/or height of a Viz is not user-defined, it is determined by the
|
|
|
12304
12304
|
|
|
12305
12305
|
> **detectResizeDelay**(`_?`: `number`): `number` \| [`Plot`](#plot)
|
|
12306
12306
|
|
|
12307
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12307
|
+
Defined in: [charts/viz/VizBaseConfig.ts:213](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L213)
|
|
12308
12308
|
|
|
12309
12309
|
When resizing the browser window, this is the millisecond delay to trigger the resize event.
|
|
12310
12310
|
|
|
@@ -12328,7 +12328,7 @@ When resizing the browser window, this is the millisecond delay to trigger the r
|
|
|
12328
12328
|
|
|
12329
12329
|
> **detectVisible**(`_?`: `boolean`): `boolean` \| [`Plot`](#plot)
|
|
12330
12330
|
|
|
12331
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12331
|
+
Defined in: [charts/viz/VizBaseConfig.ts:222](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L222)
|
|
12332
12332
|
|
|
12333
12333
|
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.
|
|
12334
12334
|
|
|
@@ -12352,7 +12352,7 @@ Toggles whether or not the Viz should try to detect if it visible in the current
|
|
|
12352
12352
|
|
|
12353
12353
|
> **detectVisibleInterval**(`_?`: `number`): `number` \| [`Plot`](#plot)
|
|
12354
12354
|
|
|
12355
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12355
|
+
Defined in: [charts/viz/VizBaseConfig.ts:231](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L231)
|
|
12356
12356
|
|
|
12357
12357
|
The interval, in milliseconds, for checking if the visualization is visible on the page.
|
|
12358
12358
|
|
|
@@ -12396,7 +12396,7 @@ When the width or height of the chart is less than or equal to this pixel value,
|
|
|
12396
12396
|
|
|
12397
12397
|
> **downloadButton**(`_?`: `boolean`): `boolean` \| [`Plot`](#plot)
|
|
12398
12398
|
|
|
12399
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12399
|
+
Defined in: [charts/viz/VizBaseConfig.ts:240](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L240)
|
|
12400
12400
|
|
|
12401
12401
|
Shows a button that allows for downloading the current visualization.
|
|
12402
12402
|
|
|
@@ -12420,7 +12420,7 @@ Shows a button that allows for downloading the current visualization.
|
|
|
12420
12420
|
|
|
12421
12421
|
> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
12422
12422
|
|
|
12423
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12423
|
+
Defined in: [charts/viz/VizBaseConfig.ts:249](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L249)
|
|
12424
12424
|
|
|
12425
12425
|
Sets specific options of the saveElement function used when downloading the visualization.
|
|
12426
12426
|
|
|
@@ -12444,7 +12444,7 @@ Sets specific options of the saveElement function used when downloading the visu
|
|
|
12444
12444
|
|
|
12445
12445
|
> **downloadPosition**(`_?`: `string`): `string` \| [`Plot`](#plot)
|
|
12446
12446
|
|
|
12447
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12447
|
+
Defined in: [charts/viz/VizBaseConfig.ts:258](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L258)
|
|
12448
12448
|
|
|
12449
12449
|
Defines which control group to add the download button into.
|
|
12450
12450
|
|
|
@@ -12468,7 +12468,7 @@ Defines which control group to add the download button into.
|
|
|
12468
12468
|
|
|
12469
12469
|
> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| [`Plot`](#plot) \| `string`[]
|
|
12470
12470
|
|
|
12471
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12471
|
+
Defined in: [charts/viz/VizBaseConfig.ts:267](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L267)
|
|
12472
12472
|
|
|
12473
12473
|
The font family used throughout the visualization.
|
|
12474
12474
|
|
|
@@ -12492,7 +12492,7 @@ The font family used throughout the visualization.
|
|
|
12492
12492
|
|
|
12493
12493
|
> **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`[]
|
|
12494
12494
|
|
|
12495
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12495
|
+
Defined in: [charts/viz/VizBaseConfig.ts:300](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L300)
|
|
12496
12496
|
|
|
12497
12497
|
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.
|
|
12498
12498
|
|
|
@@ -12536,7 +12536,7 @@ The pixel space between groups of bars.
|
|
|
12536
12536
|
|
|
12537
12537
|
> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)
|
|
12538
12538
|
|
|
12539
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12539
|
+
Defined in: [charts/viz/VizBaseConfig.ts:337](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L337)
|
|
12540
12540
|
|
|
12541
12541
|
Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).
|
|
12542
12542
|
|
|
@@ -12560,7 +12560,7 @@ Defines the color used for legend shapes when the corresponding grouping is hidd
|
|
|
12560
12560
|
|
|
12561
12561
|
> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `number`)
|
|
12562
12562
|
|
|
12563
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12563
|
+
Defined in: [charts/viz/VizBaseConfig.ts:348](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L348)
|
|
12564
12564
|
|
|
12565
12565
|
Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).
|
|
12566
12566
|
|
|
@@ -12584,7 +12584,7 @@ Defines the opacity used for legend labels when the corresponding grouping is hi
|
|
|
12584
12584
|
|
|
12585
12585
|
> **highlight**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `undefined`
|
|
12586
12586
|
|
|
12587
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12587
|
+
Defined in: [charts/viz/VizBaseConfig.ts:418](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L418)
|
|
12588
12588
|
|
|
12589
12589
|
Persistently emphasizes the data points matching the given predicate: the
|
|
12590
12590
|
matching marks keep their color while every other mark is de-emphasized to
|
|
@@ -12612,7 +12612,7 @@ standing state that survives pointer movement. Pass `false` to clear it.
|
|
|
12612
12612
|
|
|
12613
12613
|
> **hover**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `this`
|
|
12614
12614
|
|
|
12615
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12615
|
+
Defined in: [charts/viz/VizBaseConfig.ts:360](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L360)
|
|
12616
12616
|
|
|
12617
12617
|
The hover callback function for highlighting shapes on mouseover.
|
|
12618
12618
|
|
|
@@ -12636,7 +12636,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
12636
12636
|
|
|
12637
12637
|
> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)
|
|
12638
12638
|
|
|
12639
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12639
|
+
Defined in: [charts/viz/VizBaseConfig.ts:432](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L432)
|
|
12640
12640
|
|
|
12641
12641
|
Accessor function or string key for the label of each data point.
|
|
12642
12642
|
|
|
@@ -12700,7 +12700,7 @@ The behavior to be used when calculating the position and size of each shape's l
|
|
|
12700
12700
|
|
|
12701
12701
|
> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| [`Plot`](#plot) \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)
|
|
12702
12702
|
|
|
12703
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12703
|
+
Defined in: [charts/viz/VizBaseConfig.ts:443](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L443)
|
|
12704
12704
|
|
|
12705
12705
|
Whether to display the legend.
|
|
12706
12706
|
|
|
@@ -12724,7 +12724,7 @@ Whether to display the legend.
|
|
|
12724
12724
|
|
|
12725
12725
|
> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
12726
12726
|
|
|
12727
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12727
|
+
Defined in: [charts/viz/VizBaseConfig.ts:459](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L459)
|
|
12728
12728
|
|
|
12729
12729
|
Configuration object passed to the legend's config method.
|
|
12730
12730
|
|
|
@@ -12746,9 +12746,9 @@ Configuration object passed to the legend's config method.
|
|
|
12746
12746
|
|
|
12747
12747
|
##### legendFilterInvert()
|
|
12748
12748
|
|
|
12749
|
-
> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Plot`](#plot) \| (() => `boolean`)
|
|
12749
|
+
> **legendFilterInvert**(`_?`: `boolean` \| ((`viz`: `VizBase`) => `boolean`)): `boolean` \| [`Plot`](#plot) \| ((`viz`: `VizBase`) => `boolean`)
|
|
12750
12750
|
|
|
12751
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12751
|
+
Defined in: [charts/viz/VizBaseConfig.ts:468](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L468)
|
|
12752
12752
|
|
|
12753
12753
|
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.
|
|
12754
12754
|
|
|
@@ -12756,11 +12756,11 @@ Defines the click functionality of categorical legend squares. When set to false
|
|
|
12756
12756
|
|
|
12757
12757
|
| Parameter | Type |
|
|
12758
12758
|
| ------ | ------ |
|
|
12759
|
-
| `_?` | `boolean` \| (() => `boolean`) |
|
|
12759
|
+
| `_?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) |
|
|
12760
12760
|
|
|
12761
12761
|
###### Returns
|
|
12762
12762
|
|
|
12763
|
-
`boolean` \| [`Plot`](#plot) \| (() => `boolean`)
|
|
12763
|
+
`boolean` \| [`Plot`](#plot) \| ((`viz`: `VizBase`) => `boolean`)
|
|
12764
12764
|
|
|
12765
12765
|
###### Inherited from
|
|
12766
12766
|
|
|
@@ -12770,9 +12770,9 @@ Defines the click functionality of categorical legend squares. When set to false
|
|
|
12770
12770
|
|
|
12771
12771
|
##### legendPadding()
|
|
12772
12772
|
|
|
12773
|
-
> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Plot`](#plot) \| (() => `boolean`)
|
|
12773
|
+
> **legendPadding**(`_?`: `boolean` \| ((`viz`: `VizBase`) => `boolean`)): `boolean` \| [`Plot`](#plot) \| ((`viz`: `VizBase`) => `boolean`)
|
|
12774
12774
|
|
|
12775
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12775
|
+
Defined in: [charts/viz/VizBaseConfig.ts:480](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L480)
|
|
12776
12776
|
|
|
12777
12777
|
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.
|
|
12778
12778
|
|
|
@@ -12780,11 +12780,11 @@ Tells the legend whether or not to use the internal padding defined by the visua
|
|
|
12780
12780
|
|
|
12781
12781
|
| Parameter | Type |
|
|
12782
12782
|
| ------ | ------ |
|
|
12783
|
-
| `_?` | `boolean` \| (() => `boolean`) |
|
|
12783
|
+
| `_?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) |
|
|
12784
12784
|
|
|
12785
12785
|
###### Returns
|
|
12786
12786
|
|
|
12787
|
-
`boolean` \| [`Plot`](#plot) \| (() => `boolean`)
|
|
12787
|
+
`boolean` \| [`Plot`](#plot) \| ((`viz`: `VizBase`) => `boolean`)
|
|
12788
12788
|
|
|
12789
12789
|
###### Inherited from
|
|
12790
12790
|
|
|
@@ -12796,7 +12796,7 @@ Tells the legend whether or not to use the internal padding defined by the visua
|
|
|
12796
12796
|
|
|
12797
12797
|
> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| [`Plot`](#plot) \| (() => `string`)
|
|
12798
12798
|
|
|
12799
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12799
|
+
Defined in: [charts/viz/VizBaseConfig.ts:492](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L492)
|
|
12800
12800
|
|
|
12801
12801
|
Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.
|
|
12802
12802
|
|
|
@@ -12820,7 +12820,7 @@ Defines which side of the visualization to anchor the legend. Expected values ar
|
|
|
12820
12820
|
|
|
12821
12821
|
> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
12822
12822
|
|
|
12823
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
12823
|
+
Defined in: [charts/viz/VizBaseConfig.ts:502](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L502)
|
|
12824
12824
|
|
|
12825
12825
|
Configuration object for the legend tooltip.
|
|
12826
12826
|
|
|
@@ -13645,7 +13645,7 @@ Configuration object for the subtitle.
|
|
|
13645
13645
|
|
|
13646
13646
|
##### subtitlePadding()
|
|
13647
13647
|
|
|
13648
|
-
> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Plot`](#plot) \| (() => `boolean`)
|
|
13648
|
+
> **subtitlePadding**(`_?`: `boolean` \| ((`viz`: `VizBase`) => `boolean`)): `boolean` \| [`Plot`](#plot) \| ((`viz`: `VizBase`) => `boolean`)
|
|
13649
13649
|
|
|
13650
13650
|
Defined in: [charts/viz/VizBase.ts:144](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBase.ts#L144)
|
|
13651
13651
|
|
|
@@ -13655,11 +13655,11 @@ Tells the subtitle whether or not to use the internal padding defined by the vis
|
|
|
13655
13655
|
|
|
13656
13656
|
| Parameter | Type |
|
|
13657
13657
|
| ------ | ------ |
|
|
13658
|
-
| `_?` | `boolean` \| (() => `boolean`) |
|
|
13658
|
+
| `_?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) |
|
|
13659
13659
|
|
|
13660
13660
|
###### Returns
|
|
13661
13661
|
|
|
13662
|
-
`boolean` \| [`Plot`](#plot) \| (() => `boolean`)
|
|
13662
|
+
`boolean` \| [`Plot`](#plot) \| ((`viz`: `VizBase`) => `boolean`)
|
|
13663
13663
|
|
|
13664
13664
|
###### Inherited from
|
|
13665
13665
|
|
|
@@ -13813,7 +13813,7 @@ The starting time or range for the timeline. Can be a single Date/String, or an
|
|
|
13813
13813
|
|
|
13814
13814
|
##### timelinePadding()
|
|
13815
13815
|
|
|
13816
|
-
> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Plot`](#plot) \| (() => `boolean`)
|
|
13816
|
+
> **timelinePadding**(`_?`: `boolean` \| ((`viz`: `VizBase`) => `boolean`)): `boolean` \| [`Plot`](#plot) \| ((`viz`: `VizBase`) => `boolean`)
|
|
13817
13817
|
|
|
13818
13818
|
Defined in: [charts/viz/VizBase.ts:268](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBase.ts#L268)
|
|
13819
13819
|
|
|
@@ -13823,11 +13823,11 @@ Tells the timeline whether or not to use the internal padding defined by the vis
|
|
|
13823
13823
|
|
|
13824
13824
|
| Parameter | Type |
|
|
13825
13825
|
| ------ | ------ |
|
|
13826
|
-
| `_?` | `boolean` \| (() => `boolean`) |
|
|
13826
|
+
| `_?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) |
|
|
13827
13827
|
|
|
13828
13828
|
###### Returns
|
|
13829
13829
|
|
|
13830
|
-
`boolean` \| [`Plot`](#plot) \| (() => `boolean`)
|
|
13830
|
+
`boolean` \| [`Plot`](#plot) \| ((`viz`: `VizBase`) => `boolean`)
|
|
13831
13831
|
|
|
13832
13832
|
###### Inherited from
|
|
13833
13833
|
|
|
@@ -13885,7 +13885,7 @@ Configuration object for the title.
|
|
|
13885
13885
|
|
|
13886
13886
|
##### titlePadding()
|
|
13887
13887
|
|
|
13888
|
-
> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Plot`](#plot) \| (() => `boolean`)
|
|
13888
|
+
> **titlePadding**(`_?`: `boolean` \| ((`viz`: `VizBase`) => `boolean`)): `boolean` \| [`Plot`](#plot) \| ((`viz`: `VizBase`) => `boolean`)
|
|
13889
13889
|
|
|
13890
13890
|
Defined in: [charts/viz/VizBase.ts:300](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBase.ts#L300)
|
|
13891
13891
|
|
|
@@ -13895,11 +13895,11 @@ Tells the title whether or not to use the internal padding defined by the visual
|
|
|
13895
13895
|
|
|
13896
13896
|
| Parameter | Type |
|
|
13897
13897
|
| ------ | ------ |
|
|
13898
|
-
| `_?` | `boolean` \| (() => `boolean`) |
|
|
13898
|
+
| `_?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) |
|
|
13899
13899
|
|
|
13900
13900
|
###### Returns
|
|
13901
13901
|
|
|
13902
|
-
`boolean` \| [`Plot`](#plot) \| (() => `boolean`)
|
|
13902
|
+
`boolean` \| [`Plot`](#plot) \| ((`viz`: `VizBase`) => `boolean`)
|
|
13903
13903
|
|
|
13904
13904
|
###### Inherited from
|
|
13905
13905
|
|
|
@@ -14049,7 +14049,7 @@ Formatter function for the value in the total bar.
|
|
|
14049
14049
|
|
|
14050
14050
|
##### totalPadding()
|
|
14051
14051
|
|
|
14052
|
-
> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Plot`](#plot) \| (() => `boolean`)
|
|
14052
|
+
> **totalPadding**(`_?`: `boolean` \| ((`viz`: `VizBase`) => `boolean`)): `boolean` \| [`Plot`](#plot) \| ((`viz`: `VizBase`) => `boolean`)
|
|
14053
14053
|
|
|
14054
14054
|
Defined in: [charts/viz/VizBase.ts:363](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBase.ts#L363)
|
|
14055
14055
|
|
|
@@ -14059,11 +14059,11 @@ Tells the total whether or not to use the internal padding defined by the visual
|
|
|
14059
14059
|
|
|
14060
14060
|
| Parameter | Type |
|
|
14061
14061
|
| ------ | ------ |
|
|
14062
|
-
| `_?` | `boolean` \| (() => `boolean`) |
|
|
14062
|
+
| `_?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) |
|
|
14063
14063
|
|
|
14064
14064
|
###### Returns
|
|
14065
14065
|
|
|
14066
|
-
`boolean` \| [`Plot`](#plot) \| (() => `boolean`)
|
|
14066
|
+
`boolean` \| [`Plot`](#plot) \| ((`viz`: `VizBase`) => `boolean`)
|
|
14067
14067
|
|
|
14068
14068
|
###### Inherited from
|
|
14069
14069
|
|
|
@@ -16161,7 +16161,7 @@ return d === "Back" ? "Get outta here" : d;
|
|
|
16161
16161
|
|
|
16162
16162
|
### TextBox
|
|
16163
16163
|
|
|
16164
|
-
Defined in: [components/TextBox.ts:
|
|
16164
|
+
Defined in: [components/TextBox.ts:411](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/TextBox.ts#L411)
|
|
16165
16165
|
|
|
16166
16166
|
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.
|
|
16167
16167
|
|
|
@@ -16225,7 +16225,7 @@ Methods that correspond to the key/value pairs and returns this class.
|
|
|
16225
16225
|
|
|
16226
16226
|
> **data**(): `DataPoint`[]
|
|
16227
16227
|
|
|
16228
|
-
Defined in: [components/TextBox.ts:
|
|
16228
|
+
Defined in: [components/TextBox.ts:587](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/TextBox.ts#L587)
|
|
16229
16229
|
|
|
16230
16230
|
The data array used to draw text boxes. A text box will be drawn for each object in the array.
|
|
16231
16231
|
|
|
@@ -16237,7 +16237,7 @@ The data array used to draw text boxes. A text box will be drawn for each object
|
|
|
16237
16237
|
|
|
16238
16238
|
> **data**(`_`: `DataPoint`[]): `this`
|
|
16239
16239
|
|
|
16240
|
-
Defined in: [components/TextBox.ts:
|
|
16240
|
+
Defined in: [components/TextBox.ts:588](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/TextBox.ts#L588)
|
|
16241
16241
|
|
|
16242
16242
|
The data array used to draw text boxes. A text box will be drawn for each object in the array.
|
|
16243
16243
|
|
|
@@ -16259,7 +16259,7 @@ The data array used to draw text boxes. A text box will be drawn for each object
|
|
|
16259
16259
|
|
|
16260
16260
|
> **html**(): `false` \| `Record`\<`string`, `string`\>
|
|
16261
16261
|
|
|
16262
|
-
Defined in: [components/TextBox.ts:
|
|
16262
|
+
Defined in: [components/TextBox.ts:596](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/TextBox.ts#L596)
|
|
16263
16263
|
|
|
16264
16264
|
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
|
|
16265
16265
|
|
|
@@ -16271,7 +16271,7 @@ Configures the ability to render simple HTML tags. Defaults to supporting `<b>`,
|
|
|
16271
16271
|
|
|
16272
16272
|
> **html**(`_`: `boolean` \| `Record`\<`string`, `string`\>): `this`
|
|
16273
16273
|
|
|
16274
|
-
Defined in: [components/TextBox.ts:
|
|
16274
|
+
Defined in: [components/TextBox.ts:597](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/TextBox.ts#L597)
|
|
16275
16275
|
|
|
16276
16276
|
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
|
|
16277
16277
|
|
|
@@ -16540,7 +16540,7 @@ Parent config used by the wrapper.
|
|
|
16540
16540
|
|
|
16541
16541
|
> **render**(`callback?`: (...`args`: `unknown`[]) => `unknown`): `this`
|
|
16542
16542
|
|
|
16543
|
-
Defined in: [components/TextBox.ts:
|
|
16543
|
+
Defined in: [components/TextBox.ts:513](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/TextBox.ts#L513)
|
|
16544
16544
|
|
|
16545
16545
|
Renders the text boxes. If a *callback* is specified, it will be called once the shapes are done drawing.
|
|
16546
16546
|
|
|
@@ -16562,7 +16562,7 @@ Renders the text boxes. If a *callback* is specified, it will be called once the
|
|
|
16562
16562
|
|
|
16563
16563
|
> **select**(): `Selection`
|
|
16564
16564
|
|
|
16565
|
-
Defined in: [components/TextBox.ts:
|
|
16565
|
+
Defined in: [components/TextBox.ts:609](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/TextBox.ts#L609)
|
|
16566
16566
|
|
|
16567
16567
|
The SVG container element as a d3 selector or DOM element. If not specified, an SVG element will be added to the page.
|
|
16568
16568
|
|
|
@@ -16574,7 +16574,7 @@ The SVG container element as a d3 selector or DOM element. If not specified, an
|
|
|
16574
16574
|
|
|
16575
16575
|
> **select**(`_`: `string` \| `HTMLElement`): `this`
|
|
16576
16576
|
|
|
16577
|
-
Defined in: [components/TextBox.ts:
|
|
16577
|
+
Defined in: [components/TextBox.ts:610](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/TextBox.ts#L610)
|
|
16578
16578
|
|
|
16579
16579
|
The SVG container element as a d3 selector or DOM element. If not specified, an SVG element will be added to the page.
|
|
16580
16580
|
|
|
@@ -16636,7 +16636,7 @@ Configuration object with key/value pairs applied as method calls on each shape.
|
|
|
16636
16636
|
|
|
16637
16637
|
> **toScene**(): `GroupNode`
|
|
16638
16638
|
|
|
16639
|
-
Defined in: [components/TextBox.ts:
|
|
16639
|
+
Defined in: [components/TextBox.ts:448](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/TextBox.ts#L448)
|
|
16640
16640
|
|
|
16641
16641
|
Produces a backend-agnostic scene graph for the text boxes, reusing the same
|
|
16642
16642
|
layout (_textData) and per-line positioning render() applies to the DOM.
|
|
@@ -16708,8 +16708,8 @@ return d === "Back" ? "Get outta here" : d;
|
|
|
16708
16708
|
| Property | Type | Description | Inherited from | Defined in |
|
|
16709
16709
|
| ------ | ------ | ------ | ------ | ------ |
|
|
16710
16710
|
| <a id="property-_configdefault-17"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | - | [`BaseClass`](#baseclass).[`_configDefault`](#property-_configdefault-7) | [utils/BaseClass.ts:82](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L82) |
|
|
16711
|
-
| <a id="property-_data-16"></a> `_data` | `DataPoint`[] | - | - | [components/TextBox.ts:
|
|
16712
|
-
| <a id="property-_select-16"></a> `_select` | `Selection` | - | - | [components/TextBox.ts:
|
|
16711
|
+
| <a id="property-_data-16"></a> `_data` | `DataPoint`[] | - | - | [components/TextBox.ts:417](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/TextBox.ts#L417) |
|
|
16712
|
+
| <a id="property-_select-16"></a> `_select` | `Selection` | - | - | [components/TextBox.ts:416](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/TextBox.ts#L416) |
|
|
16713
16713
|
| <a id="property-_uuid-17"></a> `_uuid` | `string` | - | [`BaseClass`](#baseclass).[`_uuid`](#property-_uuid-7) | [utils/BaseClass.ts:81](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L81) |
|
|
16714
16714
|
| <a id="property-ctx-17"></a> `ctx` | `Record`\<`string`, `unknown`\> | Chart-internal scratch (d3 layout instances, computed derived state). | [`BaseClass`](#baseclass).[`ctx`](#property-ctx-7) | [utils/BaseClass.ts:79](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L79) |
|
|
16715
16715
|
| <a id="property-schema-18"></a> `schema` | `Record`\<`string`, `any`\> | Post-coercion fluent storage (`.sum(...)`, `.x(...)`, …). `any` is deliberate and load-bearing: `installFluent` coerces accessor/const fields into functions, so call sites invoke `schema.fill(d, i)` and index `schema.groupBy[i]`. It is NOT `D3plusConfig` (that describes the pre-coercion user input). Typing it as a coerced `ResolvedSchema` interface is the only way to drop the `any`; until then it stays. | [`BaseClass`](#baseclass).[`schema`](#property-schema-7) | [utils/BaseClass.ts:77](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L77) |
|
|
@@ -18580,7 +18580,7 @@ intermediate paints are wasted — collapse them to one rAF-scheduled draw.
|
|
|
18580
18580
|
|
|
18581
18581
|
> **active**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)
|
|
18582
18582
|
|
|
18583
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
18583
|
+
Defined in: [charts/viz/VizBaseConfig.ts:29](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L29)
|
|
18584
18584
|
|
|
18585
18585
|
The active callback function for highlighting shapes.
|
|
18586
18586
|
|
|
@@ -18604,7 +18604,7 @@ The active callback function for highlighting shapes.
|
|
|
18604
18604
|
|
|
18605
18605
|
> **aggs**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Viz`](#viz)
|
|
18606
18606
|
|
|
18607
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
18607
|
+
Defined in: [charts/viz/VizBaseConfig.ts:48](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L48)
|
|
18608
18608
|
|
|
18609
18609
|
Custom aggregation methods for each data key.
|
|
18610
18610
|
|
|
@@ -18628,7 +18628,7 @@ Custom aggregation methods for each data key.
|
|
|
18628
18628
|
|
|
18629
18629
|
> **attribution**(`_?`: `string` \| `boolean`): `string` \| `boolean` \| [`Viz`](#viz)
|
|
18630
18630
|
|
|
18631
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
18631
|
+
Defined in: [charts/viz/VizBaseConfig.ts:57](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L57)
|
|
18632
18632
|
|
|
18633
18633
|
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).
|
|
18634
18634
|
|
|
@@ -18652,7 +18652,7 @@ Sets text to be shown positioned absolute on top of the visualization in the bot
|
|
|
18652
18652
|
|
|
18653
18653
|
> **attributionStyle**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Viz`](#viz)
|
|
18654
18654
|
|
|
18655
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
18655
|
+
Defined in: [charts/viz/VizBaseConfig.ts:66](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L66)
|
|
18656
18656
|
|
|
18657
18657
|
Configuration object for the attribution style.
|
|
18658
18658
|
|
|
@@ -18676,7 +18676,7 @@ Configuration object for the attribution style.
|
|
|
18676
18676
|
|
|
18677
18677
|
> **backConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Viz`](#viz)
|
|
18678
18678
|
|
|
18679
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
18679
|
+
Defined in: [charts/viz/VizBaseConfig.ts:77](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L77)
|
|
18680
18680
|
|
|
18681
18681
|
Configuration object for the back button.
|
|
18682
18682
|
|
|
@@ -18700,7 +18700,7 @@ Configuration object for the back button.
|
|
|
18700
18700
|
|
|
18701
18701
|
> **color**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)
|
|
18702
18702
|
|
|
18703
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
18703
|
+
Defined in: [charts/viz/VizBaseConfig.ts:86](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L86)
|
|
18704
18704
|
|
|
18705
18705
|
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.
|
|
18706
18706
|
|
|
@@ -18724,7 +18724,7 @@ Defines the main color to be used for each data point in a visualization. Can be
|
|
|
18724
18724
|
|
|
18725
18725
|
> **colorScale**(`_?`: `string` \| `false` \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)): `string` \| `false` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `string` \| `number` \| `boolean` \| `DataPoint`)
|
|
18726
18726
|
|
|
18727
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
18727
|
+
Defined in: [charts/viz/VizBaseConfig.ts:104](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L104)
|
|
18728
18728
|
|
|
18729
18729
|
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.
|
|
18730
18730
|
|
|
@@ -18748,7 +18748,7 @@ Defines the value to be used for a color scale. Can be either an accessor functi
|
|
|
18748
18748
|
|
|
18749
18749
|
> **colorScaleConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Viz`](#viz)
|
|
18750
18750
|
|
|
18751
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
18751
|
+
Defined in: [charts/viz/VizBaseConfig.ts:123](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L123)
|
|
18752
18752
|
|
|
18753
18753
|
A pass-through to the config method of ColorScale.
|
|
18754
18754
|
|
|
@@ -18772,7 +18772,7 @@ A pass-through to the config method of ColorScale.
|
|
|
18772
18772
|
|
|
18773
18773
|
> **colorScaleMaxSize**(`_?`: `number`): `number` \| [`Viz`](#viz)
|
|
18774
18774
|
|
|
18775
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
18775
|
+
Defined in: [charts/viz/VizBaseConfig.ts:158](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L158)
|
|
18776
18776
|
|
|
18777
18777
|
The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.
|
|
18778
18778
|
|
|
@@ -18794,9 +18794,9 @@ The maximum pixel size for drawing the color scale: width for horizontal scales
|
|
|
18794
18794
|
|
|
18795
18795
|
##### colorScalePadding()
|
|
18796
18796
|
|
|
18797
|
-
> **colorScalePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Viz`](#viz) \| (() => `boolean`)
|
|
18797
|
+
> **colorScalePadding**(`_?`: `boolean` \| ((`viz`: `VizBase`) => `boolean`)): `boolean` \| [`Viz`](#viz) \| ((`viz`: `VizBase`) => `boolean`)
|
|
18798
18798
|
|
|
18799
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
18799
|
+
Defined in: [charts/viz/VizBaseConfig.ts:134](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L134)
|
|
18800
18800
|
|
|
18801
18801
|
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.
|
|
18802
18802
|
|
|
@@ -18804,11 +18804,11 @@ Tells the colorScale whether or not to use the internal padding defined by the v
|
|
|
18804
18804
|
|
|
18805
18805
|
| Parameter | Type |
|
|
18806
18806
|
| ------ | ------ |
|
|
18807
|
-
| `_?` | `boolean` \| (() => `boolean`) |
|
|
18807
|
+
| `_?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) |
|
|
18808
18808
|
|
|
18809
18809
|
###### Returns
|
|
18810
18810
|
|
|
18811
|
-
`boolean` \| [`Viz`](#viz) \| (() => `boolean`)
|
|
18811
|
+
`boolean` \| [`Viz`](#viz) \| ((`viz`: `VizBase`) => `boolean`)
|
|
18812
18812
|
|
|
18813
18813
|
###### Inherited from
|
|
18814
18814
|
|
|
@@ -18820,7 +18820,7 @@ Tells the colorScale whether or not to use the internal padding defined by the v
|
|
|
18820
18820
|
|
|
18821
18821
|
> **colorScalePosition**(`_?`: `string` \| `boolean` \| (() => `string` \| `boolean`)): `string` \| `boolean` \| [`Viz`](#viz) \| (() => `string` \| `boolean`)
|
|
18822
18822
|
|
|
18823
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
18823
|
+
Defined in: [charts/viz/VizBaseConfig.ts:146](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L146)
|
|
18824
18824
|
|
|
18825
18825
|
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.
|
|
18826
18826
|
|
|
@@ -18886,7 +18886,7 @@ Methods that correspond to the key/value pairs and returns this class.
|
|
|
18886
18886
|
|
|
18887
18887
|
> **data**(`_?`: `string` \| `DataPoint`[] \| \{ `headers`: `Record`\<`string`, `string`\>; `url`: `string`; \}, `f?`: (`data`: `DataPoint`[]) => `Record`\<`string`, `unknown`\> \| `DataPoint`[]): [`Viz`](#viz) \| `DataPoint`[]
|
|
18888
18888
|
|
|
18889
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
18889
|
+
Defined in: [charts/viz/VizBaseConfig.ts:176](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L176)
|
|
18890
18890
|
|
|
18891
18891
|
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`.
|
|
18892
18892
|
|
|
@@ -18933,7 +18933,7 @@ Tears down the visualization: disconnects the ResizeObserver and removes DOM eve
|
|
|
18933
18933
|
|
|
18934
18934
|
> **detectResize**(`_?`: `boolean`): `boolean` \| [`Viz`](#viz)
|
|
18935
18935
|
|
|
18936
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
18936
|
+
Defined in: [charts/viz/VizBaseConfig.ts:204](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L204)
|
|
18937
18937
|
|
|
18938
18938
|
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.
|
|
18939
18939
|
|
|
@@ -18957,7 +18957,7 @@ If the width and/or height of a Viz is not user-defined, it is determined by the
|
|
|
18957
18957
|
|
|
18958
18958
|
> **detectResizeDelay**(`_?`: `number`): `number` \| [`Viz`](#viz)
|
|
18959
18959
|
|
|
18960
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
18960
|
+
Defined in: [charts/viz/VizBaseConfig.ts:213](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L213)
|
|
18961
18961
|
|
|
18962
18962
|
When resizing the browser window, this is the millisecond delay to trigger the resize event.
|
|
18963
18963
|
|
|
@@ -18981,7 +18981,7 @@ When resizing the browser window, this is the millisecond delay to trigger the r
|
|
|
18981
18981
|
|
|
18982
18982
|
> **detectVisible**(`_?`: `boolean`): `boolean` \| [`Viz`](#viz)
|
|
18983
18983
|
|
|
18984
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
18984
|
+
Defined in: [charts/viz/VizBaseConfig.ts:222](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L222)
|
|
18985
18985
|
|
|
18986
18986
|
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.
|
|
18987
18987
|
|
|
@@ -19005,7 +19005,7 @@ Toggles whether or not the Viz should try to detect if it visible in the current
|
|
|
19005
19005
|
|
|
19006
19006
|
> **detectVisibleInterval**(`_?`: `number`): `number` \| [`Viz`](#viz)
|
|
19007
19007
|
|
|
19008
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
19008
|
+
Defined in: [charts/viz/VizBaseConfig.ts:231](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L231)
|
|
19009
19009
|
|
|
19010
19010
|
The interval, in milliseconds, for checking if the visualization is visible on the page.
|
|
19011
19011
|
|
|
@@ -19029,7 +19029,7 @@ The interval, in milliseconds, for checking if the visualization is visible on t
|
|
|
19029
19029
|
|
|
19030
19030
|
> **downloadButton**(`_?`: `boolean`): `boolean` \| [`Viz`](#viz)
|
|
19031
19031
|
|
|
19032
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
19032
|
+
Defined in: [charts/viz/VizBaseConfig.ts:240](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L240)
|
|
19033
19033
|
|
|
19034
19034
|
Shows a button that allows for downloading the current visualization.
|
|
19035
19035
|
|
|
@@ -19053,7 +19053,7 @@ Shows a button that allows for downloading the current visualization.
|
|
|
19053
19053
|
|
|
19054
19054
|
> **downloadConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Viz`](#viz)
|
|
19055
19055
|
|
|
19056
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
19056
|
+
Defined in: [charts/viz/VizBaseConfig.ts:249](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L249)
|
|
19057
19057
|
|
|
19058
19058
|
Sets specific options of the saveElement function used when downloading the visualization.
|
|
19059
19059
|
|
|
@@ -19077,7 +19077,7 @@ Sets specific options of the saveElement function used when downloading the visu
|
|
|
19077
19077
|
|
|
19078
19078
|
> **downloadPosition**(`_?`: `string`): `string` \| [`Viz`](#viz)
|
|
19079
19079
|
|
|
19080
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
19080
|
+
Defined in: [charts/viz/VizBaseConfig.ts:258](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L258)
|
|
19081
19081
|
|
|
19082
19082
|
Defines which control group to add the download button into.
|
|
19083
19083
|
|
|
@@ -19101,7 +19101,7 @@ Defines which control group to add the download button into.
|
|
|
19101
19101
|
|
|
19102
19102
|
> **fontFamily**(`_?`: `string` \| `string`[]): `string` \| [`Viz`](#viz) \| `string`[]
|
|
19103
19103
|
|
|
19104
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
19104
|
+
Defined in: [charts/viz/VizBaseConfig.ts:267](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L267)
|
|
19105
19105
|
|
|
19106
19106
|
The font family used throughout the visualization.
|
|
19107
19107
|
|
|
@@ -19125,7 +19125,7 @@ The font family used throughout the visualization.
|
|
|
19125
19125
|
|
|
19126
19126
|
> **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`[]
|
|
19127
19127
|
|
|
19128
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
19128
|
+
Defined in: [charts/viz/VizBaseConfig.ts:300](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L300)
|
|
19129
19129
|
|
|
19130
19130
|
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.
|
|
19131
19131
|
|
|
@@ -19149,7 +19149,7 @@ Defines the mapping between data and shape. The value can be a String matching a
|
|
|
19149
19149
|
|
|
19150
19150
|
> **hiddenColor**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)
|
|
19151
19151
|
|
|
19152
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
19152
|
+
Defined in: [charts/viz/VizBaseConfig.ts:337](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L337)
|
|
19153
19153
|
|
|
19154
19154
|
Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).
|
|
19155
19155
|
|
|
@@ -19173,7 +19173,7 @@ Defines the color used for legend shapes when the corresponding grouping is hidd
|
|
|
19173
19173
|
|
|
19174
19174
|
> **hiddenOpacity**(`_?`: `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)): `number` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `number`)
|
|
19175
19175
|
|
|
19176
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
19176
|
+
Defined in: [charts/viz/VizBaseConfig.ts:348](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L348)
|
|
19177
19177
|
|
|
19178
19178
|
Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).
|
|
19179
19179
|
|
|
@@ -19197,7 +19197,7 @@ Defines the opacity used for legend labels when the corresponding grouping is hi
|
|
|
19197
19197
|
|
|
19198
19198
|
> **highlight**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `false` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `undefined`
|
|
19199
19199
|
|
|
19200
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
19200
|
+
Defined in: [charts/viz/VizBaseConfig.ts:418](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L418)
|
|
19201
19201
|
|
|
19202
19202
|
Persistently emphasizes the data points matching the given predicate: the
|
|
19203
19203
|
matching marks keep their color while every other mark is de-emphasized to
|
|
@@ -19225,7 +19225,7 @@ standing state that survives pointer movement. Pass `false` to clear it.
|
|
|
19225
19225
|
|
|
19226
19226
|
> **hover**(`_?`: `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`)): `this`
|
|
19227
19227
|
|
|
19228
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
19228
|
+
Defined in: [charts/viz/VizBaseConfig.ts:360](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L360)
|
|
19229
19229
|
|
|
19230
19230
|
The hover callback function for highlighting shapes on mouseover.
|
|
19231
19231
|
|
|
@@ -19249,7 +19249,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
19249
19249
|
|
|
19250
19250
|
> **label**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): `string` \| [`Viz`](#viz) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)
|
|
19251
19251
|
|
|
19252
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
19252
|
+
Defined in: [charts/viz/VizBaseConfig.ts:432](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L432)
|
|
19253
19253
|
|
|
19254
19254
|
Accessor function or string key for the label of each data point.
|
|
19255
19255
|
|
|
@@ -19273,7 +19273,7 @@ Accessor function or string key for the label of each data point.
|
|
|
19273
19273
|
|
|
19274
19274
|
> **legend**(`_?`: `boolean` \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)): `boolean` \| [`Viz`](#viz) \| ((`config`: `Record`\<`string`, `unknown`\>, `arr`: `DataPoint`[]) => `boolean`)
|
|
19275
19275
|
|
|
19276
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
19276
|
+
Defined in: [charts/viz/VizBaseConfig.ts:443](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L443)
|
|
19277
19277
|
|
|
19278
19278
|
Whether to display the legend.
|
|
19279
19279
|
|
|
@@ -19297,7 +19297,7 @@ Whether to display the legend.
|
|
|
19297
19297
|
|
|
19298
19298
|
> **legendConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Viz`](#viz)
|
|
19299
19299
|
|
|
19300
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
19300
|
+
Defined in: [charts/viz/VizBaseConfig.ts:459](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L459)
|
|
19301
19301
|
|
|
19302
19302
|
Configuration object passed to the legend's config method.
|
|
19303
19303
|
|
|
@@ -19319,9 +19319,9 @@ Configuration object passed to the legend's config method.
|
|
|
19319
19319
|
|
|
19320
19320
|
##### legendFilterInvert()
|
|
19321
19321
|
|
|
19322
|
-
> **legendFilterInvert**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Viz`](#viz) \| (() => `boolean`)
|
|
19322
|
+
> **legendFilterInvert**(`_?`: `boolean` \| ((`viz`: `VizBase`) => `boolean`)): `boolean` \| [`Viz`](#viz) \| ((`viz`: `VizBase`) => `boolean`)
|
|
19323
19323
|
|
|
19324
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
19324
|
+
Defined in: [charts/viz/VizBaseConfig.ts:468](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L468)
|
|
19325
19325
|
|
|
19326
19326
|
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.
|
|
19327
19327
|
|
|
@@ -19329,11 +19329,11 @@ Defines the click functionality of categorical legend squares. When set to false
|
|
|
19329
19329
|
|
|
19330
19330
|
| Parameter | Type |
|
|
19331
19331
|
| ------ | ------ |
|
|
19332
|
-
| `_?` | `boolean` \| (() => `boolean`) |
|
|
19332
|
+
| `_?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) |
|
|
19333
19333
|
|
|
19334
19334
|
###### Returns
|
|
19335
19335
|
|
|
19336
|
-
`boolean` \| [`Viz`](#viz) \| (() => `boolean`)
|
|
19336
|
+
`boolean` \| [`Viz`](#viz) \| ((`viz`: `VizBase`) => `boolean`)
|
|
19337
19337
|
|
|
19338
19338
|
###### Inherited from
|
|
19339
19339
|
|
|
@@ -19343,9 +19343,9 @@ Defines the click functionality of categorical legend squares. When set to false
|
|
|
19343
19343
|
|
|
19344
19344
|
##### legendPadding()
|
|
19345
19345
|
|
|
19346
|
-
> **legendPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Viz`](#viz) \| (() => `boolean`)
|
|
19346
|
+
> **legendPadding**(`_?`: `boolean` \| ((`viz`: `VizBase`) => `boolean`)): `boolean` \| [`Viz`](#viz) \| ((`viz`: `VizBase`) => `boolean`)
|
|
19347
19347
|
|
|
19348
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
19348
|
+
Defined in: [charts/viz/VizBaseConfig.ts:480](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L480)
|
|
19349
19349
|
|
|
19350
19350
|
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.
|
|
19351
19351
|
|
|
@@ -19353,11 +19353,11 @@ Tells the legend whether or not to use the internal padding defined by the visua
|
|
|
19353
19353
|
|
|
19354
19354
|
| Parameter | Type |
|
|
19355
19355
|
| ------ | ------ |
|
|
19356
|
-
| `_?` | `boolean` \| (() => `boolean`) |
|
|
19356
|
+
| `_?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) |
|
|
19357
19357
|
|
|
19358
19358
|
###### Returns
|
|
19359
19359
|
|
|
19360
|
-
`boolean` \| [`Viz`](#viz) \| (() => `boolean`)
|
|
19360
|
+
`boolean` \| [`Viz`](#viz) \| ((`viz`: `VizBase`) => `boolean`)
|
|
19361
19361
|
|
|
19362
19362
|
###### Inherited from
|
|
19363
19363
|
|
|
@@ -19369,7 +19369,7 @@ Tells the legend whether or not to use the internal padding defined by the visua
|
|
|
19369
19369
|
|
|
19370
19370
|
> **legendPosition**(`_?`: `string` \| (() => `string`)): `string` \| [`Viz`](#viz) \| (() => `string`)
|
|
19371
19371
|
|
|
19372
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
19372
|
+
Defined in: [charts/viz/VizBaseConfig.ts:492](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L492)
|
|
19373
19373
|
|
|
19374
19374
|
Defines which side of the visualization to anchor the legend. Expected values are `"top"`, `"bottom"`, `"left"`, and `"right"`.
|
|
19375
19375
|
|
|
@@ -19393,7 +19393,7 @@ Defines which side of the visualization to anchor the legend. Expected values ar
|
|
|
19393
19393
|
|
|
19394
19394
|
> **legendTooltip**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Viz`](#viz)
|
|
19395
19395
|
|
|
19396
|
-
Defined in: [charts/viz/VizBaseConfig.ts:
|
|
19396
|
+
Defined in: [charts/viz/VizBaseConfig.ts:502](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBaseConfig.ts#L502)
|
|
19397
19397
|
|
|
19398
19398
|
Configuration object for the legend tooltip.
|
|
19399
19399
|
|
|
@@ -20094,7 +20094,7 @@ Configuration object for the subtitle.
|
|
|
20094
20094
|
|
|
20095
20095
|
##### subtitlePadding()
|
|
20096
20096
|
|
|
20097
|
-
> **subtitlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Viz`](#viz) \| (() => `boolean`)
|
|
20097
|
+
> **subtitlePadding**(`_?`: `boolean` \| ((`viz`: `VizBase`) => `boolean`)): `boolean` \| [`Viz`](#viz) \| ((`viz`: `VizBase`) => `boolean`)
|
|
20098
20098
|
|
|
20099
20099
|
Defined in: [charts/viz/VizBase.ts:144](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBase.ts#L144)
|
|
20100
20100
|
|
|
@@ -20104,11 +20104,11 @@ Tells the subtitle whether or not to use the internal padding defined by the vis
|
|
|
20104
20104
|
|
|
20105
20105
|
| Parameter | Type |
|
|
20106
20106
|
| ------ | ------ |
|
|
20107
|
-
| `_?` | `boolean` \| (() => `boolean`) |
|
|
20107
|
+
| `_?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) |
|
|
20108
20108
|
|
|
20109
20109
|
###### Returns
|
|
20110
20110
|
|
|
20111
|
-
`boolean` \| [`Viz`](#viz) \| (() => `boolean`)
|
|
20111
|
+
`boolean` \| [`Viz`](#viz) \| ((`viz`: `VizBase`) => `boolean`)
|
|
20112
20112
|
|
|
20113
20113
|
###### Inherited from
|
|
20114
20114
|
|
|
@@ -20262,7 +20262,7 @@ The starting time or range for the timeline. Can be a single Date/String, or an
|
|
|
20262
20262
|
|
|
20263
20263
|
##### timelinePadding()
|
|
20264
20264
|
|
|
20265
|
-
> **timelinePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Viz`](#viz) \| (() => `boolean`)
|
|
20265
|
+
> **timelinePadding**(`_?`: `boolean` \| ((`viz`: `VizBase`) => `boolean`)): `boolean` \| [`Viz`](#viz) \| ((`viz`: `VizBase`) => `boolean`)
|
|
20266
20266
|
|
|
20267
20267
|
Defined in: [charts/viz/VizBase.ts:268](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBase.ts#L268)
|
|
20268
20268
|
|
|
@@ -20272,11 +20272,11 @@ Tells the timeline whether or not to use the internal padding defined by the vis
|
|
|
20272
20272
|
|
|
20273
20273
|
| Parameter | Type |
|
|
20274
20274
|
| ------ | ------ |
|
|
20275
|
-
| `_?` | `boolean` \| (() => `boolean`) |
|
|
20275
|
+
| `_?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) |
|
|
20276
20276
|
|
|
20277
20277
|
###### Returns
|
|
20278
20278
|
|
|
20279
|
-
`boolean` \| [`Viz`](#viz) \| (() => `boolean`)
|
|
20279
|
+
`boolean` \| [`Viz`](#viz) \| ((`viz`: `VizBase`) => `boolean`)
|
|
20280
20280
|
|
|
20281
20281
|
###### Inherited from
|
|
20282
20282
|
|
|
@@ -20334,7 +20334,7 @@ Configuration object for the title.
|
|
|
20334
20334
|
|
|
20335
20335
|
##### titlePadding()
|
|
20336
20336
|
|
|
20337
|
-
> **titlePadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Viz`](#viz) \| (() => `boolean`)
|
|
20337
|
+
> **titlePadding**(`_?`: `boolean` \| ((`viz`: `VizBase`) => `boolean`)): `boolean` \| [`Viz`](#viz) \| ((`viz`: `VizBase`) => `boolean`)
|
|
20338
20338
|
|
|
20339
20339
|
Defined in: [charts/viz/VizBase.ts:300](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBase.ts#L300)
|
|
20340
20340
|
|
|
@@ -20344,11 +20344,11 @@ Tells the title whether or not to use the internal padding defined by the visual
|
|
|
20344
20344
|
|
|
20345
20345
|
| Parameter | Type |
|
|
20346
20346
|
| ------ | ------ |
|
|
20347
|
-
| `_?` | `boolean` \| (() => `boolean`) |
|
|
20347
|
+
| `_?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) |
|
|
20348
20348
|
|
|
20349
20349
|
###### Returns
|
|
20350
20350
|
|
|
20351
|
-
`boolean` \| [`Viz`](#viz) \| (() => `boolean`)
|
|
20351
|
+
`boolean` \| [`Viz`](#viz) \| ((`viz`: `VizBase`) => `boolean`)
|
|
20352
20352
|
|
|
20353
20353
|
###### Inherited from
|
|
20354
20354
|
|
|
@@ -20498,7 +20498,7 @@ Formatter function for the value in the total bar.
|
|
|
20498
20498
|
|
|
20499
20499
|
##### totalPadding()
|
|
20500
20500
|
|
|
20501
|
-
> **totalPadding**(`_?`: `boolean` \| (() => `boolean`)): `boolean` \| [`Viz`](#viz) \| (() => `boolean`)
|
|
20501
|
+
> **totalPadding**(`_?`: `boolean` \| ((`viz`: `VizBase`) => `boolean`)): `boolean` \| [`Viz`](#viz) \| ((`viz`: `VizBase`) => `boolean`)
|
|
20502
20502
|
|
|
20503
20503
|
Defined in: [charts/viz/VizBase.ts:363](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/VizBase.ts#L363)
|
|
20504
20504
|
|
|
@@ -20508,11 +20508,11 @@ Tells the total whether or not to use the internal padding defined by the visual
|
|
|
20508
20508
|
|
|
20509
20509
|
| Parameter | Type |
|
|
20510
20510
|
| ------ | ------ |
|
|
20511
|
-
| `_?` | `boolean` \| (() => `boolean`) |
|
|
20511
|
+
| `_?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) |
|
|
20512
20512
|
|
|
20513
20513
|
###### Returns
|
|
20514
20514
|
|
|
20515
|
-
`boolean` \| [`Viz`](#viz) \| (() => `boolean`)
|
|
20515
|
+
`boolean` \| [`Viz`](#viz) \| ((`viz`: `VizBase`) => `boolean`)
|
|
20516
20516
|
|
|
20517
20517
|
###### Inherited from
|
|
20518
20518
|
|
|
@@ -22026,28 +22026,28 @@ Area-specific config (curve, defined, dual-edge x/y).
|
|
|
22026
22026
|
|
|
22027
22027
|
### AxisConfig
|
|
22028
22028
|
|
|
22029
|
-
Defined in: [utils/D3plusConfig.ts:
|
|
22029
|
+
Defined in: [utils/D3plusConfig.ts:44](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L44)
|
|
22030
22030
|
|
|
22031
22031
|
#### Properties
|
|
22032
22032
|
|
|
22033
22033
|
| Property | Type | Description | Defined in |
|
|
22034
22034
|
| ------ | ------ | ------ | ------ |
|
|
22035
|
-
| <a id="property-barconfig"></a> `barConfig?` | `Record`\<`string`, `string` \| `number`\> | - | [utils/D3plusConfig.ts:
|
|
22036
|
-
| <a id="property-grid"></a> `grid?` | `unknown`[] | Grid values of the axis. | [utils/D3plusConfig.ts:
|
|
22037
|
-
| <a id="property-gridconfig"></a> `gridConfig?` | `Record`\<`string`, `string` \| `number`\> | - | [utils/D3plusConfig.ts:
|
|
22038
|
-
| <a id="property-gridsize"></a> `gridSize?` | `number` | Grid size of the axis. | [utils/D3plusConfig.ts:
|
|
22039
|
-
| <a id="property-label-1"></a> `label?` | `string` | - | [utils/D3plusConfig.ts:
|
|
22040
|
-
| <a id="property-labeloffset"></a> `labelOffset?` | `number` \| `false` | - | [utils/D3plusConfig.ts:
|
|
22041
|
-
| <a id="property-labels"></a> `labels?` | `unknown`[] | Visible tick labels of the axis. | [utils/D3plusConfig.ts:
|
|
22042
|
-
| <a id="property-maxsize"></a> `maxSize?` | `number` | Maximum size allowed for the space that contains the axis tick labels and title. | [utils/D3plusConfig.ts:
|
|
22043
|
-
| <a id="property-minsize"></a> `minSize?` | `number` | Minimum size alloted for the space that contains the axis tick labels and title. | [utils/D3plusConfig.ts:
|
|
22044
|
-
| <a id="property-range"></a> `range?` | (`number` \| `undefined`)[] | 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. | [utils/D3plusConfig.ts:
|
|
22045
|
-
| <a id="property-scale-1"></a> `scale?` | `AxisScale` | Scale of the axis. | [utils/D3plusConfig.ts:
|
|
22046
|
-
| <a id="property-tickformat"></a> `tickFormat?` | (`d`: `string` \| `number`) => `string` \| `number` | Tick formatter. | [utils/D3plusConfig.ts:
|
|
22047
|
-
| <a id="property-ticks"></a> `ticks?` | `unknown`[] | Tick values of the axis. | [utils/D3plusConfig.ts:
|
|
22048
|
-
| <a id="property-ticksize"></a> `tickSize?` | `number` | - | [utils/D3plusConfig.ts:
|
|
22049
|
-
| <a id="property-timelocale"></a> `timeLocale?` | `Record`\<`string`, `unknown`\> | Defines a custom locale object to be used in time scales. Must include `dateTime`, `date`, `time`, `periods`, `days`, `shortDays`, `months`, and `shortMonths` (see [d3-time-format](https://github.com/d3/d3-time-format/blob/master/README.md#timeFormatLocale)). | [utils/D3plusConfig.ts:
|
|
22050
|
-
| <a id="property-title"></a> `title?` | `string` | Title of the axis. | [utils/D3plusConfig.ts:
|
|
22035
|
+
| <a id="property-barconfig"></a> `barConfig?` | `Record`\<`string`, `string` \| `number`\> | - | [utils/D3plusConfig.ts:45](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L45) |
|
|
22036
|
+
| <a id="property-grid"></a> `grid?` | `unknown`[] | Grid values of the axis. | [utils/D3plusConfig.ts:47](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L47) |
|
|
22037
|
+
| <a id="property-gridconfig"></a> `gridConfig?` | `Record`\<`string`, `string` \| `number`\> | - | [utils/D3plusConfig.ts:48](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L48) |
|
|
22038
|
+
| <a id="property-gridsize"></a> `gridSize?` | `number` | Grid size of the axis. | [utils/D3plusConfig.ts:50](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L50) |
|
|
22039
|
+
| <a id="property-label-1"></a> `label?` | `string` | - | [utils/D3plusConfig.ts:51](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L51) |
|
|
22040
|
+
| <a id="property-labeloffset"></a> `labelOffset?` | `number` \| `false` | - | [utils/D3plusConfig.ts:54](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L54) |
|
|
22041
|
+
| <a id="property-labels"></a> `labels?` | `unknown`[] | Visible tick labels of the axis. | [utils/D3plusConfig.ts:53](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L53) |
|
|
22042
|
+
| <a id="property-maxsize"></a> `maxSize?` | `number` | Maximum size allowed for the space that contains the axis tick labels and title. | [utils/D3plusConfig.ts:56](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L56) |
|
|
22043
|
+
| <a id="property-minsize"></a> `minSize?` | `number` | Minimum size alloted for the space that contains the axis tick labels and title. | [utils/D3plusConfig.ts:58](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L58) |
|
|
22044
|
+
| <a id="property-range"></a> `range?` | (`number` \| `undefined`)[] | 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. | [utils/D3plusConfig.ts:63](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L63) |
|
|
22045
|
+
| <a id="property-scale-1"></a> `scale?` | `AxisScale` | Scale of the axis. | [utils/D3plusConfig.ts:65](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L65) |
|
|
22046
|
+
| <a id="property-tickformat"></a> `tickFormat?` | (`d`: `string` \| `number`) => `string` \| `number` | Tick formatter. | [utils/D3plusConfig.ts:67](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L67) |
|
|
22047
|
+
| <a id="property-ticks"></a> `ticks?` | `unknown`[] | Tick values of the axis. | [utils/D3plusConfig.ts:69](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L69) |
|
|
22048
|
+
| <a id="property-ticksize"></a> `tickSize?` | `number` | - | [utils/D3plusConfig.ts:70](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L70) |
|
|
22049
|
+
| <a id="property-timelocale"></a> `timeLocale?` | `Record`\<`string`, `unknown`\> | Defines a custom locale object to be used in time scales. Must include `dateTime`, `date`, `time`, `periods`, `days`, `shortDays`, `months`, and `shortMonths` (see [d3-time-format](https://github.com/d3/d3-time-format/blob/master/README.md#timeFormatLocale)). | [utils/D3plusConfig.ts:77](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L77) |
|
|
22050
|
+
| <a id="property-title"></a> `title?` | `string` | Title of the axis. | [utils/D3plusConfig.ts:79](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L79) |
|
|
22051
22051
|
|
|
22052
22052
|
***
|
|
22053
22053
|
|
|
@@ -22297,15 +22297,15 @@ Circle-specific config (radius).
|
|
|
22297
22297
|
|
|
22298
22298
|
### ColorScaleConfig
|
|
22299
22299
|
|
|
22300
|
-
Defined in: [utils/D3plusConfig.ts:
|
|
22300
|
+
Defined in: [utils/D3plusConfig.ts:223](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L223)
|
|
22301
22301
|
|
|
22302
22302
|
#### Properties
|
|
22303
22303
|
|
|
22304
22304
|
| Property | Type | Description | Defined in |
|
|
22305
22305
|
| ------ | ------ | ------ | ------ |
|
|
22306
|
-
| <a id="property-bucketformat"></a> `bucketFormat?` | (`start`: `number`, `i`: `number`, `buckets`: `number`[], `values`: `number`[]) => `string` | Formats the label for each bucket in a bucket-type scale ("jenks", "quantile", …). Passed the bucket's start value, its index, the full bucket array, and every data value used to build the buckets. | [utils/D3plusConfig.ts:
|
|
22307
|
-
| <a id="property-bucketjoiner"></a> `bucketJoiner?` | (`min`: `string`, `max`: `string`) => `string` | Given a bucket's minimum and maximum values, returns the full label. | [utils/D3plusConfig.ts:
|
|
22308
|
-
| <a id="property-domain"></a> `domain?` | `number`[] | For a linear scale, the `[min, max]` values used by the color scale; values outside this range map to the nearest color. | [utils/D3plusConfig.ts:
|
|
22306
|
+
| <a id="property-bucketformat"></a> `bucketFormat?` | (`start`: `number`, `i`: `number`, `buckets`: `number`[], `values`: `number`[]) => `string` | Formats the label for each bucket in a bucket-type scale ("jenks", "quantile", …). Passed the bucket's start value, its index, the full bucket array, and every data value used to build the buckets. | [utils/D3plusConfig.ts:234](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L234) |
|
|
22307
|
+
| <a id="property-bucketjoiner"></a> `bucketJoiner?` | (`min`: `string`, `max`: `string`) => `string` | Given a bucket's minimum and maximum values, returns the full label. | [utils/D3plusConfig.ts:241](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L241) |
|
|
22308
|
+
| <a id="property-domain"></a> `domain?` | `number`[] | For a linear scale, the `[min, max]` values used by the color scale; values outside this range map to the nearest color. | [utils/D3plusConfig.ts:228](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L228) |
|
|
22309
22309
|
|
|
22310
22310
|
***
|
|
22311
22311
|
|
|
@@ -22313,7 +22313,7 @@ Defined in: [utils/D3plusConfig.ts:222](https://github.com/d3plus/d3plus/blob/ma
|
|
|
22313
22313
|
|
|
22314
22314
|
### D3plusConfig
|
|
22315
22315
|
|
|
22316
|
-
Defined in: [utils/D3plusConfig.ts:
|
|
22316
|
+
Defined in: [utils/D3plusConfig.ts:244](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L244)
|
|
22317
22317
|
|
|
22318
22318
|
#### Indexable
|
|
22319
22319
|
|
|
@@ -22325,103 +22325,114 @@ Allows additional custom properties.
|
|
|
22325
22325
|
|
|
22326
22326
|
| Property | Type | Description | Defined in |
|
|
22327
22327
|
| ------ | ------ | ------ | ------ |
|
|
22328
|
-
| <a id="property-active-4"></a> `active?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | The active callback function for highlighting shapes. | [utils/D3plusConfig.ts:
|
|
22329
|
-
| <a id="property-aggs"></a> `aggs?` | `object` | Custom aggregation functions keyed by data property. | [utils/D3plusConfig.ts:
|
|
22330
|
-
| <a id="property-ariahidden"></a> `ariaHidden?` | `boolean` | Hides the SVG from assistive technology when true (`aria-hidden`). | [utils/D3plusConfig.ts:
|
|
22331
|
-
| <a id="property-barpadding"></a> `barPadding?` | `number` | Padding between bars in pixels. | [utils/D3plusConfig.ts:
|
|
22332
|
-
| <a id="property-baseline"></a> `baseline?` | `number` | The baseline for the x/y plot. | [utils/D3plusConfig.ts:
|
|
22333
|
-
| <a id="property-cache"></a> `cache?` | `boolean` | Whether to cache the processed data between renders. | [utils/D3plusConfig.ts:
|
|
22334
|
-
| <a id="property-colorordinal"></a> `colorOrdinal?` | `boolean` | Treat a discrete color field as ordered: color it with a single-hue light→dark ramp instead of nominal categorical hues. | [utils/D3plusConfig.ts:
|
|
22335
|
-
| <a id="property-colorscale"></a> `colorScale?` | `string` \| ((`d`: `number`) => `string`) | Color scale key or custom color function. | [utils/D3plusConfig.ts:
|
|
22336
|
-
| <a id="property-colorscaleconfig"></a> `colorScaleConfig?` | `object` | Configuration for the color scale component. | [utils/D3plusConfig.ts:
|
|
22337
|
-
| `colorScaleConfig.axisConfig?` | [`AxisConfig`](#axisconfig-2) | - | [utils/D3plusConfig.ts:
|
|
22338
|
-
| `colorScaleConfig.centered?` | `boolean` | - | [utils/D3plusConfig.ts:
|
|
22339
|
-
| `colorScaleConfig.colorMax?` | `string` | - | [utils/D3plusConfig.ts:
|
|
22340
|
-
| `colorScaleConfig.colorMid?` | `string` | - | [utils/D3plusConfig.ts:
|
|
22341
|
-
| `colorScaleConfig.colorMin?` | `string` | - | [utils/D3plusConfig.ts:
|
|
22342
|
-
| `colorScaleConfig.colors?` | `string`[] | - | [utils/D3plusConfig.ts:
|
|
22343
|
-
| `colorScaleConfig.scale?` | `AxisScale` | - | [utils/D3plusConfig.ts:
|
|
22344
|
-
| <a id="property-
|
|
22345
|
-
| <a id="property-
|
|
22346
|
-
| <a id="property-
|
|
22347
|
-
| <a id="property-
|
|
22348
|
-
| <a id="property-
|
|
22349
|
-
| <a id="property-
|
|
22350
|
-
| <a id="property-
|
|
22351
|
-
| <a id="property-
|
|
22352
|
-
| <a id="property-
|
|
22353
|
-
| <a id="property-
|
|
22354
|
-
| <a id="property-
|
|
22355
|
-
| <a id="property-
|
|
22356
|
-
| <a id="property-
|
|
22357
|
-
| <a id="property-
|
|
22358
|
-
| <a id="property-
|
|
22359
|
-
| <a id="property-
|
|
22360
|
-
| <a id="property-
|
|
22361
|
-
| <a id="property-
|
|
22362
|
-
| `
|
|
22363
|
-
| `
|
|
22364
|
-
| <a id="property-
|
|
22365
|
-
|
|
|
22366
|
-
|
|
|
22367
|
-
| <a id="property-
|
|
22368
|
-
| <a id="property-
|
|
22369
|
-
| <a id="property-
|
|
22370
|
-
| <a id="property-
|
|
22371
|
-
| <a id="property-
|
|
22372
|
-
| <a id="property-
|
|
22373
|
-
| <a id="property-
|
|
22374
|
-
| <a id="property-
|
|
22375
|
-
| <a id="property-
|
|
22376
|
-
| <a id="property-
|
|
22377
|
-
| <a id="property-
|
|
22378
|
-
| <a id="property-
|
|
22379
|
-
| <a id="property-
|
|
22380
|
-
| <a id="property-
|
|
22381
|
-
| <a id="property-
|
|
22382
|
-
| <a id="property-
|
|
22383
|
-
| <a id="property-
|
|
22384
|
-
| `
|
|
22385
|
-
| <a id="property-
|
|
22386
|
-
| <a id="property-
|
|
22387
|
-
| <a id="property-
|
|
22388
|
-
| <a id="property-
|
|
22389
|
-
| <a id="property-
|
|
22390
|
-
|
|
|
22391
|
-
| <a id="property-
|
|
22392
|
-
| <a id="property-
|
|
22393
|
-
| <a id="property-
|
|
22394
|
-
| <a id="property-
|
|
22395
|
-
| <a id="property-
|
|
22396
|
-
| <a id="property-
|
|
22397
|
-
| <a id="property-
|
|
22398
|
-
| <a id="property-
|
|
22399
|
-
| <a id="property-
|
|
22400
|
-
| <a id="property-
|
|
22401
|
-
| <a id="property-
|
|
22402
|
-
| <a id="property-
|
|
22403
|
-
| <a id="property-
|
|
22404
|
-
| <a id="property-
|
|
22405
|
-
| <a id="property-
|
|
22406
|
-
| <a id="property-
|
|
22407
|
-
| <a id="property-
|
|
22408
|
-
| <a id="property-
|
|
22409
|
-
| <a id="property-
|
|
22410
|
-
| <a id="property-
|
|
22411
|
-
| <a id="property-
|
|
22412
|
-
| <a id="property-
|
|
22413
|
-
| <a id="property-
|
|
22414
|
-
| <a id="property-
|
|
22415
|
-
| <a id="property-
|
|
22416
|
-
| <a id="property-
|
|
22417
|
-
| <a id="property-
|
|
22418
|
-
| <a id="property-
|
|
22419
|
-
| <a id="property-
|
|
22420
|
-
| <a id="property-
|
|
22421
|
-
| <a id="property-
|
|
22422
|
-
| <a id="property-
|
|
22423
|
-
| <a id="property-
|
|
22424
|
-
| <a id="property-
|
|
22328
|
+
| <a id="property-active-4"></a> `active?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | The active callback function for highlighting shapes. | [utils/D3plusConfig.ts:251](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L251) |
|
|
22329
|
+
| <a id="property-aggs"></a> `aggs?` | `object` | Custom aggregation functions keyed by data property. | [utils/D3plusConfig.ts:253](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L253) |
|
|
22330
|
+
| <a id="property-ariahidden"></a> `ariaHidden?` | `boolean` | Hides the SVG from assistive technology when true (`aria-hidden`). | [utils/D3plusConfig.ts:255](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L255) |
|
|
22331
|
+
| <a id="property-barpadding"></a> `barPadding?` | `number` | Padding between bars in pixels. | [utils/D3plusConfig.ts:257](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L257) |
|
|
22332
|
+
| <a id="property-baseline"></a> `baseline?` | `number` | The baseline for the x/y plot. | [utils/D3plusConfig.ts:259](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L259) |
|
|
22333
|
+
| <a id="property-cache"></a> `cache?` | `boolean` | Whether to cache the processed data between renders. | [utils/D3plusConfig.ts:261](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L261) |
|
|
22334
|
+
| <a id="property-colorordinal"></a> `colorOrdinal?` | `boolean` | Treat a discrete color field as ordered: color it with a single-hue light→dark ramp instead of nominal categorical hues. | [utils/D3plusConfig.ts:263](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L263) |
|
|
22335
|
+
| <a id="property-colorscale"></a> `colorScale?` | `string` \| ((`d`: `number`) => `string`) | Color scale key or custom color function. | [utils/D3plusConfig.ts:265](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L265) |
|
|
22336
|
+
| <a id="property-colorscaleconfig"></a> `colorScaleConfig?` | `object` | Configuration for the color scale component. | [utils/D3plusConfig.ts:267](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L267) |
|
|
22337
|
+
| `colorScaleConfig.axisConfig?` | [`AxisConfig`](#axisconfig-2) | - | [utils/D3plusConfig.ts:268](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L268) |
|
|
22338
|
+
| `colorScaleConfig.centered?` | `boolean` | - | [utils/D3plusConfig.ts:269](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L269) |
|
|
22339
|
+
| `colorScaleConfig.colorMax?` | `string` | - | [utils/D3plusConfig.ts:273](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L273) |
|
|
22340
|
+
| `colorScaleConfig.colorMid?` | `string` | - | [utils/D3plusConfig.ts:272](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L272) |
|
|
22341
|
+
| `colorScaleConfig.colorMin?` | `string` | - | [utils/D3plusConfig.ts:271](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L271) |
|
|
22342
|
+
| `colorScaleConfig.colors?` | `string`[] | - | [utils/D3plusConfig.ts:270](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L270) |
|
|
22343
|
+
| `colorScaleConfig.scale?` | `AxisScale` | - | [utils/D3plusConfig.ts:274](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L274) |
|
|
22344
|
+
| <a id="property-colorscalepadding"></a> `colorScalePadding?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) | Whether the color scale uses the visualization's internal padding when positioning, or an accessor receiving the viz. | [utils/D3plusConfig.ts:277](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L277) |
|
|
22345
|
+
| <a id="property-colorscaleposition"></a> `colorScalePosition?` | `false` \| `Position` \| (() => false \| Position) | Position of the color scale, `false` to hide it, or an accessor returning either. | [utils/D3plusConfig.ts:279](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L279) |
|
|
22346
|
+
| <a id="property-column"></a> `column?` | `string` | Column key for matrix-style layouts. | [utils/D3plusConfig.ts:281](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L281) |
|
|
22347
|
+
| <a id="property-confidence"></a> `confidence?` | `false` \| \[`string` \| ((`d`: `DataPoint`, `i`: `number`) => `number`), `string` \| ((`d`: `DataPoint`, `i`: `number`) => `number`)\] | The confidence interval as `[lower, upper]` bounds — each given as an accessor function or a static data key (e.g. `["lci", "hci"]`), or `false` to disable. | [utils/D3plusConfig.ts:287](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L287) |
|
|
22348
|
+
| <a id="property-data-5"></a> `data?` | `string` \| `DataPoint`[] | Data array or URL string to load data from. | [utils/D3plusConfig.ts:246](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L246) |
|
|
22349
|
+
| <a id="property-datacutoff"></a> `dataCutoff?` | `number` | Maximum number of data points to render before downsampling. | [utils/D3plusConfig.ts:294](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L294) |
|
|
22350
|
+
| <a id="property-depth"></a> `depth?` | `number` | Active depth level for nested groupings. | [utils/D3plusConfig.ts:296](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L296) |
|
|
22351
|
+
| <a id="property-discrete-4"></a> `discrete?` | `"x"` \| `"y"` | Sets orientation of main category axis. | [utils/D3plusConfig.ts:298](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L298) |
|
|
22352
|
+
| <a id="property-duration-4"></a> `duration?` | `number` | Default duration of transitions, in milliseconds. | [utils/D3plusConfig.ts:300](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L300) |
|
|
22353
|
+
| <a id="property-filter"></a> `filter?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) | Predicate filtering which data points are included, or false to disable. | [utils/D3plusConfig.ts:302](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L302) |
|
|
22354
|
+
| <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:304](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L304) |
|
|
22355
|
+
| <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:309](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L309) |
|
|
22356
|
+
| <a id="property-grouppadding"></a> `groupPadding?` | `number` | Padding between groups of bars in pixels. | [utils/D3plusConfig.ts:315](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L315) |
|
|
22357
|
+
| <a id="property-height-1"></a> `height?` | `number` | Overall height of the visualization in pixels. | [utils/D3plusConfig.ts:317](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L317) |
|
|
22358
|
+
| <a id="property-hiddencolor"></a> `hiddenColor?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) | Color for legend shapes whose grouping is hidden (via legend click), or a `(datum, index)` accessor. | [utils/D3plusConfig.ts:319](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L319) |
|
|
22359
|
+
| <a id="property-hiddenopacity"></a> `hiddenOpacity?` | `number` \| ((`d`: `DataPoint`, `i`: `number`) => `number`) | Opacity for legend labels whose grouping is hidden (via legend click), or a `(datum, index)` accessor. | [utils/D3plusConfig.ts:321](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L321) |
|
|
22360
|
+
| <a id="property-highlight"></a> `highlight?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | Persistently emphasizes matching marks (keep color) and grays the rest. | [utils/D3plusConfig.ts:325](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L325) |
|
|
22361
|
+
| <a id="property-hover-4"></a> `hover?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | The hover callback function for highlighting shapes on mouseover. | [utils/D3plusConfig.ts:323](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L323) |
|
|
22362
|
+
| <a id="property-label-5"></a> `label?` | `string` \| `false` \| `string`[] \| `AccessorFn` | Label accessor for shapes. | [utils/D3plusConfig.ts:327](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L327) |
|
|
22363
|
+
| <a id="property-legend"></a> `legend?` | `boolean` \| ((`config`: [`D3plusConfig`](#d3plusconfig), `arr`: `DataPoint`[]) => `boolean`) | Controls legend visibility. Pass `false` to hide it, `true` to always show it, or a `(config, data) => boolean` accessor to decide dynamically — the chart defaults use an accessor to auto-hide the legend when it would be redundant. | [utils/D3plusConfig.ts:334](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L334) |
|
|
22364
|
+
| <a id="property-legendconfig"></a> `legendConfig?` | `object` | Configuration for the legend component. | [utils/D3plusConfig.ts:336](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L336) |
|
|
22365
|
+
| `legendConfig.label?` | `DataPointAccessor`\<`string`\> | - | [utils/D3plusConfig.ts:337](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L337) |
|
|
22366
|
+
| `legendConfig.shapeConfig?` | `Record`\<`string`, `string` \| `number`\> | - | [utils/D3plusConfig.ts:338](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L338) |
|
|
22367
|
+
| <a id="property-legendfilterinvert"></a> `legendFilterInvert?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) | Inverts legend click behavior (click hides / shift-click solos, or the reverse), or an accessor receiving the viz. | [utils/D3plusConfig.ts:341](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L341) |
|
|
22368
|
+
| <a id="property-legendpadding"></a> `legendPadding?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) | Whether the legend uses the visualization's internal padding when positioning, or an accessor receiving the viz. | [utils/D3plusConfig.ts:343](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L343) |
|
|
22369
|
+
| <a id="property-legendposition"></a> `legendPosition?` | `Position` \| (() => `Position`) | Position of the legend, or an accessor returning it. | [utils/D3plusConfig.ts:345](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L345) |
|
|
22370
|
+
| <a id="property-legendsort"></a> `legendSort?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` | Custom sort comparator for legend items. | [utils/D3plusConfig.ts:347](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L347) |
|
|
22371
|
+
| <a id="property-legendtooltip"></a> `legendTooltip?` | [`TooltipConfig`](#tooltipconfig-3) | Tooltip configuration for legend items. | [utils/D3plusConfig.ts:349](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L349) |
|
|
22372
|
+
| <a id="property-linelabels"></a> `lineLabels?` | `boolean` | Whether to show labels on line charts. | [utils/D3plusConfig.ts:351](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L351) |
|
|
22373
|
+
| <a id="property-loadinghtml"></a> `loadingHTML?` | `string` \| ((`viz`: `VizBase`) => `string`) | Custom HTML content for the loading indicator, or a function receiving the viz instance. | [utils/D3plusConfig.ts:355](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L355) |
|
|
22374
|
+
| <a id="property-loadingmessage"></a> `loadingMessage?` | `boolean` | Whether to show the loading message. | [utils/D3plusConfig.ts:353](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L353) |
|
|
22375
|
+
| <a id="property-locale"></a> `locale?` | `string` | Locale code used for text and number formatting. | [utils/D3plusConfig.ts:248](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L248) |
|
|
22376
|
+
| <a id="property-metric"></a> `metric?` | `string` | Metric key for the visualization. | [utils/D3plusConfig.ts:357](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L357) |
|
|
22377
|
+
| <a id="property-nodatahtml"></a> `noDataHTML?` | `string` \| ((`viz`: `VizBase`) => `string`) | Custom HTML content shown when no data is supplied, or a function receiving the viz instance. | [utils/D3plusConfig.ts:359](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L359) |
|
|
22378
|
+
| <a id="property-ocean"></a> `ocean?` | `string` | Ocean color for geomaps (any CSS value including 'transparent'). | [utils/D3plusConfig.ts:361](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L361) |
|
|
22379
|
+
| <a id="property-on-4"></a> `on?` | `Record`\<`string`, (`event`: `Event`) => `void`\> | Event listeners keyed by event name. | [utils/D3plusConfig.ts:363](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L363) |
|
|
22380
|
+
| <a id="property-point"></a> `point?` | (`d`: `DataPoint`) => `number`[] | Coordinate accessor for point-based geomaps. | [utils/D3plusConfig.ts:365](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L365) |
|
|
22381
|
+
| <a id="property-pointsize"></a> `pointSize?` | `string` \| ((`d`: `DataPoint`) => `number`) | Point size accessor for geomaps. | [utils/D3plusConfig.ts:367](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L367) |
|
|
22382
|
+
| <a id="property-pointsizemax"></a> `pointSizeMax?` | `number` | Maximum point size for geomaps. | [utils/D3plusConfig.ts:371](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L371) |
|
|
22383
|
+
| <a id="property-pointsizemin"></a> `pointSizeMin?` | `number` | Minimum point size for geomaps. | [utils/D3plusConfig.ts:369](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L369) |
|
|
22384
|
+
| <a id="property-projection"></a> `projection?` | `string` \| ((`x`: `number`, `y`: `number`) => \[`number`, `number`\]) | Map projection name or function. | [utils/D3plusConfig.ts:373](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L373) |
|
|
22385
|
+
| <a id="property-projectionpadding"></a> `projectionPadding?` | `string` \| `number` | Outer padding between the visualization edge and map shapes. | [utils/D3plusConfig.ts:375](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L375) |
|
|
22386
|
+
| <a id="property-projectionrotate"></a> `projectionRotate?` | \[`number`, `number`\] | Rotation offset for the map projection center. | [utils/D3plusConfig.ts:377](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L377) |
|
|
22387
|
+
| <a id="property-row"></a> `row?` | `string` | Row key for matrix-style layouts. | [utils/D3plusConfig.ts:379](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L379) |
|
|
22388
|
+
| <a id="property-scrollcontainer"></a> `scrollContainer?` | `string` \| `Window` | Scrollable container selector for tooltip positioning. | [utils/D3plusConfig.ts:381](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L381) |
|
|
22389
|
+
| <a id="property-shapeconfig"></a> `shapeConfig?` | `object` | Configuration for shape rendering. | [utils/D3plusConfig.ts:383](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L383) |
|
|
22390
|
+
| `shapeConfig.duration?` | `number` | - | [utils/D3plusConfig.ts:384](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L384) |
|
|
22391
|
+
| <a id="property-shapesort"></a> `shapeSort?` | (`a`: `string`, `b`: `string`) => `number` | A [sort comparator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) that receives each shape class (e.g. "Circle", "Line") as its arguments. Shapes are drawn in groups by type, so this defines the layering order for all shapes of a given type. | [utils/D3plusConfig.ts:393](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L393) |
|
|
22392
|
+
| <a id="property-size"></a> `size?` | `string` | Size accessor key. | [utils/D3plusConfig.ts:395](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L395) |
|
|
22393
|
+
| <a id="property-stacked"></a> `stacked?` | `boolean` | Whether to stack series. | [utils/D3plusConfig.ts:397](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L397) |
|
|
22394
|
+
| <a id="property-stackorder"></a> `stackOrder?` | `string`[] | Custom order for stacked series. | [utils/D3plusConfig.ts:399](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L399) |
|
|
22395
|
+
| <a id="property-subtitle"></a> `subtitle?` | `string` \| ((`data`: `DataPoint`[]) => `string`) | Subtitle text, or an accessor returning it. | [utils/D3plusConfig.ts:401](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L401) |
|
|
22396
|
+
| <a id="property-subtitlepadding"></a> `subtitlePadding?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) | Whether the subtitle uses the visualization's internal padding when positioning, or an accessor receiving the viz. | [utils/D3plusConfig.ts:403](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L403) |
|
|
22397
|
+
| <a id="property-sum"></a> `sum?` | `DataPointAccessor`\<`number`\> | Value accessor for treemaps and aggregation. | [utils/D3plusConfig.ts:405](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L405) |
|
|
22398
|
+
| <a id="property-svgdesc"></a> `svgDesc?` | `string` | Accessible description applied to the root SVG (`<desc>`). | [utils/D3plusConfig.ts:407](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L407) |
|
|
22399
|
+
| <a id="property-svgtitle"></a> `svgTitle?` | `string` | Accessible title applied to the root SVG (`<title>`). | [utils/D3plusConfig.ts:409](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L409) |
|
|
22400
|
+
| <a id="property-threshold"></a> `threshold?` | `number` | Threshold value for grouping small slices. | [utils/D3plusConfig.ts:411](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L411) |
|
|
22401
|
+
| <a id="property-thresholdname"></a> `thresholdName?` | `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`) | Label for the threshold group, or a `(datum, index)` accessor. | [utils/D3plusConfig.ts:413](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L413) |
|
|
22402
|
+
| <a id="property-tiles"></a> `tiles?` | `boolean` | Whether to show map tiles. | [utils/D3plusConfig.ts:417](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L417) |
|
|
22403
|
+
| <a id="property-tileurl"></a> `tileUrl?` | `string` | URL to XYZ map tiles. | [utils/D3plusConfig.ts:415](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L415) |
|
|
22404
|
+
| <a id="property-time"></a> `time?` | `string` | Time key for temporal data. | [utils/D3plusConfig.ts:419](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L419) |
|
|
22405
|
+
| <a id="property-timefilter"></a> `timeFilter?` | `false` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) | Predicate filtering which time slices are shown, or false to disable. | [utils/D3plusConfig.ts:421](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L421) |
|
|
22406
|
+
| <a id="property-timeline"></a> `timeline?` | `boolean` | Whether to show the timeline component. | [utils/D3plusConfig.ts:423](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L423) |
|
|
22407
|
+
| <a id="property-timelinepadding"></a> `timelinePadding?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) | Whether the timeline uses the visualization's internal padding when positioning, or an accessor receiving the viz. | [utils/D3plusConfig.ts:425](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L425) |
|
|
22408
|
+
| <a id="property-title-1"></a> `title?` | `string` \| ((`data`: `DataPoint`[]) => `string`) | Chart title or title accessor function. | [utils/D3plusConfig.ts:427](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L427) |
|
|
22409
|
+
| <a id="property-titleconfig"></a> `titleConfig?` | `Record`\<`string`, `string` \| `number`\> | CSS style configuration for the title. | [utils/D3plusConfig.ts:429](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L429) |
|
|
22410
|
+
| <a id="property-titlepadding"></a> `titlePadding?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) | Whether the title uses the visualization's internal padding when positioning, or an accessor receiving the viz. | [utils/D3plusConfig.ts:431](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L431) |
|
|
22411
|
+
| <a id="property-tooltip"></a> `tooltip?` | `boolean` \| ((`d`: `DataPoint`, `i`: `number`) => `boolean`) | Whether to show tooltips, or a `(datum, index)` accessor deciding per mark. | [utils/D3plusConfig.ts:433](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L433) |
|
|
22412
|
+
| <a id="property-tooltipconfig"></a> `tooltipConfig?` | [`TooltipConfig`](#tooltipconfig-3) | Configuration for the tooltip component. | [utils/D3plusConfig.ts:435](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L435) |
|
|
22413
|
+
| <a id="property-topojson"></a> `topojson?` | `string` \| `object` | Path or object for the topojson data. | [utils/D3plusConfig.ts:437](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L437) |
|
|
22414
|
+
| <a id="property-topojsonfill"></a> `topojsonFill?` | `string` | CSS color to fill the map shapes. | [utils/D3plusConfig.ts:439](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L439) |
|
|
22415
|
+
| <a id="property-topojsonid"></a> `topojsonId?` | (`obj`: `Record`\<`string`, `unknown`\>) => `string` | Accessor function for topojson feature IDs. | [utils/D3plusConfig.ts:441](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L441) |
|
|
22416
|
+
| <a id="property-totalpadding"></a> `totalPadding?` | `boolean` \| ((`viz`: `VizBase`) => `boolean`) | Whether the total uses the visualization's internal padding when positioning, or an accessor receiving the viz. | [utils/D3plusConfig.ts:443](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L443) |
|
|
22417
|
+
| <a id="property-value"></a> `value?` | `DataPointAccessor`\<`number`\> | Value accessor for the visualization. | [utils/D3plusConfig.ts:445](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L445) |
|
|
22418
|
+
| <a id="property-width-1"></a> `width?` | `number` | Overall width of the visualization in pixels. | [utils/D3plusConfig.ts:447](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L447) |
|
|
22419
|
+
| <a id="property-x-5"></a> `x?` | `string` \| `number` \| ((`d`: `DataPoint`, `i`: `number`) => `unknown`) | Key, index, or accessor function for x-axis values. | [utils/D3plusConfig.ts:449](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L449) |
|
|
22420
|
+
| <a id="property-x2domain"></a> `x2Domain?` | (`number` \| `Date`)[] | The x2 domain as an array. If either value is undefined, it is calculated from the data. | [utils/D3plusConfig.ts:455](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L455) |
|
|
22421
|
+
| <a id="property-x2sort"></a> `x2Sort?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` | Defines a custom sorting comparator function for discrete x2 axes. | [utils/D3plusConfig.ts:459](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L459) |
|
|
22422
|
+
| <a id="property-xconfig"></a> `xConfig?` | [`AxisConfig`](#axisconfig-2) | Configuration for the x-axis. | [utils/D3plusConfig.ts:451](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L451) |
|
|
22423
|
+
| <a id="property-xdomain"></a> `xDomain?` | (`number` \| `Date`)[] | The x domain as an array. If either value is undefined, it is calculated from the data. | [utils/D3plusConfig.ts:453](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L453) |
|
|
22424
|
+
| <a id="property-xsort"></a> `xSort?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` | Custom sort function for x-axis values. | [utils/D3plusConfig.ts:457](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L457) |
|
|
22425
|
+
| <a id="property-y-5"></a> `y?` | `string` \| `number` \| ((`d`: `DataPoint`, `i`: `number`) => `unknown`) | Key, index, or accessor function for y-axis values. | [utils/D3plusConfig.ts:461](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L461) |
|
|
22426
|
+
| <a id="property-y2domain"></a> `y2Domain?` | (`number` \| `Date`)[] | The y2 domain as an array. If either value is undefined, it is calculated from the data. | [utils/D3plusConfig.ts:467](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L467) |
|
|
22427
|
+
| <a id="property-y2sort"></a> `y2Sort?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` | Defines a custom sorting comparator function for discrete y2 axes. | [utils/D3plusConfig.ts:471](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L471) |
|
|
22428
|
+
| <a id="property-yconfig"></a> `yConfig?` | [`AxisConfig`](#axisconfig-2) | Configuration for the y-axis. | [utils/D3plusConfig.ts:463](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L463) |
|
|
22429
|
+
| <a id="property-ydomain"></a> `yDomain?` | (`number` \| `Date`)[] | The y domain as an array. If either value is undefined, it is calculated from the data. | [utils/D3plusConfig.ts:465](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L465) |
|
|
22430
|
+
| <a id="property-ysort"></a> `ySort?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` | Custom sort function for y-axis values. | [utils/D3plusConfig.ts:469](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L469) |
|
|
22431
|
+
| <a id="property-zoom"></a> `zoom?` | `boolean` | Set to false to disable zooming on Geomap and Network. | [utils/D3plusConfig.ts:473](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L473) |
|
|
22432
|
+
| <a id="property-zoomfactor"></a> `zoomFactor?` | `number` | Multiplier applied to programmatic zoom steps. | [utils/D3plusConfig.ts:475](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L475) |
|
|
22433
|
+
| <a id="property-zoommax"></a> `zoomMax?` | `number` | Maximum zoom scale factor. | [utils/D3plusConfig.ts:477](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L477) |
|
|
22434
|
+
| <a id="property-zoompan"></a> `zoomPan?` | `boolean` | Whether panning (drag) is enabled while zoomed. | [utils/D3plusConfig.ts:479](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L479) |
|
|
22435
|
+
| <a id="property-zoomscroll"></a> `zoomScroll?` | `boolean` | Whether scroll-wheel zooming is enabled. | [utils/D3plusConfig.ts:481](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L481) |
|
|
22425
22436
|
|
|
22426
22437
|
***
|
|
22427
22438
|
|
|
@@ -22455,15 +22466,15 @@ Image-specific config (url + dimensions).
|
|
|
22455
22466
|
|
|
22456
22467
|
### LegendConfig
|
|
22457
22468
|
|
|
22458
|
-
Defined in: [utils/D3plusConfig.ts:
|
|
22469
|
+
Defined in: [utils/D3plusConfig.ts:214](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L214)
|
|
22459
22470
|
|
|
22460
22471
|
#### Properties
|
|
22461
22472
|
|
|
22462
22473
|
| Property | Type | Description | Defined in |
|
|
22463
22474
|
| ------ | ------ | ------ | ------ |
|
|
22464
|
-
| <a id="property-active-5"></a> `active?` | `false` \| ((`d`: `DataPoint`, `i?`: `number`) => `boolean`) | The active method for all shapes. | [utils/D3plusConfig.ts:
|
|
22465
|
-
| <a id="property-hover-5"></a> `hover?` | `false` \| ((`d`: `DataPoint`, `i?`: `number`) => `boolean`) | The hover method for all shapes. | [utils/D3plusConfig.ts:
|
|
22466
|
-
| <a id="property-shape"></a> `shape?` | `Accessor`\<`string`\> | The shape type used for each legend entry. | [utils/D3plusConfig.ts:
|
|
22475
|
+
| <a id="property-active-5"></a> `active?` | `false` \| ((`d`: `DataPoint`, `i?`: `number`) => `boolean`) | The active method for all shapes. | [utils/D3plusConfig.ts:216](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L216) |
|
|
22476
|
+
| <a id="property-hover-5"></a> `hover?` | `false` \| ((`d`: `DataPoint`, `i?`: `number`) => `boolean`) | The hover method for all shapes. | [utils/D3plusConfig.ts:218](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L218) |
|
|
22477
|
+
| <a id="property-shape"></a> `shape?` | `Accessor`\<`string`\> | The shape type used for each legend entry. | [utils/D3plusConfig.ts:220](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L220) |
|
|
22467
22478
|
|
|
22468
22479
|
***
|
|
22469
22480
|
|
|
@@ -22715,34 +22726,34 @@ Rect-specific config (width + height on top of base).
|
|
|
22715
22726
|
|
|
22716
22727
|
### TextBoxConfig
|
|
22717
22728
|
|
|
22718
|
-
Defined in: [utils/D3plusConfig.ts:
|
|
22729
|
+
Defined in: [utils/D3plusConfig.ts:121](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L121)
|
|
22719
22730
|
|
|
22720
22731
|
#### Properties
|
|
22721
22732
|
|
|
22722
22733
|
| Property | Type | Description | Defined in |
|
|
22723
22734
|
| ------ | ------ | ------ | ------ |
|
|
22724
|
-
| <a id="property-ellipsis"></a> `ellipsis?` | (`text`: `string`, `line`: `number`) => `string` | Handles truncated lines, returning the new line value. Passed the line's text and number; by default appends an ellipsis to every line except a first word that cannot fit (which returns ""). | [utils/D3plusConfig.ts:
|
|
22725
|
-
| <a id="property-fontcolor"></a> `fontColor?` | `Accessor`\<`string`\> | The font color as an accessor function or static string. Inferred from the DOM selection by default. | [utils/D3plusConfig.ts:
|
|
22726
|
-
| <a id="property-fontfamily"></a> `fontFamily?` | `Accessor`\<`string` \| `string`[]\> | The font-family to use: a font name, a comma-separated list of fallbacks, an array of fallbacks, or an accessor returning a string or array. The first available font on the client is used. | [utils/D3plusConfig.ts:
|
|
22727
|
-
| <a id="property-fontmax"></a> `fontMax?` | `number` | The maximum font size in pixels, used when dynamically resizing fonts. | [utils/D3plusConfig.ts:
|
|
22728
|
-
| <a id="property-fontmin"></a> `fontMin?` | `number` | The minimum font size in pixels, used when dynamically resizing fonts. | [utils/D3plusConfig.ts:
|
|
22729
|
-
| <a id="property-fontopacity"></a> `fontOpacity?` | `Accessor`\<`number`\> | The font opacity as an accessor function or static number between 0 and 1. | [utils/D3plusConfig.ts:
|
|
22730
|
-
| <a id="property-fontresize"></a> `fontResize?` | `Accessor`\<`boolean`\> | Toggles font resizing — a static boolean, or an accessor returning a boolean. | [utils/D3plusConfig.ts:
|
|
22731
|
-
| <a id="property-fontsize"></a> `fontSize?` | `Accessor`\<`number`\> | The font size in pixels. Inferred from the DOM selection by default. | [utils/D3plusConfig.ts:
|
|
22732
|
-
| <a id="property-fontstroke"></a> `fontStroke?` | `Accessor`\<`string`\> | The font stroke color for the rendered text. | [utils/D3plusConfig.ts:
|
|
22733
|
-
| <a id="property-fontstrokewidth"></a> `fontStrokeWidth?` | `Accessor`\<`number`\> | The font stroke width for the rendered text. | [utils/D3plusConfig.ts:
|
|
22734
|
-
| <a id="property-fontweight"></a> `fontWeight?` | `Accessor`\<`string` \| `number`\> | The font weight. Inferred from the DOM selection by default. | [utils/D3plusConfig.ts:
|
|
22735
|
-
| <a id="property-height-4"></a> `height?` | `Accessor`\<`number`\> | The height for each text box. | [utils/D3plusConfig.ts:
|
|
22736
|
-
| <a id="property-lineheight"></a> `lineHeight?` | `Accessor`\<`number`\> | The line height, which is 1.2 times the font size by default. | [utils/D3plusConfig.ts:
|
|
22737
|
-
| <a id="property-maxlines"></a> `maxLines?` | `Accessor`\<`number` \| `null`\> | Restricts the maximum number of lines to wrap onto; null (unlimited) by default. | [utils/D3plusConfig.ts:
|
|
22738
|
-
| <a id="property-overflow"></a> `overflow?` | `Accessor`\<`boolean`\> | Whether text is allowed to overflow its bounding box. | [utils/D3plusConfig.ts:
|
|
22739
|
-
| <a id="property-padding"></a> `padding?` | `Accessor`\<`string` \| `number`\> | The padding as a CSS shorthand string or number. Defaults to 0. | [utils/D3plusConfig.ts:
|
|
22740
|
-
| <a id="property-rotateanchor"></a> `rotateAnchor?` | `Accessor`\<\[`number`, `number`\]\> | The anchor point around which to rotate the text box. | [utils/D3plusConfig.ts:
|
|
22741
|
-
| <a id="property-split"></a> `split?` | (`text`: `string`) => `string`[] | The word split function: given a string, returns it split into an array of words. | [utils/D3plusConfig.ts:
|
|
22742
|
-
| <a id="property-text"></a> `text?` | `Accessor`\<`string`\> | The text content for each box. | [utils/D3plusConfig.ts:
|
|
22743
|
-
| <a id="property-width-4"></a> `width?` | `Accessor`\<`number`\> | The width for each text box. | [utils/D3plusConfig.ts:
|
|
22744
|
-
| <a id="property-x-10"></a> `x?` | `Accessor`\<`number`\> | The x position (left edge) for each text box. | [utils/D3plusConfig.ts:
|
|
22745
|
-
| <a id="property-y-10"></a> `y?` | `Accessor`\<`number`\> | The y position (top edge) for each text box. | [utils/D3plusConfig.ts:
|
|
22735
|
+
| <a id="property-ellipsis"></a> `ellipsis?` | (`text`: `string`, `line`: `number`) => `string` | Handles truncated lines, returning the new line value. Passed the line's text and number; by default appends an ellipsis to every line except a first word that cannot fit (which returns ""). | [utils/D3plusConfig.ts:159](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L159) |
|
|
22736
|
+
| <a id="property-fontcolor"></a> `fontColor?` | `Accessor`\<`string`\> | The font color as an accessor function or static string. Inferred from the DOM selection by default. | [utils/D3plusConfig.ts:125](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L125) |
|
|
22737
|
+
| <a id="property-fontfamily"></a> `fontFamily?` | `Accessor`\<`string` \| `string`[]\> | The font-family to use: a font name, a comma-separated list of fallbacks, an array of fallbacks, or an accessor returning a string or array. The first available font on the client is used. | [utils/D3plusConfig.ts:133](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L133) |
|
|
22738
|
+
| <a id="property-fontmax"></a> `fontMax?` | `number` | The maximum font size in pixels, used when dynamically resizing fonts. | [utils/D3plusConfig.ts:139](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L139) |
|
|
22739
|
+
| <a id="property-fontmin"></a> `fontMin?` | `number` | The minimum font size in pixels, used when dynamically resizing fonts. | [utils/D3plusConfig.ts:137](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L137) |
|
|
22740
|
+
| <a id="property-fontopacity"></a> `fontOpacity?` | `Accessor`\<`number`\> | The font opacity as an accessor function or static number between 0 and 1. | [utils/D3plusConfig.ts:143](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L143) |
|
|
22741
|
+
| <a id="property-fontresize"></a> `fontResize?` | `Accessor`\<`boolean`\> | Toggles font resizing — a static boolean, or an accessor returning a boolean. | [utils/D3plusConfig.ts:141](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L141) |
|
|
22742
|
+
| <a id="property-fontsize"></a> `fontSize?` | `Accessor`\<`number`\> | The font size in pixels. Inferred from the DOM selection by default. | [utils/D3plusConfig.ts:127](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L127) |
|
|
22743
|
+
| <a id="property-fontstroke"></a> `fontStroke?` | `Accessor`\<`string`\> | The font stroke color for the rendered text. | [utils/D3plusConfig.ts:145](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L145) |
|
|
22744
|
+
| <a id="property-fontstrokewidth"></a> `fontStrokeWidth?` | `Accessor`\<`number`\> | The font stroke width for the rendered text. | [utils/D3plusConfig.ts:147](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L147) |
|
|
22745
|
+
| <a id="property-fontweight"></a> `fontWeight?` | `Accessor`\<`string` \| `number`\> | The font weight. Inferred from the DOM selection by default. | [utils/D3plusConfig.ts:135](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L135) |
|
|
22746
|
+
| <a id="property-height-4"></a> `height?` | `Accessor`\<`number`\> | The height for each text box. | [utils/D3plusConfig.ts:169](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L169) |
|
|
22747
|
+
| <a id="property-lineheight"></a> `lineHeight?` | `Accessor`\<`number`\> | The line height, which is 1.2 times the font size by default. | [utils/D3plusConfig.ts:149](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L149) |
|
|
22748
|
+
| <a id="property-maxlines"></a> `maxLines?` | `Accessor`\<`number` \| `null`\> | Restricts the maximum number of lines to wrap onto; null (unlimited) by default. | [utils/D3plusConfig.ts:151](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L151) |
|
|
22749
|
+
| <a id="property-overflow"></a> `overflow?` | `Accessor`\<`boolean`\> | Whether text is allowed to overflow its bounding box. | [utils/D3plusConfig.ts:153](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L153) |
|
|
22750
|
+
| <a id="property-padding"></a> `padding?` | `Accessor`\<`string` \| `number`\> | The padding as a CSS shorthand string or number. Defaults to 0. | [utils/D3plusConfig.ts:161](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L161) |
|
|
22751
|
+
| <a id="property-rotateanchor"></a> `rotateAnchor?` | `Accessor`\<\[`number`, `number`\]\> | The anchor point around which to rotate the text box. | [utils/D3plusConfig.ts:163](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L163) |
|
|
22752
|
+
| <a id="property-split"></a> `split?` | (`text`: `string`) => `string`[] | The word split function: given a string, returns it split into an array of words. | [utils/D3plusConfig.ts:165](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L165) |
|
|
22753
|
+
| <a id="property-text"></a> `text?` | `Accessor`\<`string`\> | The text content for each box. | [utils/D3plusConfig.ts:123](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L123) |
|
|
22754
|
+
| <a id="property-width-4"></a> `width?` | `Accessor`\<`number`\> | The width for each text box. | [utils/D3plusConfig.ts:167](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L167) |
|
|
22755
|
+
| <a id="property-x-10"></a> `x?` | `Accessor`\<`number`\> | The x position (left edge) for each text box. | [utils/D3plusConfig.ts:171](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L171) |
|
|
22756
|
+
| <a id="property-y-10"></a> `y?` | `Accessor`\<`number`\> | The y position (top edge) for each text box. | [utils/D3plusConfig.ts:173](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L173) |
|
|
22746
22757
|
|
|
22747
22758
|
***
|
|
22748
22759
|
|
|
@@ -22750,24 +22761,24 @@ Defined in: [utils/D3plusConfig.ts:120](https://github.com/d3plus/d3plus/blob/ma
|
|
|
22750
22761
|
|
|
22751
22762
|
### TimelineConfig
|
|
22752
22763
|
|
|
22753
|
-
Defined in: [utils/D3plusConfig.ts:
|
|
22764
|
+
Defined in: [utils/D3plusConfig.ts:176](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L176)
|
|
22754
22765
|
|
|
22755
22766
|
#### Properties
|
|
22756
22767
|
|
|
22757
22768
|
| Property | Type | Description | Defined in |
|
|
22758
22769
|
| ------ | ------ | ------ | ------ |
|
|
22759
|
-
| <a id="property-brushfilter"></a> `brushFilter?` | () => `boolean` | Brush event filter. | [utils/D3plusConfig.ts:
|
|
22760
|
-
| <a id="property-brushmin"></a> `brushMin?` | `number` | The minimum number of ticks that can be highlighted when using "ticks" `buttonBehavior`. Helpful for x/y plots where selecting fewer than 2 time periods is undesirable. | [utils/D3plusConfig.ts:
|
|
22761
|
-
| <a id="property-buttonalign"></a> `buttonAlign?` | `"middle"` \| `"end"` \| `"start"` | Toggles the horizontal alignment of the button timeline. | [utils/D3plusConfig.ts:
|
|
22762
|
-
| <a id="property-buttonbehavior"></a> `buttonBehavior?` | `"auto"` \| `"buttons"` \| `"ticks"` | Toggles the style of the timeline. | [utils/D3plusConfig.ts:
|
|
22763
|
-
| <a id="property-buttonheight"></a> `buttonHeight?` | `number` | Button height. | [utils/D3plusConfig.ts:
|
|
22764
|
-
| <a id="property-buttonpadding"></a> `buttonPadding?` | `number` | Button padding. | [utils/D3plusConfig.ts:
|
|
22765
|
-
| <a id="property-handleconfig"></a> `handleConfig?` | `Record`\<`string`, `unknown`\> | Handle style. | [utils/D3plusConfig.ts:
|
|
22766
|
-
| <a id="property-handlesize"></a> `handleSize?` | `number` | Handle size. | [utils/D3plusConfig.ts:
|
|
22767
|
-
| <a id="property-playbutton"></a> `playButton?` | `boolean` | Determines the visibility of the play button to the left of the timeline, which cycles through the available periods at a rate set by `playButtonInterval`. | [utils/D3plusConfig.ts:
|
|
22768
|
-
| <a id="property-playbuttoninterval"></a> `playButtonInterval?` | `number` | The interval, in milliseconds, between periods when cycling via the play button. Used only when the chart's `duration` is 0 (no transition); otherwise playback steps once per `duration` so each step animates in full. | [utils/D3plusConfig.ts:
|
|
22769
|
-
| <a id="property-selection"></a> `selection?` | `number` \| `false` \| `Date` \| (`number` \| `Date`)[] | The current selection. Defaults to the most recent period in the timeline. | [utils/D3plusConfig.ts:
|
|
22770
|
-
| <a id="property-snapping"></a> `snapping?` | `boolean` | Toggles the snapping value. | [utils/D3plusConfig.ts:
|
|
22770
|
+
| <a id="property-brushfilter"></a> `brushFilter?` | () => `boolean` | Brush event filter. | [utils/D3plusConfig.ts:178](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L178) |
|
|
22771
|
+
| <a id="property-brushmin"></a> `brushMin?` | `number` | The minimum number of ticks that can be highlighted when using "ticks" `buttonBehavior`. Helpful for x/y plots where selecting fewer than 2 time periods is undesirable. | [utils/D3plusConfig.ts:184](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L184) |
|
|
22772
|
+
| <a id="property-buttonalign"></a> `buttonAlign?` | `"middle"` \| `"end"` \| `"start"` | Toggles the horizontal alignment of the button timeline. | [utils/D3plusConfig.ts:186](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L186) |
|
|
22773
|
+
| <a id="property-buttonbehavior"></a> `buttonBehavior?` | `"auto"` \| `"buttons"` \| `"ticks"` | Toggles the style of the timeline. | [utils/D3plusConfig.ts:188](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L188) |
|
|
22774
|
+
| <a id="property-buttonheight"></a> `buttonHeight?` | `number` | Button height. | [utils/D3plusConfig.ts:190](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L190) |
|
|
22775
|
+
| <a id="property-buttonpadding"></a> `buttonPadding?` | `number` | Button padding. | [utils/D3plusConfig.ts:192](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L192) |
|
|
22776
|
+
| <a id="property-handleconfig"></a> `handleConfig?` | `Record`\<`string`, `unknown`\> | Handle style. | [utils/D3plusConfig.ts:194](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L194) |
|
|
22777
|
+
| <a id="property-handlesize"></a> `handleSize?` | `number` | Handle size. | [utils/D3plusConfig.ts:196](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L196) |
|
|
22778
|
+
| <a id="property-playbutton"></a> `playButton?` | `boolean` | Determines the visibility of the play button to the left of the timeline, which cycles through the available periods at a rate set by `playButtonInterval`. | [utils/D3plusConfig.ts:201](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L201) |
|
|
22779
|
+
| <a id="property-playbuttoninterval"></a> `playButtonInterval?` | `number` | The interval, in milliseconds, between periods when cycling via the play button. Used only when the chart's `duration` is 0 (no transition); otherwise playback steps once per `duration` so each step animates in full. | [utils/D3plusConfig.ts:207](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L207) |
|
|
22780
|
+
| <a id="property-selection"></a> `selection?` | `number` \| `false` \| `Date` \| (`number` \| `Date`)[] | The current selection. Defaults to the most recent period in the timeline. | [utils/D3plusConfig.ts:209](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L209) |
|
|
22781
|
+
| <a id="property-snapping"></a> `snapping?` | `boolean` | Toggles the snapping value. | [utils/D3plusConfig.ts:211](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L211) |
|
|
22771
22782
|
|
|
22772
22783
|
***
|
|
22773
22784
|
|
|
@@ -22775,25 +22786,25 @@ Defined in: [utils/D3plusConfig.ts:175](https://github.com/d3plus/d3plus/blob/ma
|
|
|
22775
22786
|
|
|
22776
22787
|
### TooltipConfig
|
|
22777
22788
|
|
|
22778
|
-
Defined in: [utils/D3plusConfig.ts:
|
|
22789
|
+
Defined in: [utils/D3plusConfig.ts:82](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L82)
|
|
22779
22790
|
|
|
22780
22791
|
#### Properties
|
|
22781
22792
|
|
|
22782
22793
|
| Property | Type | Description | Defined in |
|
|
22783
22794
|
| ------ | ------ | ------ | ------ |
|
|
22784
|
-
| <a id="property-arrow"></a> `arrow?` | `string` \| ((`d`: `DataPoint`) => `string`) | The inner HTML content of the arrow element, empty by default. | [utils/D3plusConfig.ts:
|
|
22785
|
-
| <a id="property-background"></a> `background?` | `string` \| ((`d`: `DataPoint`) => `string`) | The background color accessor for each tooltip. | [utils/D3plusConfig.ts:
|
|
22786
|
-
| <a id="property-body"></a> `body?` | `string` \| ((`d`: `DataPoint`) => `string`) | - | [utils/D3plusConfig.ts:
|
|
22787
|
-
| <a id="property-border"></a> `border?` | `string` \| ((`d`: `DataPoint`) => `string`) | The border accessor for each tooltip. | [utils/D3plusConfig.ts:
|
|
22788
|
-
| <a id="property-borderradius"></a> `borderRadius?` | `string` \| ((`d`: `DataPoint`) => `string`) | The border-radius accessor for each tooltip. | [utils/D3plusConfig.ts:
|
|
22789
|
-
| <a id="property-footer"></a> `footer?` | `string` \| ((`d`: `DataPoint`) => `string`) | The footer content accessor for each tooltip. | [utils/D3plusConfig.ts:
|
|
22790
|
-
| <a id="property-maxwidth"></a> `maxWidth?` | `string` \| `number` \| ((`d`: `DataPoint`) => `string` \| `number`) | The max-width accessor for each tooltip. | [utils/D3plusConfig.ts:
|
|
22791
|
-
| <a id="property-minwidth"></a> `minWidth?` | `string` \| `number` \| ((`d`: `DataPoint`) => `string` \| `number`) | The min-width accessor for each tooltip. | [utils/D3plusConfig.ts:
|
|
22792
|
-
| <a id="property-offset"></a> `offset?` | `number` \| ((`d`: `DataPoint`) => `number`) | The pixel offset between the tooltip and its anchor point. | [utils/D3plusConfig.ts:
|
|
22793
|
-
| <a id="property-padding-1"></a> `padding?` | `string` \| `number` \| ((`d`: `DataPoint`) => `string` \| `number`) | The inner padding of each tooltip. | [utils/D3plusConfig.ts:
|
|
22794
|
-
| <a id="property-tbody"></a> `tbody?` | ((`d`: `DataPoint`) => \[`string`, `string`\][]) \| (`string` \| ((`d`: `DataPoint`, `i?`: `number`, `x?`: `object`) => `string`))[][] | - | [utils/D3plusConfig.ts:
|
|
22795
|
-
| <a id="property-thead"></a> `thead?` | ((`d`: `DataPoint`) => \[`string`, `string`\][]) \| (`string` \| ((`d`: `DataPoint`, `i?`: `number`, `x?`: `object`) => `string`))[][] | - | [utils/D3plusConfig.ts:
|
|
22796
|
-
| <a id="property-title-2"></a> `title?` | `string` \| ((`d`: `DataPoint`) => `string`) | - | [utils/D3plusConfig.ts:
|
|
22795
|
+
| <a id="property-arrow"></a> `arrow?` | `string` \| ((`d`: `DataPoint`) => `string`) | The inner HTML content of the arrow element, empty by default. | [utils/D3plusConfig.ts:84](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L84) |
|
|
22796
|
+
| <a id="property-background"></a> `background?` | `string` \| ((`d`: `DataPoint`) => `string`) | The background color accessor for each tooltip. | [utils/D3plusConfig.ts:86](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L86) |
|
|
22797
|
+
| <a id="property-body"></a> `body?` | `string` \| ((`d`: `DataPoint`) => `string`) | - | [utils/D3plusConfig.ts:102](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L102) |
|
|
22798
|
+
| <a id="property-border"></a> `border?` | `string` \| ((`d`: `DataPoint`) => `string`) | The border accessor for each tooltip. | [utils/D3plusConfig.ts:88](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L88) |
|
|
22799
|
+
| <a id="property-borderradius"></a> `borderRadius?` | `string` \| ((`d`: `DataPoint`) => `string`) | The border-radius accessor for each tooltip. | [utils/D3plusConfig.ts:90](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L90) |
|
|
22800
|
+
| <a id="property-footer"></a> `footer?` | `string` \| ((`d`: `DataPoint`) => `string`) | The footer content accessor for each tooltip. | [utils/D3plusConfig.ts:92](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L92) |
|
|
22801
|
+
| <a id="property-maxwidth"></a> `maxWidth?` | `string` \| `number` \| ((`d`: `DataPoint`) => `string` \| `number`) | The max-width accessor for each tooltip. | [utils/D3plusConfig.ts:94](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L94) |
|
|
22802
|
+
| <a id="property-minwidth"></a> `minWidth?` | `string` \| `number` \| ((`d`: `DataPoint`) => `string` \| `number`) | The min-width accessor for each tooltip. | [utils/D3plusConfig.ts:96](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L96) |
|
|
22803
|
+
| <a id="property-offset"></a> `offset?` | `number` \| ((`d`: `DataPoint`) => `number`) | The pixel offset between the tooltip and its anchor point. | [utils/D3plusConfig.ts:98](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L98) |
|
|
22804
|
+
| <a id="property-padding-1"></a> `padding?` | `string` \| `number` \| ((`d`: `DataPoint`) => `string` \| `number`) | The inner padding of each tooltip. | [utils/D3plusConfig.ts:100](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L100) |
|
|
22805
|
+
| <a id="property-tbody"></a> `tbody?` | ((`d`: `DataPoint`) => \[`string`, `string`\][]) \| (`string` \| ((`d`: `DataPoint`, `i?`: `number`, `x?`: `object`) => `string`))[][] | - | [utils/D3plusConfig.ts:111](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L111) |
|
|
22806
|
+
| <a id="property-thead"></a> `thead?` | ((`d`: `DataPoint`) => \[`string`, `string`\][]) \| (`string` \| ((`d`: `DataPoint`, `i?`: `number`, `x?`: `object`) => `string`))[][] | - | [utils/D3plusConfig.ts:103](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L103) |
|
|
22807
|
+
| <a id="property-title-2"></a> `title?` | `string` \| ((`d`: `DataPoint`) => `string`) | - | [utils/D3plusConfig.ts:101](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L101) |
|
|
22797
22808
|
|
|
22798
22809
|
***
|
|
22799
22810
|
|