@d3plus/core 4.1.0 → 4.3.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 +781 -688
- package/es/src/charts/AreaPlot/index.js +2 -1
- package/es/src/charts/AreaPlot/index.js.map +1 -1
- package/es/src/charts/BarChart/index.js +3 -1
- package/es/src/charts/BarChart/index.js.map +1 -1
- package/es/src/charts/BoxWhisker/index.js +2 -1
- package/es/src/charts/BoxWhisker/index.js.map +1 -1
- package/es/src/charts/BumpChart/index.js +2 -1
- package/es/src/charts/BumpChart/index.js.map +1 -1
- package/es/src/charts/Geomap/emit.js +44 -4
- package/es/src/charts/Geomap/emit.js.map +1 -1
- package/es/src/charts/Geomap/index.js +32 -2
- package/es/src/charts/Geomap/index.js.map +1 -1
- package/es/src/charts/LinePlot/index.js +2 -1
- package/es/src/charts/LinePlot/index.js.map +1 -1
- package/es/src/charts/Matrix/index.js +1 -0
- package/es/src/charts/Matrix/index.js.map +1 -1
- package/es/src/charts/Network/index.js +2 -1
- package/es/src/charts/Network/index.js.map +1 -1
- package/es/src/charts/Pack/index.js +1 -0
- package/es/src/charts/Pack/index.js.map +1 -1
- package/es/src/charts/Pie/index.js +1 -0
- package/es/src/charts/Pie/index.js.map +1 -1
- package/es/src/charts/Plot/index.js +99 -14
- package/es/src/charts/Plot/index.js.map +1 -1
- package/es/src/charts/Plot/pipeline.js +24 -3
- package/es/src/charts/Plot/pipeline.js.map +1 -1
- package/es/src/charts/Plot/pipelineDomains.js +3 -3
- package/es/src/charts/Plot/pipelineDomains.js.map +1 -1
- package/es/src/charts/Plot/stackHelpers.js +128 -9
- package/es/src/charts/Plot/stackHelpers.js.map +1 -1
- package/es/src/charts/Radar/index.js +2 -1
- package/es/src/charts/Radar/index.js.map +1 -1
- package/es/src/charts/RadialMatrix/index.js +1 -0
- package/es/src/charts/RadialMatrix/index.js.map +1 -1
- package/es/src/charts/Rings/index.js +2 -1
- package/es/src/charts/Rings/index.js.map +1 -1
- package/es/src/charts/Sankey/index.js +2 -1
- package/es/src/charts/Sankey/index.js.map +1 -1
- package/es/src/charts/Tree/index.js +2 -1
- package/es/src/charts/Tree/index.js.map +1 -1
- package/es/src/charts/Treemap/index.js +1 -0
- package/es/src/charts/Treemap/index.js.map +1 -1
- package/es/src/charts/features/shapeEmit.js +3 -1
- package/es/src/charts/features/shapeEmit.js.map +1 -1
- package/es/src/charts/viz/Viz.js +63 -10
- package/es/src/charts/viz/Viz.js.map +1 -1
- package/es/src/charts/viz/interactionOpacity.js +4 -1
- package/es/src/charts/viz/interactionOpacity.js.map +1 -1
- package/es/src/charts/viz/vizDefaults.js +4 -1
- package/es/src/charts/viz/vizDefaults.js.map +1 -1
- package/es/src/charts/viz/vizRender.js +7 -3
- package/es/src/charts/viz/vizRender.js.map +1 -1
- package/es/src/charts/viz/vizTypes.js.map +1 -1
- package/es/src/shapes/Image.js +2 -3
- package/es/src/shapes/Image.js.map +1 -1
- package/es/src/shapes/Shape.js +47 -46
- package/es/src/shapes/Shape.js.map +1 -1
- package/es/src/shapes/hitAreaNode.js +31 -5
- package/es/src/shapes/hitAreaNode.js.map +1 -1
- package/es/src/shapes/interactionPoints.js +30 -0
- package/es/src/shapes/interactionPoints.js.map +1 -0
- package/es/src/shapes/sceneSort.js +304 -24
- package/es/src/shapes/sceneSort.js.map +1 -1
- package/es/src/shapes/shapeConfig.js.map +1 -1
- package/es/src/utils/D3plusConfig.js.map +1 -1
- package/package.json +9 -9
- package/types/src/charts/Plot/index.d.ts +44 -7
- package/types/src/charts/Plot/pipeline.d.ts +2 -1
- package/types/src/charts/Plot/stackHelpers.d.ts +62 -4
- package/types/src/charts/viz/Viz.d.ts +31 -1
- package/types/src/charts/viz/vizTypes.d.ts +18 -0
- package/types/src/shapes/Image.d.ts +2 -3
- package/types/src/shapes/Shape.d.ts +2 -4
- package/types/src/shapes/hitAreaNode.d.ts +5 -4
- package/types/src/shapes/interactionPoints.d.ts +15 -0
- package/types/src/shapes/sceneSort.d.ts +83 -8
- package/types/src/shapes/shapeConfig.d.ts +7 -0
- package/types/src/utils/D3plusConfig.d.ts +19 -2
- package/umd/d3plus-core.full.js +2371 -672
- package/umd/d3plus-core.full.js.map +1 -1
- package/umd/d3plus-core.full.min.js +1506 -1156
- package/umd/d3plus-core.js +804 -259
- package/umd/d3plus-core.js.map +1 -1
- package/umd/d3plus-core.min.js +591 -390
package/README.md
CHANGED
|
@@ -143,7 +143,7 @@ Creates SVG areas based on an array of data.
|
|
|
143
143
|
|
|
144
144
|
> **active**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
145
145
|
|
|
146
|
-
Defined in: [shapes/Shape.ts:
|
|
146
|
+
Defined in: [shapes/Shape.ts:632](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L632)
|
|
147
147
|
|
|
148
148
|
The active callback function for highlighting shapes.
|
|
149
149
|
|
|
@@ -159,7 +159,7 @@ The active callback function for highlighting shapes.
|
|
|
159
159
|
|
|
160
160
|
> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
161
161
|
|
|
162
|
-
Defined in: [shapes/Shape.ts:
|
|
162
|
+
Defined in: [shapes/Shape.ts:633](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L633)
|
|
163
163
|
|
|
164
164
|
The active callback function for highlighting shapes.
|
|
165
165
|
|
|
@@ -185,7 +185,7 @@ The active callback function for highlighting shapes.
|
|
|
185
185
|
|
|
186
186
|
> **activeStyle**(): `Record`\<`string`, `unknown`\>
|
|
187
187
|
|
|
188
|
-
Defined in: [shapes/Shape.ts:
|
|
188
|
+
Defined in: [shapes/Shape.ts:647](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L647)
|
|
189
189
|
|
|
190
190
|
The style to apply to active shapes.
|
|
191
191
|
|
|
@@ -201,7 +201,7 @@ The style to apply to active shapes.
|
|
|
201
201
|
|
|
202
202
|
> **activeStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
203
203
|
|
|
204
|
-
Defined in: [shapes/Shape.ts:
|
|
204
|
+
Defined in: [shapes/Shape.ts:648](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L648)
|
|
205
205
|
|
|
206
206
|
The style to apply to active shapes.
|
|
207
207
|
|
|
@@ -273,7 +273,7 @@ keys (e.g. `width`/`height` for Rect) in autocomplete + type checks.
|
|
|
273
273
|
|
|
274
274
|
> **data**(): `DataPoint`[]
|
|
275
275
|
|
|
276
|
-
Defined in: [shapes/Shape.ts:
|
|
276
|
+
Defined in: [shapes/Shape.ts:659](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L659)
|
|
277
277
|
|
|
278
278
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
279
279
|
|
|
@@ -289,7 +289,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
289
289
|
|
|
290
290
|
> **data**(`_`: `DataPoint`[]): `this`
|
|
291
291
|
|
|
292
|
-
Defined in: [shapes/Shape.ts:
|
|
292
|
+
Defined in: [shapes/Shape.ts:660](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L660)
|
|
293
293
|
|
|
294
294
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
295
295
|
|
|
@@ -315,7 +315,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
315
315
|
|
|
316
316
|
> **hover**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
317
317
|
|
|
318
|
-
Defined in: [shapes/Shape.ts:
|
|
318
|
+
Defined in: [shapes/Shape.ts:668](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L668)
|
|
319
319
|
|
|
320
320
|
The hover callback function for highlighting shapes on mouseover.
|
|
321
321
|
|
|
@@ -331,7 +331,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
331
331
|
|
|
332
332
|
> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
333
333
|
|
|
334
|
-
Defined in: [shapes/Shape.ts:
|
|
334
|
+
Defined in: [shapes/Shape.ts:669](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L669)
|
|
335
335
|
|
|
336
336
|
The hover callback function for highlighting shapes on mouseover.
|
|
337
337
|
|
|
@@ -357,7 +357,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
357
357
|
|
|
358
358
|
> **hoverStyle**(): `Record`\<`string`, `unknown`\>
|
|
359
359
|
|
|
360
|
-
Defined in: [shapes/Shape.ts:
|
|
360
|
+
Defined in: [shapes/Shape.ts:682](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L682)
|
|
361
361
|
|
|
362
362
|
The style to apply to hovered shapes.
|
|
363
363
|
|
|
@@ -373,7 +373,7 @@ The style to apply to hovered shapes.
|
|
|
373
373
|
|
|
374
374
|
> **hoverStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
375
375
|
|
|
376
|
-
Defined in: [shapes/Shape.ts:
|
|
376
|
+
Defined in: [shapes/Shape.ts:683](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L683)
|
|
377
377
|
|
|
378
378
|
The style to apply to hovered shapes.
|
|
379
379
|
|
|
@@ -399,7 +399,7 @@ The style to apply to hovered shapes.
|
|
|
399
399
|
|
|
400
400
|
> **labelConfig**(): `Record`\<`string`, `unknown`\>
|
|
401
401
|
|
|
402
|
-
Defined in: [shapes/Shape.ts:
|
|
402
|
+
Defined in: [shapes/Shape.ts:693](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L693)
|
|
403
403
|
|
|
404
404
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
405
405
|
|
|
@@ -415,7 +415,7 @@ A pass-through to the config method of the TextBox class used to create a shape'
|
|
|
415
415
|
|
|
416
416
|
> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
417
417
|
|
|
418
|
-
Defined in: [shapes/Shape.ts:
|
|
418
|
+
Defined in: [shapes/Shape.ts:694](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L694)
|
|
419
419
|
|
|
420
420
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
421
421
|
|
|
@@ -688,7 +688,7 @@ Parent config used by the wrapper.
|
|
|
688
688
|
|
|
689
689
|
> **render**(`callback?`: () => `void`): `this`
|
|
690
690
|
|
|
691
|
-
Defined in: [shapes/Shape.ts:
|
|
691
|
+
Defined in: [shapes/Shape.ts:524](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L524)
|
|
692
692
|
|
|
693
693
|
###### Parameters
|
|
694
694
|
|
|
@@ -712,7 +712,7 @@ Defined in: [shapes/Shape.ts:518](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
712
712
|
|
|
713
713
|
> **select**(): `Selection`
|
|
714
714
|
|
|
715
|
-
Defined in: [shapes/Shape.ts:
|
|
715
|
+
Defined in: [shapes/Shape.ts:704](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L704)
|
|
716
716
|
|
|
717
717
|
The SVG container element as a d3 selector or DOM element.
|
|
718
718
|
|
|
@@ -728,7 +728,7 @@ The SVG container element as a d3 selector or DOM element.
|
|
|
728
728
|
|
|
729
729
|
> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`
|
|
730
730
|
|
|
731
|
-
Defined in: [shapes/Shape.ts:
|
|
731
|
+
Defined in: [shapes/Shape.ts:705](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L705)
|
|
732
732
|
|
|
733
733
|
The SVG container element as a d3 selector or DOM element.
|
|
734
734
|
|
|
@@ -796,7 +796,7 @@ Configuration object with key/value pairs applied as method calls on each shape.
|
|
|
796
796
|
|
|
797
797
|
> **sort**(): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`
|
|
798
798
|
|
|
799
|
-
Defined in: [shapes/Shape.ts:
|
|
799
|
+
Defined in: [shapes/Shape.ts:715](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L715)
|
|
800
800
|
|
|
801
801
|
A comparator function used to sort shapes for layering order.
|
|
802
802
|
|
|
@@ -812,7 +812,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
812
812
|
|
|
813
813
|
> **sort**(`_`: ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`): `this`
|
|
814
814
|
|
|
815
|
-
Defined in: [shapes/Shape.ts:
|
|
815
|
+
Defined in: [shapes/Shape.ts:716](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L716)
|
|
816
816
|
|
|
817
817
|
A comparator function used to sort shapes for layering order.
|
|
818
818
|
|
|
@@ -838,7 +838,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
838
838
|
|
|
839
839
|
> **textureDefault**(): `Record`\<`string`, `unknown`\>
|
|
840
840
|
|
|
841
|
-
Defined in: [shapes/Shape.ts:
|
|
841
|
+
Defined in: [shapes/Shape.ts:728](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L728)
|
|
842
842
|
|
|
843
843
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
844
844
|
|
|
@@ -854,7 +854,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
854
854
|
|
|
855
855
|
> **textureDefault**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
856
856
|
|
|
857
|
-
Defined in: [shapes/Shape.ts:
|
|
857
|
+
Defined in: [shapes/Shape.ts:729](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L729)
|
|
858
858
|
|
|
859
859
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
860
860
|
|
|
@@ -878,7 +878,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
878
878
|
|
|
879
879
|
> **toScene**(): `GroupNode`
|
|
880
880
|
|
|
881
|
-
Defined in: [shapes/Shape.ts:
|
|
881
|
+
Defined in: [shapes/Shape.ts:421](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L421)
|
|
882
882
|
|
|
883
883
|
Produces a backend-agnostic scene graph for this shape's data, reusing the
|
|
884
884
|
same accessors render() applies to the DOM. This is the migration seam toward
|
|
@@ -1158,23 +1158,22 @@ The y1 (bottom edge) position accessor for the area.
|
|
|
1158
1158
|
|
|
1159
1159
|
| Property | Type | Description | Inherited from | Defined in |
|
|
1160
1160
|
| ------ | ------ | ------ | ------ | ------ |
|
|
1161
|
-
| <a id="property-_activegroup"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-1).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:
|
|
1162
|
-
| <a id="property-_backgroundimageclass"></a> `_backgroundImageClass` | [`Image`](#image) | - | [`Shape`](#shape-1).[`_backgroundImageClass`](#property-_backgroundimageclass-6) | [shapes/Shape.ts:110](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L110) |
|
|
1161
|
+
| <a id="property-_activegroup"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-1).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:130](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L130) |
|
|
1163
1162
|
| <a id="property-_configdefault"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | - | [`Shape`](#shape-1).[`_configDefault`](#property-_configdefault-16) | [utils/BaseClass.ts:82](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L82) |
|
|
1164
|
-
| <a id="property-_data"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-1).[`_data`](#property-_data-15) | [shapes/Shape.ts:
|
|
1165
|
-
| <a id="property-_enter"></a> `_enter` | `Selection` | - | [`Shape`](#shape-1).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:
|
|
1166
|
-
| <a id="property-_exit"></a> `_exit` | `Selection` | - | [`Shape`](#shape-1).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:
|
|
1167
|
-
| <a id="property-_group"></a> `_group` | `Selection` | - | [`Shape`](#shape-1).[`_group`](#property-_group-13) | [shapes/Shape.ts:
|
|
1168
|
-
| <a id="property-_hovergroup"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-1).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:
|
|
1169
|
-
| <a id="property-_labelclass"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-1).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:
|
|
1170
|
-
| <a id="property-_name"></a> `_name` | `string` | - | [`Shape`](#shape-1).[`_name`](#property-_name-6) | [shapes/Shape.ts:
|
|
1171
|
-
| <a id="property-_path"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-1).[`_path`](#property-_path-6) | [shapes/Shape.ts:
|
|
1172
|
-
| <a id="property-_scenerenderer"></a> `_sceneRenderer?` | `SvgRenderer` | SvgRenderer mounted by the standalone `render()` path; reused across redraws. | [`Shape`](#shape-1).[`_sceneRenderer`](#property-_scenerenderer-13) | [shapes/Shape.ts:
|
|
1173
|
-
| <a id="property-_select"></a> `_select` | `Selection` | - | [`Shape`](#shape-1).[`_select`](#property-_select-15) | [shapes/Shape.ts:
|
|
1174
|
-
| <a id="property-_tagname"></a> `_tagName` | `string` | - | [`Shape`](#shape-1).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:
|
|
1175
|
-
| <a id="property-_texturedefs"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-1).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:
|
|
1176
|
-
| <a id="property-_transition"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Bar`](#bar).[`_transition`](#property-_transition-6) | [shapes/Shape.ts:
|
|
1177
|
-
| <a id="property-_update"></a> `_update` | `Selection` | - | [`Shape`](#shape-1).[`_update`](#property-_update-6) | [shapes/Shape.ts:
|
|
1163
|
+
| <a id="property-_data"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-1).[`_data`](#property-_data-15) | [shapes/Shape.ts:116](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L116) |
|
|
1164
|
+
| <a id="property-_enter"></a> `_enter` | `Selection` | - | [`Shape`](#shape-1).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:127](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L127) |
|
|
1165
|
+
| <a id="property-_exit"></a> `_exit` | `Selection` | - | [`Shape`](#shape-1).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:128](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L128) |
|
|
1166
|
+
| <a id="property-_group"></a> `_group` | `Selection` | - | [`Shape`](#shape-1).[`_group`](#property-_group-13) | [shapes/Shape.ts:125](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L125) |
|
|
1167
|
+
| <a id="property-_hovergroup"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-1).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:129](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L129) |
|
|
1168
|
+
| <a id="property-_labelclass"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-1).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:117](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L117) |
|
|
1169
|
+
| <a id="property-_name"></a> `_name` | `string` | - | [`Shape`](#shape-1).[`_name`](#property-_name-6) | [shapes/Shape.ts:118](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L118) |
|
|
1170
|
+
| <a id="property-_path"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-1).[`_path`](#property-_path-6) | [shapes/Shape.ts:131](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L131) |
|
|
1171
|
+
| <a id="property-_scenerenderer"></a> `_sceneRenderer?` | `SvgRenderer` | SvgRenderer mounted by the standalone `render()` path; reused across redraws. | [`Shape`](#shape-1).[`_sceneRenderer`](#property-_scenerenderer-13) | [shapes/Shape.ts:133](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L133) |
|
|
1172
|
+
| <a id="property-_select"></a> `_select` | `Selection` | - | [`Shape`](#shape-1).[`_select`](#property-_select-15) | [shapes/Shape.ts:121](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L121) |
|
|
1173
|
+
| <a id="property-_tagname"></a> `_tagName` | `string` | - | [`Shape`](#shape-1).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:119](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L119) |
|
|
1174
|
+
| <a id="property-_texturedefs"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-1).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:120](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L120) |
|
|
1175
|
+
| <a id="property-_transition"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Bar`](#bar).[`_transition`](#property-_transition-6) | [shapes/Shape.ts:122](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L122) |
|
|
1176
|
+
| <a id="property-_update"></a> `_update` | `Selection` | - | [`Shape`](#shape-1).[`_update`](#property-_update-6) | [shapes/Shape.ts:126](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L126) |
|
|
1178
1177
|
| <a id="property-_uuid"></a> `_uuid` | `string` | - | [`Shape`](#shape-1).[`_uuid`](#property-_uuid-16) | [utils/BaseClass.ts:81](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L81) |
|
|
1179
1178
|
| <a id="property-ctx"></a> `ctx` | `Record`\<`string`, `unknown`\> | Chart-internal scratch (d3 layout instances, computed derived state). | [`Shape`](#shape-1).[`ctx`](#property-ctx-16) | [utils/BaseClass.ts:79](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L79) |
|
|
1180
1179
|
| <a id="property-schema"></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. | [`Shape`](#shape-1).[`schema`](#property-schema-17) | [utils/BaseClass.ts:77](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L77) |
|
|
@@ -5366,7 +5365,7 @@ Creates SVG areas based on an array of data.
|
|
|
5366
5365
|
|
|
5367
5366
|
> `optional` **\_dataFilter**(`data`: `DataPoint`[]): `DataPoint`[]
|
|
5368
5367
|
|
|
5369
|
-
Defined in: [shapes/Shape.ts:
|
|
5368
|
+
Defined in: [shapes/Shape.ts:124](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L124)
|
|
5370
5369
|
|
|
5371
5370
|
###### Parameters
|
|
5372
5371
|
|
|
@@ -5390,7 +5389,7 @@ Defined in: [shapes/Shape.ts:119](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
5390
5389
|
|
|
5391
5390
|
> **active**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
5392
5391
|
|
|
5393
|
-
Defined in: [shapes/Shape.ts:
|
|
5392
|
+
Defined in: [shapes/Shape.ts:632](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L632)
|
|
5394
5393
|
|
|
5395
5394
|
The active callback function for highlighting shapes.
|
|
5396
5395
|
|
|
@@ -5406,7 +5405,7 @@ The active callback function for highlighting shapes.
|
|
|
5406
5405
|
|
|
5407
5406
|
> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
5408
5407
|
|
|
5409
|
-
Defined in: [shapes/Shape.ts:
|
|
5408
|
+
Defined in: [shapes/Shape.ts:633](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L633)
|
|
5410
5409
|
|
|
5411
5410
|
The active callback function for highlighting shapes.
|
|
5412
5411
|
|
|
@@ -5432,7 +5431,7 @@ The active callback function for highlighting shapes.
|
|
|
5432
5431
|
|
|
5433
5432
|
> **activeStyle**(): `Record`\<`string`, `unknown`\>
|
|
5434
5433
|
|
|
5435
|
-
Defined in: [shapes/Shape.ts:
|
|
5434
|
+
Defined in: [shapes/Shape.ts:647](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L647)
|
|
5436
5435
|
|
|
5437
5436
|
The style to apply to active shapes.
|
|
5438
5437
|
|
|
@@ -5448,7 +5447,7 @@ The style to apply to active shapes.
|
|
|
5448
5447
|
|
|
5449
5448
|
> **activeStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
5450
5449
|
|
|
5451
|
-
Defined in: [shapes/Shape.ts:
|
|
5450
|
+
Defined in: [shapes/Shape.ts:648](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L648)
|
|
5452
5451
|
|
|
5453
5452
|
The style to apply to active shapes.
|
|
5454
5453
|
|
|
@@ -5520,7 +5519,7 @@ keys (e.g. `width`/`height` for Rect) in autocomplete + type checks.
|
|
|
5520
5519
|
|
|
5521
5520
|
> **data**(): `DataPoint`[]
|
|
5522
5521
|
|
|
5523
|
-
Defined in: [shapes/Shape.ts:
|
|
5522
|
+
Defined in: [shapes/Shape.ts:659](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L659)
|
|
5524
5523
|
|
|
5525
5524
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
5526
5525
|
|
|
@@ -5536,7 +5535,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
5536
5535
|
|
|
5537
5536
|
> **data**(`_`: `DataPoint`[]): `this`
|
|
5538
5537
|
|
|
5539
|
-
Defined in: [shapes/Shape.ts:
|
|
5538
|
+
Defined in: [shapes/Shape.ts:660](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L660)
|
|
5540
5539
|
|
|
5541
5540
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
5542
5541
|
|
|
@@ -5562,7 +5561,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
5562
5561
|
|
|
5563
5562
|
> **hover**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
5564
5563
|
|
|
5565
|
-
Defined in: [shapes/Shape.ts:
|
|
5564
|
+
Defined in: [shapes/Shape.ts:668](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L668)
|
|
5566
5565
|
|
|
5567
5566
|
The hover callback function for highlighting shapes on mouseover.
|
|
5568
5567
|
|
|
@@ -5578,7 +5577,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
5578
5577
|
|
|
5579
5578
|
> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
5580
5579
|
|
|
5581
|
-
Defined in: [shapes/Shape.ts:
|
|
5580
|
+
Defined in: [shapes/Shape.ts:669](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L669)
|
|
5582
5581
|
|
|
5583
5582
|
The hover callback function for highlighting shapes on mouseover.
|
|
5584
5583
|
|
|
@@ -5604,7 +5603,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
5604
5603
|
|
|
5605
5604
|
> **hoverStyle**(): `Record`\<`string`, `unknown`\>
|
|
5606
5605
|
|
|
5607
|
-
Defined in: [shapes/Shape.ts:
|
|
5606
|
+
Defined in: [shapes/Shape.ts:682](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L682)
|
|
5608
5607
|
|
|
5609
5608
|
The style to apply to hovered shapes.
|
|
5610
5609
|
|
|
@@ -5620,7 +5619,7 @@ The style to apply to hovered shapes.
|
|
|
5620
5619
|
|
|
5621
5620
|
> **hoverStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
5622
5621
|
|
|
5623
|
-
Defined in: [shapes/Shape.ts:
|
|
5622
|
+
Defined in: [shapes/Shape.ts:683](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L683)
|
|
5624
5623
|
|
|
5625
5624
|
The style to apply to hovered shapes.
|
|
5626
5625
|
|
|
@@ -5646,7 +5645,7 @@ The style to apply to hovered shapes.
|
|
|
5646
5645
|
|
|
5647
5646
|
> **labelConfig**(): `Record`\<`string`, `unknown`\>
|
|
5648
5647
|
|
|
5649
|
-
Defined in: [shapes/Shape.ts:
|
|
5648
|
+
Defined in: [shapes/Shape.ts:693](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L693)
|
|
5650
5649
|
|
|
5651
5650
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
5652
5651
|
|
|
@@ -5662,7 +5661,7 @@ A pass-through to the config method of the TextBox class used to create a shape'
|
|
|
5662
5661
|
|
|
5663
5662
|
> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
5664
5663
|
|
|
5665
|
-
Defined in: [shapes/Shape.ts:
|
|
5664
|
+
Defined in: [shapes/Shape.ts:694](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L694)
|
|
5666
5665
|
|
|
5667
5666
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
5668
5667
|
|
|
@@ -5935,7 +5934,7 @@ Parent config used by the wrapper.
|
|
|
5935
5934
|
|
|
5936
5935
|
> **render**(`callback?`: () => `void`): `this`
|
|
5937
5936
|
|
|
5938
|
-
Defined in: [shapes/Shape.ts:
|
|
5937
|
+
Defined in: [shapes/Shape.ts:524](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L524)
|
|
5939
5938
|
|
|
5940
5939
|
###### Parameters
|
|
5941
5940
|
|
|
@@ -5959,7 +5958,7 @@ Defined in: [shapes/Shape.ts:518](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
5959
5958
|
|
|
5960
5959
|
> **select**(): `Selection`
|
|
5961
5960
|
|
|
5962
|
-
Defined in: [shapes/Shape.ts:
|
|
5961
|
+
Defined in: [shapes/Shape.ts:704](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L704)
|
|
5963
5962
|
|
|
5964
5963
|
The SVG container element as a d3 selector or DOM element.
|
|
5965
5964
|
|
|
@@ -5975,7 +5974,7 @@ The SVG container element as a d3 selector or DOM element.
|
|
|
5975
5974
|
|
|
5976
5975
|
> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`
|
|
5977
5976
|
|
|
5978
|
-
Defined in: [shapes/Shape.ts:
|
|
5977
|
+
Defined in: [shapes/Shape.ts:705](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L705)
|
|
5979
5978
|
|
|
5980
5979
|
The SVG container element as a d3 selector or DOM element.
|
|
5981
5980
|
|
|
@@ -6043,7 +6042,7 @@ Configuration object with key/value pairs applied as method calls on each shape.
|
|
|
6043
6042
|
|
|
6044
6043
|
> **sort**(): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`
|
|
6045
6044
|
|
|
6046
|
-
Defined in: [shapes/Shape.ts:
|
|
6045
|
+
Defined in: [shapes/Shape.ts:715](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L715)
|
|
6047
6046
|
|
|
6048
6047
|
A comparator function used to sort shapes for layering order.
|
|
6049
6048
|
|
|
@@ -6059,7 +6058,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
6059
6058
|
|
|
6060
6059
|
> **sort**(`_`: ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`): `this`
|
|
6061
6060
|
|
|
6062
|
-
Defined in: [shapes/Shape.ts:
|
|
6061
|
+
Defined in: [shapes/Shape.ts:716](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L716)
|
|
6063
6062
|
|
|
6064
6063
|
A comparator function used to sort shapes for layering order.
|
|
6065
6064
|
|
|
@@ -6085,7 +6084,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
6085
6084
|
|
|
6086
6085
|
> **textureDefault**(): `Record`\<`string`, `unknown`\>
|
|
6087
6086
|
|
|
6088
|
-
Defined in: [shapes/Shape.ts:
|
|
6087
|
+
Defined in: [shapes/Shape.ts:728](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L728)
|
|
6089
6088
|
|
|
6090
6089
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
6091
6090
|
|
|
@@ -6101,7 +6100,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
6101
6100
|
|
|
6102
6101
|
> **textureDefault**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
6103
6102
|
|
|
6104
|
-
Defined in: [shapes/Shape.ts:
|
|
6103
|
+
Defined in: [shapes/Shape.ts:729](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L729)
|
|
6105
6104
|
|
|
6106
6105
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
6107
6106
|
|
|
@@ -6125,7 +6124,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
6125
6124
|
|
|
6126
6125
|
> **toScene**(): `GroupNode`
|
|
6127
6126
|
|
|
6128
|
-
Defined in: [shapes/Shape.ts:
|
|
6127
|
+
Defined in: [shapes/Shape.ts:421](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L421)
|
|
6129
6128
|
|
|
6130
6129
|
Produces a backend-agnostic scene graph for this shape's data, reusing the
|
|
6131
6130
|
same accessors render() applies to the DOM. This is the migration seam toward
|
|
@@ -6337,23 +6336,22 @@ The y1 (bottom edge) position accessor for each bar.
|
|
|
6337
6336
|
|
|
6338
6337
|
| Property | Type | Description | Inherited from | Defined in |
|
|
6339
6338
|
| ------ | ------ | ------ | ------ | ------ |
|
|
6340
|
-
| <a id="property-_activegroup-1"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-1).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:
|
|
6341
|
-
| <a id="property-_backgroundimageclass-1"></a> `_backgroundImageClass` | [`Image`](#image) | - | [`Shape`](#shape-1).[`_backgroundImageClass`](#property-_backgroundimageclass-6) | [shapes/Shape.ts:110](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L110) |
|
|
6339
|
+
| <a id="property-_activegroup-1"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-1).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:130](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L130) |
|
|
6342
6340
|
| <a id="property-_configdefault-6"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | - | [`Shape`](#shape-1).[`_configDefault`](#property-_configdefault-16) | [utils/BaseClass.ts:82](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L82) |
|
|
6343
|
-
| <a id="property-_data-6"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-1).[`_data`](#property-_data-15) | [shapes/Shape.ts:
|
|
6344
|
-
| <a id="property-_enter-1"></a> `_enter` | `Selection` | - | [`Shape`](#shape-1).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:
|
|
6345
|
-
| <a id="property-_exit-1"></a> `_exit` | `Selection` | - | [`Shape`](#shape-1).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:
|
|
6346
|
-
| <a id="property-_group-6"></a> `_group` | `Selection` | - | [`Shape`](#shape-1).[`_group`](#property-_group-13) | [shapes/Shape.ts:
|
|
6347
|
-
| <a id="property-_hovergroup-1"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-1).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:
|
|
6348
|
-
| <a id="property-_labelclass-1"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-1).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:
|
|
6349
|
-
| <a id="property-_name-1"></a> `_name` | `string` | - | [`Shape`](#shape-1).[`_name`](#property-_name-6) | [shapes/Shape.ts:
|
|
6350
|
-
| <a id="property-_path-1"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-1).[`_path`](#property-_path-6) | [shapes/Shape.ts:
|
|
6351
|
-
| <a id="property-_scenerenderer-6"></a> `_sceneRenderer?` | `SvgRenderer` | SvgRenderer mounted by the standalone `render()` path; reused across redraws. | [`Shape`](#shape-1).[`_sceneRenderer`](#property-_scenerenderer-13) | [shapes/Shape.ts:
|
|
6352
|
-
| <a id="property-_select-6"></a> `_select` | `Selection` | - | [`Shape`](#shape-1).[`_select`](#property-_select-15) | [shapes/Shape.ts:
|
|
6353
|
-
| <a id="property-_tagname-1"></a> `_tagName` | `string` | - | [`Shape`](#shape-1).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:
|
|
6354
|
-
| <a id="property-_texturedefs-1"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-1).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:
|
|
6355
|
-
| <a id="property-_transition-6"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-1).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:
|
|
6356
|
-
| <a id="property-_update-1"></a> `_update` | `Selection` | - | [`Shape`](#shape-1).[`_update`](#property-_update-6) | [shapes/Shape.ts:
|
|
6341
|
+
| <a id="property-_data-6"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-1).[`_data`](#property-_data-15) | [shapes/Shape.ts:116](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L116) |
|
|
6342
|
+
| <a id="property-_enter-1"></a> `_enter` | `Selection` | - | [`Shape`](#shape-1).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:127](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L127) |
|
|
6343
|
+
| <a id="property-_exit-1"></a> `_exit` | `Selection` | - | [`Shape`](#shape-1).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:128](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L128) |
|
|
6344
|
+
| <a id="property-_group-6"></a> `_group` | `Selection` | - | [`Shape`](#shape-1).[`_group`](#property-_group-13) | [shapes/Shape.ts:125](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L125) |
|
|
6345
|
+
| <a id="property-_hovergroup-1"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-1).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:129](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L129) |
|
|
6346
|
+
| <a id="property-_labelclass-1"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-1).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:117](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L117) |
|
|
6347
|
+
| <a id="property-_name-1"></a> `_name` | `string` | - | [`Shape`](#shape-1).[`_name`](#property-_name-6) | [shapes/Shape.ts:118](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L118) |
|
|
6348
|
+
| <a id="property-_path-1"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-1).[`_path`](#property-_path-6) | [shapes/Shape.ts:131](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L131) |
|
|
6349
|
+
| <a id="property-_scenerenderer-6"></a> `_sceneRenderer?` | `SvgRenderer` | SvgRenderer mounted by the standalone `render()` path; reused across redraws. | [`Shape`](#shape-1).[`_sceneRenderer`](#property-_scenerenderer-13) | [shapes/Shape.ts:133](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L133) |
|
|
6350
|
+
| <a id="property-_select-6"></a> `_select` | `Selection` | - | [`Shape`](#shape-1).[`_select`](#property-_select-15) | [shapes/Shape.ts:121](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L121) |
|
|
6351
|
+
| <a id="property-_tagname-1"></a> `_tagName` | `string` | - | [`Shape`](#shape-1).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:119](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L119) |
|
|
6352
|
+
| <a id="property-_texturedefs-1"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-1).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:120](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L120) |
|
|
6353
|
+
| <a id="property-_transition-6"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-1).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:122](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L122) |
|
|
6354
|
+
| <a id="property-_update-1"></a> `_update` | `Selection` | - | [`Shape`](#shape-1).[`_update`](#property-_update-6) | [shapes/Shape.ts:126](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L126) |
|
|
6357
6355
|
| <a id="property-_uuid-6"></a> `_uuid` | `string` | - | [`Shape`](#shape-1).[`_uuid`](#property-_uuid-16) | [utils/BaseClass.ts:81](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L81) |
|
|
6358
6356
|
| <a id="property-ctx-6"></a> `ctx` | `Record`\<`string`, `unknown`\> | Chart-internal scratch (d3 layout instances, computed derived state). | [`Shape`](#shape-1).[`ctx`](#property-ctx-16) | [utils/BaseClass.ts:79](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L79) |
|
|
6359
6357
|
| <a id="property-schema-6"></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. | [`Shape`](#shape-1).[`schema`](#property-schema-17) | [utils/BaseClass.ts:77](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L77) |
|
|
@@ -7457,7 +7455,7 @@ Creates SVG circles based on an array of data.
|
|
|
7457
7455
|
|
|
7458
7456
|
> `optional` **\_dataFilter**(`data`: `DataPoint`[]): `DataPoint`[]
|
|
7459
7457
|
|
|
7460
|
-
Defined in: [shapes/Shape.ts:
|
|
7458
|
+
Defined in: [shapes/Shape.ts:124](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L124)
|
|
7461
7459
|
|
|
7462
7460
|
###### Parameters
|
|
7463
7461
|
|
|
@@ -7481,7 +7479,7 @@ Defined in: [shapes/Shape.ts:119](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
7481
7479
|
|
|
7482
7480
|
> **active**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
7483
7481
|
|
|
7484
|
-
Defined in: [shapes/Shape.ts:
|
|
7482
|
+
Defined in: [shapes/Shape.ts:632](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L632)
|
|
7485
7483
|
|
|
7486
7484
|
The active callback function for highlighting shapes.
|
|
7487
7485
|
|
|
@@ -7497,7 +7495,7 @@ The active callback function for highlighting shapes.
|
|
|
7497
7495
|
|
|
7498
7496
|
> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
7499
7497
|
|
|
7500
|
-
Defined in: [shapes/Shape.ts:
|
|
7498
|
+
Defined in: [shapes/Shape.ts:633](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L633)
|
|
7501
7499
|
|
|
7502
7500
|
The active callback function for highlighting shapes.
|
|
7503
7501
|
|
|
@@ -7523,7 +7521,7 @@ The active callback function for highlighting shapes.
|
|
|
7523
7521
|
|
|
7524
7522
|
> **activeStyle**(): `Record`\<`string`, `unknown`\>
|
|
7525
7523
|
|
|
7526
|
-
Defined in: [shapes/Shape.ts:
|
|
7524
|
+
Defined in: [shapes/Shape.ts:647](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L647)
|
|
7527
7525
|
|
|
7528
7526
|
The style to apply to active shapes.
|
|
7529
7527
|
|
|
@@ -7539,7 +7537,7 @@ The style to apply to active shapes.
|
|
|
7539
7537
|
|
|
7540
7538
|
> **activeStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
7541
7539
|
|
|
7542
|
-
Defined in: [shapes/Shape.ts:
|
|
7540
|
+
Defined in: [shapes/Shape.ts:648](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L648)
|
|
7543
7541
|
|
|
7544
7542
|
The style to apply to active shapes.
|
|
7545
7543
|
|
|
@@ -7611,7 +7609,7 @@ keys (e.g. `width`/`height` for Rect) in autocomplete + type checks.
|
|
|
7611
7609
|
|
|
7612
7610
|
> **data**(): `DataPoint`[]
|
|
7613
7611
|
|
|
7614
|
-
Defined in: [shapes/Shape.ts:
|
|
7612
|
+
Defined in: [shapes/Shape.ts:659](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L659)
|
|
7615
7613
|
|
|
7616
7614
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
7617
7615
|
|
|
@@ -7627,7 +7625,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
7627
7625
|
|
|
7628
7626
|
> **data**(`_`: `DataPoint`[]): `this`
|
|
7629
7627
|
|
|
7630
|
-
Defined in: [shapes/Shape.ts:
|
|
7628
|
+
Defined in: [shapes/Shape.ts:660](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L660)
|
|
7631
7629
|
|
|
7632
7630
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
7633
7631
|
|
|
@@ -7653,7 +7651,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
7653
7651
|
|
|
7654
7652
|
> **hover**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
7655
7653
|
|
|
7656
|
-
Defined in: [shapes/Shape.ts:
|
|
7654
|
+
Defined in: [shapes/Shape.ts:668](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L668)
|
|
7657
7655
|
|
|
7658
7656
|
The hover callback function for highlighting shapes on mouseover.
|
|
7659
7657
|
|
|
@@ -7669,7 +7667,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
7669
7667
|
|
|
7670
7668
|
> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
7671
7669
|
|
|
7672
|
-
Defined in: [shapes/Shape.ts:
|
|
7670
|
+
Defined in: [shapes/Shape.ts:669](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L669)
|
|
7673
7671
|
|
|
7674
7672
|
The hover callback function for highlighting shapes on mouseover.
|
|
7675
7673
|
|
|
@@ -7695,7 +7693,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
7695
7693
|
|
|
7696
7694
|
> **hoverStyle**(): `Record`\<`string`, `unknown`\>
|
|
7697
7695
|
|
|
7698
|
-
Defined in: [shapes/Shape.ts:
|
|
7696
|
+
Defined in: [shapes/Shape.ts:682](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L682)
|
|
7699
7697
|
|
|
7700
7698
|
The style to apply to hovered shapes.
|
|
7701
7699
|
|
|
@@ -7711,7 +7709,7 @@ The style to apply to hovered shapes.
|
|
|
7711
7709
|
|
|
7712
7710
|
> **hoverStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
7713
7711
|
|
|
7714
|
-
Defined in: [shapes/Shape.ts:
|
|
7712
|
+
Defined in: [shapes/Shape.ts:683](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L683)
|
|
7715
7713
|
|
|
7716
7714
|
The style to apply to hovered shapes.
|
|
7717
7715
|
|
|
@@ -7737,7 +7735,7 @@ The style to apply to hovered shapes.
|
|
|
7737
7735
|
|
|
7738
7736
|
> **labelConfig**(): `Record`\<`string`, `unknown`\>
|
|
7739
7737
|
|
|
7740
|
-
Defined in: [shapes/Shape.ts:
|
|
7738
|
+
Defined in: [shapes/Shape.ts:693](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L693)
|
|
7741
7739
|
|
|
7742
7740
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
7743
7741
|
|
|
@@ -7753,7 +7751,7 @@ A pass-through to the config method of the TextBox class used to create a shape'
|
|
|
7753
7751
|
|
|
7754
7752
|
> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
7755
7753
|
|
|
7756
|
-
Defined in: [shapes/Shape.ts:
|
|
7754
|
+
Defined in: [shapes/Shape.ts:694](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L694)
|
|
7757
7755
|
|
|
7758
7756
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
7759
7757
|
|
|
@@ -8026,7 +8024,7 @@ Parent config used by the wrapper.
|
|
|
8026
8024
|
|
|
8027
8025
|
> **render**(`callback?`: () => `void`): `this`
|
|
8028
8026
|
|
|
8029
|
-
Defined in: [shapes/Shape.ts:
|
|
8027
|
+
Defined in: [shapes/Shape.ts:524](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L524)
|
|
8030
8028
|
|
|
8031
8029
|
###### Parameters
|
|
8032
8030
|
|
|
@@ -8050,7 +8048,7 @@ Defined in: [shapes/Shape.ts:518](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
8050
8048
|
|
|
8051
8049
|
> **select**(): `Selection`
|
|
8052
8050
|
|
|
8053
|
-
Defined in: [shapes/Shape.ts:
|
|
8051
|
+
Defined in: [shapes/Shape.ts:704](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L704)
|
|
8054
8052
|
|
|
8055
8053
|
The SVG container element as a d3 selector or DOM element.
|
|
8056
8054
|
|
|
@@ -8066,7 +8064,7 @@ The SVG container element as a d3 selector or DOM element.
|
|
|
8066
8064
|
|
|
8067
8065
|
> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`
|
|
8068
8066
|
|
|
8069
|
-
Defined in: [shapes/Shape.ts:
|
|
8067
|
+
Defined in: [shapes/Shape.ts:705](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L705)
|
|
8070
8068
|
|
|
8071
8069
|
The SVG container element as a d3 selector or DOM element.
|
|
8072
8070
|
|
|
@@ -8134,7 +8132,7 @@ Configuration object with key/value pairs applied as method calls on each shape.
|
|
|
8134
8132
|
|
|
8135
8133
|
> **sort**(): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`
|
|
8136
8134
|
|
|
8137
|
-
Defined in: [shapes/Shape.ts:
|
|
8135
|
+
Defined in: [shapes/Shape.ts:715](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L715)
|
|
8138
8136
|
|
|
8139
8137
|
A comparator function used to sort shapes for layering order.
|
|
8140
8138
|
|
|
@@ -8150,7 +8148,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
8150
8148
|
|
|
8151
8149
|
> **sort**(`_`: ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`): `this`
|
|
8152
8150
|
|
|
8153
|
-
Defined in: [shapes/Shape.ts:
|
|
8151
|
+
Defined in: [shapes/Shape.ts:716](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L716)
|
|
8154
8152
|
|
|
8155
8153
|
A comparator function used to sort shapes for layering order.
|
|
8156
8154
|
|
|
@@ -8176,7 +8174,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
8176
8174
|
|
|
8177
8175
|
> **textureDefault**(): `Record`\<`string`, `unknown`\>
|
|
8178
8176
|
|
|
8179
|
-
Defined in: [shapes/Shape.ts:
|
|
8177
|
+
Defined in: [shapes/Shape.ts:728](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L728)
|
|
8180
8178
|
|
|
8181
8179
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
8182
8180
|
|
|
@@ -8192,7 +8190,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
8192
8190
|
|
|
8193
8191
|
> **textureDefault**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
8194
8192
|
|
|
8195
|
-
Defined in: [shapes/Shape.ts:
|
|
8193
|
+
Defined in: [shapes/Shape.ts:729](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L729)
|
|
8196
8194
|
|
|
8197
8195
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
8198
8196
|
|
|
@@ -8216,7 +8214,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
8216
8214
|
|
|
8217
8215
|
> **toScene**(): `GroupNode`
|
|
8218
8216
|
|
|
8219
|
-
Defined in: [shapes/Shape.ts:
|
|
8217
|
+
Defined in: [shapes/Shape.ts:421](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L421)
|
|
8220
8218
|
|
|
8221
8219
|
Produces a backend-agnostic scene graph for this shape's data, reusing the
|
|
8222
8220
|
same accessors render() applies to the DOM. This is the migration seam toward
|
|
@@ -8292,23 +8290,22 @@ return d === "Back" ? "Get outta here" : d;
|
|
|
8292
8290
|
|
|
8293
8291
|
| Property | Type | Description | Inherited from | Defined in |
|
|
8294
8292
|
| ------ | ------ | ------ | ------ | ------ |
|
|
8295
|
-
| <a id="property-_activegroup-2"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-1).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:
|
|
8296
|
-
| <a id="property-_backgroundimageclass-2"></a> `_backgroundImageClass` | [`Image`](#image) | - | [`Shape`](#shape-1).[`_backgroundImageClass`](#property-_backgroundimageclass-6) | [shapes/Shape.ts:110](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L110) |
|
|
8293
|
+
| <a id="property-_activegroup-2"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-1).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:130](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L130) |
|
|
8297
8294
|
| <a id="property-_configdefault-9"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | - | [`Shape`](#shape-1).[`_configDefault`](#property-_configdefault-16) | [utils/BaseClass.ts:82](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L82) |
|
|
8298
|
-
| <a id="property-_data-8"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-1).[`_data`](#property-_data-15) | [shapes/Shape.ts:
|
|
8299
|
-
| <a id="property-_enter-2"></a> `_enter` | `Selection` | - | [`Shape`](#shape-1).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:
|
|
8300
|
-
| <a id="property-_exit-2"></a> `_exit` | `Selection` | - | [`Shape`](#shape-1).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:
|
|
8301
|
-
| <a id="property-_group-7"></a> `_group` | `Selection` | - | [`Shape`](#shape-1).[`_group`](#property-_group-13) | [shapes/Shape.ts:
|
|
8302
|
-
| <a id="property-_hovergroup-2"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-1).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:
|
|
8303
|
-
| <a id="property-_labelclass-2"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-1).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:
|
|
8304
|
-
| <a id="property-_name-2"></a> `_name` | `string` | - | [`Shape`](#shape-1).[`_name`](#property-_name-6) | [shapes/Shape.ts:
|
|
8305
|
-
| <a id="property-_path-2"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-1).[`_path`](#property-_path-6) | [shapes/Shape.ts:
|
|
8306
|
-
| <a id="property-_scenerenderer-7"></a> `_sceneRenderer?` | `SvgRenderer` | SvgRenderer mounted by the standalone `render()` path; reused across redraws. | [`Shape`](#shape-1).[`_sceneRenderer`](#property-_scenerenderer-13) | [shapes/Shape.ts:
|
|
8307
|
-
| <a id="property-_select-8"></a> `_select` | `Selection` | - | [`Shape`](#shape-1).[`_select`](#property-_select-15) | [shapes/Shape.ts:
|
|
8308
|
-
| <a id="property-_tagname-2"></a> `_tagName` | `string` | - | [`Shape`](#shape-1).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:
|
|
8309
|
-
| <a id="property-_texturedefs-2"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-1).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:
|
|
8310
|
-
| <a id="property-_transition-7"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-1).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:
|
|
8311
|
-
| <a id="property-_update-2"></a> `_update` | `Selection` | - | [`Shape`](#shape-1).[`_update`](#property-_update-6) | [shapes/Shape.ts:
|
|
8295
|
+
| <a id="property-_data-8"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-1).[`_data`](#property-_data-15) | [shapes/Shape.ts:116](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L116) |
|
|
8296
|
+
| <a id="property-_enter-2"></a> `_enter` | `Selection` | - | [`Shape`](#shape-1).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:127](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L127) |
|
|
8297
|
+
| <a id="property-_exit-2"></a> `_exit` | `Selection` | - | [`Shape`](#shape-1).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:128](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L128) |
|
|
8298
|
+
| <a id="property-_group-7"></a> `_group` | `Selection` | - | [`Shape`](#shape-1).[`_group`](#property-_group-13) | [shapes/Shape.ts:125](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L125) |
|
|
8299
|
+
| <a id="property-_hovergroup-2"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-1).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:129](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L129) |
|
|
8300
|
+
| <a id="property-_labelclass-2"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-1).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:117](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L117) |
|
|
8301
|
+
| <a id="property-_name-2"></a> `_name` | `string` | - | [`Shape`](#shape-1).[`_name`](#property-_name-6) | [shapes/Shape.ts:118](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L118) |
|
|
8302
|
+
| <a id="property-_path-2"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-1).[`_path`](#property-_path-6) | [shapes/Shape.ts:131](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L131) |
|
|
8303
|
+
| <a id="property-_scenerenderer-7"></a> `_sceneRenderer?` | `SvgRenderer` | SvgRenderer mounted by the standalone `render()` path; reused across redraws. | [`Shape`](#shape-1).[`_sceneRenderer`](#property-_scenerenderer-13) | [shapes/Shape.ts:133](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L133) |
|
|
8304
|
+
| <a id="property-_select-8"></a> `_select` | `Selection` | - | [`Shape`](#shape-1).[`_select`](#property-_select-15) | [shapes/Shape.ts:121](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L121) |
|
|
8305
|
+
| <a id="property-_tagname-2"></a> `_tagName` | `string` | - | [`Shape`](#shape-1).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:119](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L119) |
|
|
8306
|
+
| <a id="property-_texturedefs-2"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-1).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:120](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L120) |
|
|
8307
|
+
| <a id="property-_transition-7"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-1).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:122](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L122) |
|
|
8308
|
+
| <a id="property-_update-2"></a> `_update` | `Selection` | - | [`Shape`](#shape-1).[`_update`](#property-_update-6) | [shapes/Shape.ts:126](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L126) |
|
|
8312
8309
|
| <a id="property-_uuid-9"></a> `_uuid` | `string` | - | [`Shape`](#shape-1).[`_uuid`](#property-_uuid-16) | [utils/BaseClass.ts:81](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L81) |
|
|
8313
8310
|
| <a id="property-ctx-9"></a> `ctx` | `Record`\<`string`, `unknown`\> | Chart-internal scratch (d3 layout instances, computed derived state). | [`Shape`](#shape-1).[`ctx`](#property-ctx-16) | [utils/BaseClass.ts:79](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L79) |
|
|
8314
8311
|
| <a id="property-schema-9"></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. | [`Shape`](#shape-1).[`schema`](#property-schema-17) | [utils/BaseClass.ts:77](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L77) |
|
|
@@ -9223,7 +9220,7 @@ Renders the current Image to the page. If a *callback* is specified, it will be
|
|
|
9223
9220
|
|
|
9224
9221
|
> **select**(): `Selection`
|
|
9225
9222
|
|
|
9226
|
-
Defined in: [shapes/Image.ts:
|
|
9223
|
+
Defined in: [shapes/Image.ts:212](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Image.ts#L212)
|
|
9227
9224
|
|
|
9228
9225
|
The SVG container element as a d3 selector or DOM element.
|
|
9229
9226
|
|
|
@@ -9235,7 +9232,7 @@ The SVG container element as a d3 selector or DOM element.
|
|
|
9235
9232
|
|
|
9236
9233
|
> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`
|
|
9237
9234
|
|
|
9238
|
-
Defined in: [shapes/Image.ts:
|
|
9235
|
+
Defined in: [shapes/Image.ts:213](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Image.ts#L213)
|
|
9239
9236
|
|
|
9240
9237
|
The SVG container element as a d3 selector or DOM element.
|
|
9241
9238
|
|
|
@@ -9255,13 +9252,12 @@ The SVG container element as a d3 selector or DOM element.
|
|
|
9255
9252
|
|
|
9256
9253
|
> **toScene**(): `GroupNode`
|
|
9257
9254
|
|
|
9258
|
-
Defined in: [shapes/Image.ts:
|
|
9255
|
+
Defined in: [shapes/Image.ts:188](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Image.ts#L188)
|
|
9259
9256
|
|
|
9260
9257
|
Compute-mode scene emission. Mirrors Shape.toScene's shape — a
|
|
9261
9258
|
keyed GroupNode wrapping per-datum ImageNodes. Used by chart
|
|
9262
|
-
compositors (
|
|
9263
|
-
|
|
9264
|
-
d3-selection DOM.
|
|
9259
|
+
compositors (e.g. plotPaint) that need Image to participate in the
|
|
9260
|
+
scene graph rather than emit d3-selection DOM.
|
|
9265
9261
|
|
|
9266
9262
|
###### Returns
|
|
9267
9263
|
|
|
@@ -9937,7 +9933,7 @@ Creates SVG lines based on an array of data.
|
|
|
9937
9933
|
|
|
9938
9934
|
> **active**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
9939
9935
|
|
|
9940
|
-
Defined in: [shapes/Shape.ts:
|
|
9936
|
+
Defined in: [shapes/Shape.ts:632](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L632)
|
|
9941
9937
|
|
|
9942
9938
|
The active callback function for highlighting shapes.
|
|
9943
9939
|
|
|
@@ -9953,7 +9949,7 @@ The active callback function for highlighting shapes.
|
|
|
9953
9949
|
|
|
9954
9950
|
> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
9955
9951
|
|
|
9956
|
-
Defined in: [shapes/Shape.ts:
|
|
9952
|
+
Defined in: [shapes/Shape.ts:633](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L633)
|
|
9957
9953
|
|
|
9958
9954
|
The active callback function for highlighting shapes.
|
|
9959
9955
|
|
|
@@ -9979,7 +9975,7 @@ The active callback function for highlighting shapes.
|
|
|
9979
9975
|
|
|
9980
9976
|
> **activeStyle**(): `Record`\<`string`, `unknown`\>
|
|
9981
9977
|
|
|
9982
|
-
Defined in: [shapes/Shape.ts:
|
|
9978
|
+
Defined in: [shapes/Shape.ts:647](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L647)
|
|
9983
9979
|
|
|
9984
9980
|
The style to apply to active shapes.
|
|
9985
9981
|
|
|
@@ -9995,7 +9991,7 @@ The style to apply to active shapes.
|
|
|
9995
9991
|
|
|
9996
9992
|
> **activeStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
9997
9993
|
|
|
9998
|
-
Defined in: [shapes/Shape.ts:
|
|
9994
|
+
Defined in: [shapes/Shape.ts:648](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L648)
|
|
9999
9995
|
|
|
10000
9996
|
The style to apply to active shapes.
|
|
10001
9997
|
|
|
@@ -10067,7 +10063,7 @@ keys (e.g. `width`/`height` for Rect) in autocomplete + type checks.
|
|
|
10067
10063
|
|
|
10068
10064
|
> **data**(): `DataPoint`[]
|
|
10069
10065
|
|
|
10070
|
-
Defined in: [shapes/Shape.ts:
|
|
10066
|
+
Defined in: [shapes/Shape.ts:659](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L659)
|
|
10071
10067
|
|
|
10072
10068
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
10073
10069
|
|
|
@@ -10083,7 +10079,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
10083
10079
|
|
|
10084
10080
|
> **data**(`_`: `DataPoint`[]): `this`
|
|
10085
10081
|
|
|
10086
|
-
Defined in: [shapes/Shape.ts:
|
|
10082
|
+
Defined in: [shapes/Shape.ts:660](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L660)
|
|
10087
10083
|
|
|
10088
10084
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
10089
10085
|
|
|
@@ -10109,7 +10105,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
10109
10105
|
|
|
10110
10106
|
> **hover**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
10111
10107
|
|
|
10112
|
-
Defined in: [shapes/Shape.ts:
|
|
10108
|
+
Defined in: [shapes/Shape.ts:668](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L668)
|
|
10113
10109
|
|
|
10114
10110
|
The hover callback function for highlighting shapes on mouseover.
|
|
10115
10111
|
|
|
@@ -10125,7 +10121,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
10125
10121
|
|
|
10126
10122
|
> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
10127
10123
|
|
|
10128
|
-
Defined in: [shapes/Shape.ts:
|
|
10124
|
+
Defined in: [shapes/Shape.ts:669](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L669)
|
|
10129
10125
|
|
|
10130
10126
|
The hover callback function for highlighting shapes on mouseover.
|
|
10131
10127
|
|
|
@@ -10151,7 +10147,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
10151
10147
|
|
|
10152
10148
|
> **hoverStyle**(): `Record`\<`string`, `unknown`\>
|
|
10153
10149
|
|
|
10154
|
-
Defined in: [shapes/Shape.ts:
|
|
10150
|
+
Defined in: [shapes/Shape.ts:682](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L682)
|
|
10155
10151
|
|
|
10156
10152
|
The style to apply to hovered shapes.
|
|
10157
10153
|
|
|
@@ -10167,7 +10163,7 @@ The style to apply to hovered shapes.
|
|
|
10167
10163
|
|
|
10168
10164
|
> **hoverStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
10169
10165
|
|
|
10170
|
-
Defined in: [shapes/Shape.ts:
|
|
10166
|
+
Defined in: [shapes/Shape.ts:683](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L683)
|
|
10171
10167
|
|
|
10172
10168
|
The style to apply to hovered shapes.
|
|
10173
10169
|
|
|
@@ -10193,7 +10189,7 @@ The style to apply to hovered shapes.
|
|
|
10193
10189
|
|
|
10194
10190
|
> **labelConfig**(): `Record`\<`string`, `unknown`\>
|
|
10195
10191
|
|
|
10196
|
-
Defined in: [shapes/Shape.ts:
|
|
10192
|
+
Defined in: [shapes/Shape.ts:693](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L693)
|
|
10197
10193
|
|
|
10198
10194
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
10199
10195
|
|
|
@@ -10209,7 +10205,7 @@ A pass-through to the config method of the TextBox class used to create a shape'
|
|
|
10209
10205
|
|
|
10210
10206
|
> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
10211
10207
|
|
|
10212
|
-
Defined in: [shapes/Shape.ts:
|
|
10208
|
+
Defined in: [shapes/Shape.ts:694](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L694)
|
|
10213
10209
|
|
|
10214
10210
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
10215
10211
|
|
|
@@ -10482,7 +10478,7 @@ Parent config used by the wrapper.
|
|
|
10482
10478
|
|
|
10483
10479
|
> **render**(`callback?`: () => `void`): `this`
|
|
10484
10480
|
|
|
10485
|
-
Defined in: [shapes/Shape.ts:
|
|
10481
|
+
Defined in: [shapes/Shape.ts:524](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L524)
|
|
10486
10482
|
|
|
10487
10483
|
###### Parameters
|
|
10488
10484
|
|
|
@@ -10506,7 +10502,7 @@ Defined in: [shapes/Shape.ts:518](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
10506
10502
|
|
|
10507
10503
|
> **select**(): `Selection`
|
|
10508
10504
|
|
|
10509
|
-
Defined in: [shapes/Shape.ts:
|
|
10505
|
+
Defined in: [shapes/Shape.ts:704](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L704)
|
|
10510
10506
|
|
|
10511
10507
|
The SVG container element as a d3 selector or DOM element.
|
|
10512
10508
|
|
|
@@ -10522,7 +10518,7 @@ The SVG container element as a d3 selector or DOM element.
|
|
|
10522
10518
|
|
|
10523
10519
|
> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`
|
|
10524
10520
|
|
|
10525
|
-
Defined in: [shapes/Shape.ts:
|
|
10521
|
+
Defined in: [shapes/Shape.ts:705](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L705)
|
|
10526
10522
|
|
|
10527
10523
|
The SVG container element as a d3 selector or DOM element.
|
|
10528
10524
|
|
|
@@ -10590,7 +10586,7 @@ Configuration object with key/value pairs applied as method calls on each shape.
|
|
|
10590
10586
|
|
|
10591
10587
|
> **sort**(): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`
|
|
10592
10588
|
|
|
10593
|
-
Defined in: [shapes/Shape.ts:
|
|
10589
|
+
Defined in: [shapes/Shape.ts:715](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L715)
|
|
10594
10590
|
|
|
10595
10591
|
A comparator function used to sort shapes for layering order.
|
|
10596
10592
|
|
|
@@ -10606,7 +10602,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
10606
10602
|
|
|
10607
10603
|
> **sort**(`_`: ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`): `this`
|
|
10608
10604
|
|
|
10609
|
-
Defined in: [shapes/Shape.ts:
|
|
10605
|
+
Defined in: [shapes/Shape.ts:716](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L716)
|
|
10610
10606
|
|
|
10611
10607
|
A comparator function used to sort shapes for layering order.
|
|
10612
10608
|
|
|
@@ -10632,7 +10628,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
10632
10628
|
|
|
10633
10629
|
> **textureDefault**(): `Record`\<`string`, `unknown`\>
|
|
10634
10630
|
|
|
10635
|
-
Defined in: [shapes/Shape.ts:
|
|
10631
|
+
Defined in: [shapes/Shape.ts:728](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L728)
|
|
10636
10632
|
|
|
10637
10633
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
10638
10634
|
|
|
@@ -10648,7 +10644,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
10648
10644
|
|
|
10649
10645
|
> **textureDefault**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
10650
10646
|
|
|
10651
|
-
Defined in: [shapes/Shape.ts:
|
|
10647
|
+
Defined in: [shapes/Shape.ts:729](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L729)
|
|
10652
10648
|
|
|
10653
10649
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
10654
10650
|
|
|
@@ -10672,7 +10668,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
10672
10668
|
|
|
10673
10669
|
> **toScene**(): `GroupNode`
|
|
10674
10670
|
|
|
10675
|
-
Defined in: [shapes/Shape.ts:
|
|
10671
|
+
Defined in: [shapes/Shape.ts:421](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L421)
|
|
10676
10672
|
|
|
10677
10673
|
Produces a backend-agnostic scene graph for this shape's data, reusing the
|
|
10678
10674
|
same accessors render() applies to the DOM. This is the migration seam toward
|
|
@@ -10748,23 +10744,22 @@ return d === "Back" ? "Get outta here" : d;
|
|
|
10748
10744
|
|
|
10749
10745
|
| Property | Type | Description | Inherited from | Defined in |
|
|
10750
10746
|
| ------ | ------ | ------ | ------ | ------ |
|
|
10751
|
-
| <a id="property-_activegroup-3"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-1).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:
|
|
10752
|
-
| <a id="property-_backgroundimageclass-3"></a> `_backgroundImageClass` | [`Image`](#image) | - | [`Shape`](#shape-1).[`_backgroundImageClass`](#property-_backgroundimageclass-6) | [shapes/Shape.ts:110](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L110) |
|
|
10747
|
+
| <a id="property-_activegroup-3"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-1).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:130](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L130) |
|
|
10753
10748
|
| <a id="property-_configdefault-12"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | - | [`Shape`](#shape-1).[`_configDefault`](#property-_configdefault-16) | [utils/BaseClass.ts:82](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L82) |
|
|
10754
|
-
| <a id="property-_data-12"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-1).[`_data`](#property-_data-15) | [shapes/Shape.ts:
|
|
10755
|
-
| <a id="property-_enter-3"></a> `_enter` | `Selection` | - | [`Shape`](#shape-1).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:
|
|
10756
|
-
| <a id="property-_exit-3"></a> `_exit` | `Selection` | - | [`Shape`](#shape-1).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:
|
|
10757
|
-
| <a id="property-_group-10"></a> `_group` | `Selection` | - | [`Shape`](#shape-1).[`_group`](#property-_group-13) | [shapes/Shape.ts:
|
|
10758
|
-
| <a id="property-_hovergroup-3"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-1).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:
|
|
10759
|
-
| <a id="property-_labelclass-4"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-1).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:
|
|
10760
|
-
| <a id="property-_name-3"></a> `_name` | `string` | - | [`Shape`](#shape-1).[`_name`](#property-_name-6) | [shapes/Shape.ts:
|
|
10761
|
-
| <a id="property-_path-3"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-1).[`_path`](#property-_path-6) | [shapes/Shape.ts:
|
|
10762
|
-
| <a id="property-_scenerenderer-10"></a> `_sceneRenderer?` | `SvgRenderer` | SvgRenderer mounted by the standalone `render()` path; reused across redraws. | [`Shape`](#shape-1).[`_sceneRenderer`](#property-_scenerenderer-13) | [shapes/Shape.ts:
|
|
10763
|
-
| <a id="property-_select-12"></a> `_select` | `Selection` | - | [`Shape`](#shape-1).[`_select`](#property-_select-15) | [shapes/Shape.ts:
|
|
10764
|
-
| <a id="property-_tagname-3"></a> `_tagName` | `string` | - | [`Shape`](#shape-1).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:
|
|
10765
|
-
| <a id="property-_texturedefs-3"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-1).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:
|
|
10766
|
-
| <a id="property-_transition-8"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-1).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:
|
|
10767
|
-
| <a id="property-_update-3"></a> `_update` | `Selection` | - | [`Shape`](#shape-1).[`_update`](#property-_update-6) | [shapes/Shape.ts:
|
|
10749
|
+
| <a id="property-_data-12"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-1).[`_data`](#property-_data-15) | [shapes/Shape.ts:116](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L116) |
|
|
10750
|
+
| <a id="property-_enter-3"></a> `_enter` | `Selection` | - | [`Shape`](#shape-1).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:127](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L127) |
|
|
10751
|
+
| <a id="property-_exit-3"></a> `_exit` | `Selection` | - | [`Shape`](#shape-1).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:128](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L128) |
|
|
10752
|
+
| <a id="property-_group-10"></a> `_group` | `Selection` | - | [`Shape`](#shape-1).[`_group`](#property-_group-13) | [shapes/Shape.ts:125](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L125) |
|
|
10753
|
+
| <a id="property-_hovergroup-3"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-1).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:129](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L129) |
|
|
10754
|
+
| <a id="property-_labelclass-4"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-1).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:117](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L117) |
|
|
10755
|
+
| <a id="property-_name-3"></a> `_name` | `string` | - | [`Shape`](#shape-1).[`_name`](#property-_name-6) | [shapes/Shape.ts:118](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L118) |
|
|
10756
|
+
| <a id="property-_path-3"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-1).[`_path`](#property-_path-6) | [shapes/Shape.ts:131](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L131) |
|
|
10757
|
+
| <a id="property-_scenerenderer-10"></a> `_sceneRenderer?` | `SvgRenderer` | SvgRenderer mounted by the standalone `render()` path; reused across redraws. | [`Shape`](#shape-1).[`_sceneRenderer`](#property-_scenerenderer-13) | [shapes/Shape.ts:133](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L133) |
|
|
10758
|
+
| <a id="property-_select-12"></a> `_select` | `Selection` | - | [`Shape`](#shape-1).[`_select`](#property-_select-15) | [shapes/Shape.ts:121](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L121) |
|
|
10759
|
+
| <a id="property-_tagname-3"></a> `_tagName` | `string` | - | [`Shape`](#shape-1).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:119](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L119) |
|
|
10760
|
+
| <a id="property-_texturedefs-3"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-1).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:120](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L120) |
|
|
10761
|
+
| <a id="property-_transition-8"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-1).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:122](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L122) |
|
|
10762
|
+
| <a id="property-_update-3"></a> `_update` | `Selection` | - | [`Shape`](#shape-1).[`_update`](#property-_update-6) | [shapes/Shape.ts:126](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L126) |
|
|
10768
10763
|
| <a id="property-_uuid-12"></a> `_uuid` | `string` | - | [`Shape`](#shape-1).[`_uuid`](#property-_uuid-16) | [utils/BaseClass.ts:81](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L81) |
|
|
10769
10764
|
| <a id="property-ctx-12"></a> `ctx` | `Record`\<`string`, `unknown`\> | Chart-internal scratch (d3 layout instances, computed derived state). | [`Shape`](#shape-1).[`ctx`](#property-ctx-16) | [utils/BaseClass.ts:79](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L79) |
|
|
10770
10765
|
| <a id="property-schema-13"></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. | [`Shape`](#shape-1).[`schema`](#property-schema-17) | [utils/BaseClass.ts:77](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L77) |
|
|
@@ -10795,7 +10790,7 @@ Creates SVG Paths based on an array of data.
|
|
|
10795
10790
|
|
|
10796
10791
|
> `optional` **\_dataFilter**(`data`: `DataPoint`[]): `DataPoint`[]
|
|
10797
10792
|
|
|
10798
|
-
Defined in: [shapes/Shape.ts:
|
|
10793
|
+
Defined in: [shapes/Shape.ts:124](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L124)
|
|
10799
10794
|
|
|
10800
10795
|
###### Parameters
|
|
10801
10796
|
|
|
@@ -10819,7 +10814,7 @@ Defined in: [shapes/Shape.ts:119](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
10819
10814
|
|
|
10820
10815
|
> **active**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
10821
10816
|
|
|
10822
|
-
Defined in: [shapes/Shape.ts:
|
|
10817
|
+
Defined in: [shapes/Shape.ts:632](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L632)
|
|
10823
10818
|
|
|
10824
10819
|
The active callback function for highlighting shapes.
|
|
10825
10820
|
|
|
@@ -10835,7 +10830,7 @@ The active callback function for highlighting shapes.
|
|
|
10835
10830
|
|
|
10836
10831
|
> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
10837
10832
|
|
|
10838
|
-
Defined in: [shapes/Shape.ts:
|
|
10833
|
+
Defined in: [shapes/Shape.ts:633](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L633)
|
|
10839
10834
|
|
|
10840
10835
|
The active callback function for highlighting shapes.
|
|
10841
10836
|
|
|
@@ -10861,7 +10856,7 @@ The active callback function for highlighting shapes.
|
|
|
10861
10856
|
|
|
10862
10857
|
> **activeStyle**(): `Record`\<`string`, `unknown`\>
|
|
10863
10858
|
|
|
10864
|
-
Defined in: [shapes/Shape.ts:
|
|
10859
|
+
Defined in: [shapes/Shape.ts:647](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L647)
|
|
10865
10860
|
|
|
10866
10861
|
The style to apply to active shapes.
|
|
10867
10862
|
|
|
@@ -10877,7 +10872,7 @@ The style to apply to active shapes.
|
|
|
10877
10872
|
|
|
10878
10873
|
> **activeStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
10879
10874
|
|
|
10880
|
-
Defined in: [shapes/Shape.ts:
|
|
10875
|
+
Defined in: [shapes/Shape.ts:648](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L648)
|
|
10881
10876
|
|
|
10882
10877
|
The style to apply to active shapes.
|
|
10883
10878
|
|
|
@@ -10949,7 +10944,7 @@ keys (e.g. `width`/`height` for Rect) in autocomplete + type checks.
|
|
|
10949
10944
|
|
|
10950
10945
|
> **data**(): `DataPoint`[]
|
|
10951
10946
|
|
|
10952
|
-
Defined in: [shapes/Shape.ts:
|
|
10947
|
+
Defined in: [shapes/Shape.ts:659](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L659)
|
|
10953
10948
|
|
|
10954
10949
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
10955
10950
|
|
|
@@ -10965,7 +10960,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
10965
10960
|
|
|
10966
10961
|
> **data**(`_`: `DataPoint`[]): `this`
|
|
10967
10962
|
|
|
10968
|
-
Defined in: [shapes/Shape.ts:
|
|
10963
|
+
Defined in: [shapes/Shape.ts:660](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L660)
|
|
10969
10964
|
|
|
10970
10965
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
10971
10966
|
|
|
@@ -10991,7 +10986,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
10991
10986
|
|
|
10992
10987
|
> **hover**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
10993
10988
|
|
|
10994
|
-
Defined in: [shapes/Shape.ts:
|
|
10989
|
+
Defined in: [shapes/Shape.ts:668](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L668)
|
|
10995
10990
|
|
|
10996
10991
|
The hover callback function for highlighting shapes on mouseover.
|
|
10997
10992
|
|
|
@@ -11007,7 +11002,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
11007
11002
|
|
|
11008
11003
|
> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
11009
11004
|
|
|
11010
|
-
Defined in: [shapes/Shape.ts:
|
|
11005
|
+
Defined in: [shapes/Shape.ts:669](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L669)
|
|
11011
11006
|
|
|
11012
11007
|
The hover callback function for highlighting shapes on mouseover.
|
|
11013
11008
|
|
|
@@ -11033,7 +11028,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
11033
11028
|
|
|
11034
11029
|
> **hoverStyle**(): `Record`\<`string`, `unknown`\>
|
|
11035
11030
|
|
|
11036
|
-
Defined in: [shapes/Shape.ts:
|
|
11031
|
+
Defined in: [shapes/Shape.ts:682](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L682)
|
|
11037
11032
|
|
|
11038
11033
|
The style to apply to hovered shapes.
|
|
11039
11034
|
|
|
@@ -11049,7 +11044,7 @@ The style to apply to hovered shapes.
|
|
|
11049
11044
|
|
|
11050
11045
|
> **hoverStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
11051
11046
|
|
|
11052
|
-
Defined in: [shapes/Shape.ts:
|
|
11047
|
+
Defined in: [shapes/Shape.ts:683](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L683)
|
|
11053
11048
|
|
|
11054
11049
|
The style to apply to hovered shapes.
|
|
11055
11050
|
|
|
@@ -11075,7 +11070,7 @@ The style to apply to hovered shapes.
|
|
|
11075
11070
|
|
|
11076
11071
|
> **labelConfig**(): `Record`\<`string`, `unknown`\>
|
|
11077
11072
|
|
|
11078
|
-
Defined in: [shapes/Shape.ts:
|
|
11073
|
+
Defined in: [shapes/Shape.ts:693](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L693)
|
|
11079
11074
|
|
|
11080
11075
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
11081
11076
|
|
|
@@ -11091,7 +11086,7 @@ A pass-through to the config method of the TextBox class used to create a shape'
|
|
|
11091
11086
|
|
|
11092
11087
|
> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
11093
11088
|
|
|
11094
|
-
Defined in: [shapes/Shape.ts:
|
|
11089
|
+
Defined in: [shapes/Shape.ts:694](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L694)
|
|
11095
11090
|
|
|
11096
11091
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
11097
11092
|
|
|
@@ -11364,7 +11359,7 @@ Parent config used by the wrapper.
|
|
|
11364
11359
|
|
|
11365
11360
|
> **render**(`callback?`: () => `void`): `this`
|
|
11366
11361
|
|
|
11367
|
-
Defined in: [shapes/Shape.ts:
|
|
11362
|
+
Defined in: [shapes/Shape.ts:524](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L524)
|
|
11368
11363
|
|
|
11369
11364
|
###### Parameters
|
|
11370
11365
|
|
|
@@ -11388,7 +11383,7 @@ Defined in: [shapes/Shape.ts:518](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
11388
11383
|
|
|
11389
11384
|
> **select**(): `Selection`
|
|
11390
11385
|
|
|
11391
|
-
Defined in: [shapes/Shape.ts:
|
|
11386
|
+
Defined in: [shapes/Shape.ts:704](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L704)
|
|
11392
11387
|
|
|
11393
11388
|
The SVG container element as a d3 selector or DOM element.
|
|
11394
11389
|
|
|
@@ -11404,7 +11399,7 @@ The SVG container element as a d3 selector or DOM element.
|
|
|
11404
11399
|
|
|
11405
11400
|
> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`
|
|
11406
11401
|
|
|
11407
|
-
Defined in: [shapes/Shape.ts:
|
|
11402
|
+
Defined in: [shapes/Shape.ts:705](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L705)
|
|
11408
11403
|
|
|
11409
11404
|
The SVG container element as a d3 selector or DOM element.
|
|
11410
11405
|
|
|
@@ -11472,7 +11467,7 @@ Configuration object with key/value pairs applied as method calls on each shape.
|
|
|
11472
11467
|
|
|
11473
11468
|
> **sort**(): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`
|
|
11474
11469
|
|
|
11475
|
-
Defined in: [shapes/Shape.ts:
|
|
11470
|
+
Defined in: [shapes/Shape.ts:715](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L715)
|
|
11476
11471
|
|
|
11477
11472
|
A comparator function used to sort shapes for layering order.
|
|
11478
11473
|
|
|
@@ -11488,7 +11483,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
11488
11483
|
|
|
11489
11484
|
> **sort**(`_`: ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`): `this`
|
|
11490
11485
|
|
|
11491
|
-
Defined in: [shapes/Shape.ts:
|
|
11486
|
+
Defined in: [shapes/Shape.ts:716](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L716)
|
|
11492
11487
|
|
|
11493
11488
|
A comparator function used to sort shapes for layering order.
|
|
11494
11489
|
|
|
@@ -11514,7 +11509,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
11514
11509
|
|
|
11515
11510
|
> **textureDefault**(): `Record`\<`string`, `unknown`\>
|
|
11516
11511
|
|
|
11517
|
-
Defined in: [shapes/Shape.ts:
|
|
11512
|
+
Defined in: [shapes/Shape.ts:728](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L728)
|
|
11518
11513
|
|
|
11519
11514
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
11520
11515
|
|
|
@@ -11530,7 +11525,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
11530
11525
|
|
|
11531
11526
|
> **textureDefault**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
11532
11527
|
|
|
11533
|
-
Defined in: [shapes/Shape.ts:
|
|
11528
|
+
Defined in: [shapes/Shape.ts:729](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L729)
|
|
11534
11529
|
|
|
11535
11530
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
11536
11531
|
|
|
@@ -11554,7 +11549,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
11554
11549
|
|
|
11555
11550
|
> **toScene**(): `GroupNode`
|
|
11556
11551
|
|
|
11557
|
-
Defined in: [shapes/Shape.ts:
|
|
11552
|
+
Defined in: [shapes/Shape.ts:421](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L421)
|
|
11558
11553
|
|
|
11559
11554
|
Produces a backend-agnostic scene graph for this shape's data, reusing the
|
|
11560
11555
|
same accessors render() applies to the DOM. This is the migration seam toward
|
|
@@ -11630,23 +11625,22 @@ return d === "Back" ? "Get outta here" : d;
|
|
|
11630
11625
|
|
|
11631
11626
|
| Property | Type | Description | Inherited from | Defined in |
|
|
11632
11627
|
| ------ | ------ | ------ | ------ | ------ |
|
|
11633
|
-
| <a id="property-_activegroup-4"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-1).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:
|
|
11634
|
-
| <a id="property-_backgroundimageclass-4"></a> `_backgroundImageClass` | [`Image`](#image) | - | [`Shape`](#shape-1).[`_backgroundImageClass`](#property-_backgroundimageclass-6) | [shapes/Shape.ts:110](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L110) |
|
|
11628
|
+
| <a id="property-_activegroup-4"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-1).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:130](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L130) |
|
|
11635
11629
|
| <a id="property-_configdefault-13"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | - | [`Shape`](#shape-1).[`_configDefault`](#property-_configdefault-16) | [utils/BaseClass.ts:82](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L82) |
|
|
11636
|
-
| <a id="property-_data-13"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-1).[`_data`](#property-_data-15) | [shapes/Shape.ts:
|
|
11637
|
-
| <a id="property-_enter-4"></a> `_enter` | `Selection` | - | [`Shape`](#shape-1).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:
|
|
11638
|
-
| <a id="property-_exit-4"></a> `_exit` | `Selection` | - | [`Shape`](#shape-1).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:
|
|
11639
|
-
| <a id="property-_group-11"></a> `_group` | `Selection` | - | [`Shape`](#shape-1).[`_group`](#property-_group-13) | [shapes/Shape.ts:
|
|
11640
|
-
| <a id="property-_hovergroup-4"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-1).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:
|
|
11641
|
-
| <a id="property-_labelclass-5"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-1).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:
|
|
11642
|
-
| <a id="property-_name-4"></a> `_name` | `string` | - | [`Shape`](#shape-1).[`_name`](#property-_name-6) | [shapes/Shape.ts:
|
|
11643
|
-
| <a id="property-_path-4"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-1).[`_path`](#property-_path-6) | [shapes/Shape.ts:
|
|
11644
|
-
| <a id="property-_scenerenderer-11"></a> `_sceneRenderer?` | `SvgRenderer` | SvgRenderer mounted by the standalone `render()` path; reused across redraws. | [`Shape`](#shape-1).[`_sceneRenderer`](#property-_scenerenderer-13) | [shapes/Shape.ts:
|
|
11645
|
-
| <a id="property-_select-13"></a> `_select` | `Selection` | - | [`Shape`](#shape-1).[`_select`](#property-_select-15) | [shapes/Shape.ts:
|
|
11646
|
-
| <a id="property-_tagname-4"></a> `_tagName` | `string` | - | [`Shape`](#shape-1).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:
|
|
11647
|
-
| <a id="property-_texturedefs-4"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-1).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:
|
|
11648
|
-
| <a id="property-_transition-9"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-1).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:
|
|
11649
|
-
| <a id="property-_update-4"></a> `_update` | `Selection` | - | [`Shape`](#shape-1).[`_update`](#property-_update-6) | [shapes/Shape.ts:
|
|
11630
|
+
| <a id="property-_data-13"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-1).[`_data`](#property-_data-15) | [shapes/Shape.ts:116](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L116) |
|
|
11631
|
+
| <a id="property-_enter-4"></a> `_enter` | `Selection` | - | [`Shape`](#shape-1).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:127](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L127) |
|
|
11632
|
+
| <a id="property-_exit-4"></a> `_exit` | `Selection` | - | [`Shape`](#shape-1).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:128](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L128) |
|
|
11633
|
+
| <a id="property-_group-11"></a> `_group` | `Selection` | - | [`Shape`](#shape-1).[`_group`](#property-_group-13) | [shapes/Shape.ts:125](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L125) |
|
|
11634
|
+
| <a id="property-_hovergroup-4"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-1).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:129](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L129) |
|
|
11635
|
+
| <a id="property-_labelclass-5"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-1).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:117](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L117) |
|
|
11636
|
+
| <a id="property-_name-4"></a> `_name` | `string` | - | [`Shape`](#shape-1).[`_name`](#property-_name-6) | [shapes/Shape.ts:118](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L118) |
|
|
11637
|
+
| <a id="property-_path-4"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-1).[`_path`](#property-_path-6) | [shapes/Shape.ts:131](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L131) |
|
|
11638
|
+
| <a id="property-_scenerenderer-11"></a> `_sceneRenderer?` | `SvgRenderer` | SvgRenderer mounted by the standalone `render()` path; reused across redraws. | [`Shape`](#shape-1).[`_sceneRenderer`](#property-_scenerenderer-13) | [shapes/Shape.ts:133](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L133) |
|
|
11639
|
+
| <a id="property-_select-13"></a> `_select` | `Selection` | - | [`Shape`](#shape-1).[`_select`](#property-_select-15) | [shapes/Shape.ts:121](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L121) |
|
|
11640
|
+
| <a id="property-_tagname-4"></a> `_tagName` | `string` | - | [`Shape`](#shape-1).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:119](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L119) |
|
|
11641
|
+
| <a id="property-_texturedefs-4"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-1).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:120](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L120) |
|
|
11642
|
+
| <a id="property-_transition-9"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-1).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:122](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L122) |
|
|
11643
|
+
| <a id="property-_update-4"></a> `_update` | `Selection` | - | [`Shape`](#shape-1).[`_update`](#property-_update-6) | [shapes/Shape.ts:126](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L126) |
|
|
11650
11644
|
| <a id="property-_uuid-13"></a> `_uuid` | `string` | - | [`Shape`](#shape-1).[`_uuid`](#property-_uuid-16) | [utils/BaseClass.ts:81](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L81) |
|
|
11651
11645
|
| <a id="property-ctx-13"></a> `ctx` | `Record`\<`string`, `unknown`\> | Chart-internal scratch (d3 layout instances, computed derived state). | [`Shape`](#shape-1).[`ctx`](#property-ctx-16) | [utils/BaseClass.ts:79](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L79) |
|
|
11652
11646
|
| <a id="property-schema-14"></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. | [`Shape`](#shape-1).[`schema`](#property-schema-17) | [utils/BaseClass.ts:77](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L77) |
|
|
@@ -11657,7 +11651,7 @@ return d === "Back" ? "Get outta here" : d;
|
|
|
11657
11651
|
|
|
11658
11652
|
### Plot
|
|
11659
11653
|
|
|
11660
|
-
Defined in: [charts/Plot/index.ts:
|
|
11654
|
+
Defined in: [charts/Plot/index.ts:88](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L88)
|
|
11661
11655
|
|
|
11662
11656
|
Creates an x/y plot based on an array of data.
|
|
11663
11657
|
|
|
@@ -11677,7 +11671,7 @@ Creates an x/y plot based on an array of data.
|
|
|
11677
11671
|
|
|
11678
11672
|
> **\_drawSceneToTarget**(`durationOverride?`: `number`): `void`
|
|
11679
11673
|
|
|
11680
|
-
Defined in: [charts/viz/Viz.ts:
|
|
11674
|
+
Defined in: [charts/viz/Viz.ts:344](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/Viz.ts#L344)
|
|
11681
11675
|
|
|
11682
11676
|
Renders this chart through the @d3plus/render pluggable backends. Called
|
|
11683
11677
|
automatically by `render()`. The compute pass draws into `this._select`
|
|
@@ -11706,7 +11700,7 @@ svg's children get cleared so only the scene output is visible.
|
|
|
11706
11700
|
|
|
11707
11701
|
> **\_paint**(`pCtx`: `PlotPaintContext`): [`Plot`](#plot)
|
|
11708
11702
|
|
|
11709
|
-
Defined in: [charts/Plot/index.ts:
|
|
11703
|
+
Defined in: [charts/Plot/index.ts:394](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L394)
|
|
11710
11704
|
|
|
11711
11705
|
Paint phase: production axis rendering, shape buffer setup, and shape
|
|
11712
11706
|
emission with event handlers. Receives all cross-phase locals from
|
|
@@ -11729,7 +11723,7 @@ scope beyond the explicit context).
|
|
|
11729
11723
|
|
|
11730
11724
|
> **\_scheduleSceneRepaint**(): `void`
|
|
11731
11725
|
|
|
11732
|
-
Defined in: [charts/viz/Viz.ts:
|
|
11726
|
+
Defined in: [charts/viz/Viz.ts:644](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/Viz.ts#L644)
|
|
11733
11727
|
|
|
11734
11728
|
Coalesces interaction-driven scene repaints (hover/active dimming) into a
|
|
11735
11729
|
single paint per animation frame. A fast pointer sweep across a dense
|
|
@@ -11753,7 +11747,7 @@ intermediate paints are wasted — collapse them to one rAF-scheduled draw.
|
|
|
11753
11747
|
|
|
11754
11748
|
> **\_wirePlotShapeEvents**(`shape`: `object`, `shapeKey`: `string`, `events`: `string`[]): `void`
|
|
11755
11749
|
|
|
11756
|
-
Defined in: [charts/Plot/index.ts:
|
|
11750
|
+
Defined in: [charts/Plot/index.ts:296](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L296)
|
|
11757
11751
|
|
|
11758
11752
|
Wires user-registered `on()` event handlers onto a freshly-configured
|
|
11759
11753
|
shape instance. Splits the registered events into three buckets:
|
|
@@ -11837,7 +11831,7 @@ Custom aggregation methods for each data key.
|
|
|
11837
11831
|
|
|
11838
11832
|
> **annotations**(`_?`: `unknown`): [`Plot`](#plot) \| `unknown`[]
|
|
11839
11833
|
|
|
11840
|
-
Defined in: [charts/Plot/index.ts:
|
|
11834
|
+
Defined in: [charts/Plot/index.ts:409](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L409)
|
|
11841
11835
|
|
|
11842
11836
|
Allows drawing custom shapes to be used as annotations in the provided x/y plot. This method accepts custom config objects for the [Shape](http://d3plus.org/docs/#Shape) class, either a single config object or an array of config objects. Each config object requires an additional parameter, the "shape", which denotes which [Shape](http://d3plus.org/docs/#Shape) sub-class to use ([Rect](http://d3plus.org/docs/#Rect), [Line](http://d3plus.org/docs/#Line), etc).
|
|
11843
11837
|
|
|
@@ -11907,7 +11901,7 @@ Configuration object for the attribution style.
|
|
|
11907
11901
|
|
|
11908
11902
|
> **axisPersist**(`_?`: `boolean`): `boolean` \| [`Plot`](#plot)
|
|
11909
11903
|
|
|
11910
|
-
Defined in: [charts/Plot/index.ts:
|
|
11904
|
+
Defined in: [charts/Plot/index.ts:418](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L418)
|
|
11911
11905
|
|
|
11912
11906
|
Determines whether the x and y axes should have their scales persist while users filter the data, the timeline being the prime example (set this to `true` to make the axes stay consistent when the timeline changes).
|
|
11913
11907
|
|
|
@@ -11951,7 +11945,7 @@ Configuration object for the back button.
|
|
|
11951
11945
|
|
|
11952
11946
|
> **backgroundConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
11953
11947
|
|
|
11954
|
-
Defined in: [charts/Plot/index.ts:
|
|
11948
|
+
Defined in: [charts/Plot/index.ts:427](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L427)
|
|
11955
11949
|
|
|
11956
11950
|
A d3plus-shape configuration Object used for styling the background rectangle of the inner x/y plot (behind all of the shapes and gridlines).
|
|
11957
11951
|
|
|
@@ -11971,7 +11965,7 @@ A d3plus-shape configuration Object used for styling the background rectangle of
|
|
|
11971
11965
|
|
|
11972
11966
|
> **buffer**(`_?`: `boolean` \| `Record`\<`string`, `boolean`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
11973
11967
|
|
|
11974
|
-
Defined in: [charts/Plot/index.ts:
|
|
11968
|
+
Defined in: [charts/Plot/index.ts:436](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L436)
|
|
11975
11969
|
|
|
11976
11970
|
Determines whether or not to add additional padding at the ends of x or y scales. The most commone use for this is in Scatter Plots, so that the shapes do not appear directly on the axis itself. The value provided can either be `true` or `false` to toggle the behavior for all shape types, or a keyed Object for each shape type (ie. `{Bar: false, Circle: true, Line: false}`).
|
|
11977
11971
|
|
|
@@ -12135,7 +12129,7 @@ Defines which side of the visualization to anchor the color scale. Acceptable va
|
|
|
12135
12129
|
|
|
12136
12130
|
> **confidence**(`_?`: `unknown`): `false` \| [`Plot`](#plot) \| \[`number`, `number`\]
|
|
12137
12131
|
|
|
12138
|
-
Defined in: [charts/Plot/index.ts:
|
|
12132
|
+
Defined in: [charts/Plot/index.ts:464](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L464)
|
|
12139
12133
|
|
|
12140
12134
|
The confidence interval as an array of [lower, upper] bounds.
|
|
12141
12135
|
|
|
@@ -12167,7 +12161,7 @@ var data = {id: "alpha", value: 10, lci: 9, hci: 11};
|
|
|
12167
12161
|
|
|
12168
12162
|
> **confidenceConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
12169
12163
|
|
|
12170
|
-
Defined in: [charts/Plot/index.ts:
|
|
12164
|
+
Defined in: [charts/Plot/index.ts:481](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L481)
|
|
12171
12165
|
|
|
12172
12166
|
Configuration object for shapes rendered as confidence intervals.
|
|
12173
12167
|
|
|
@@ -12262,7 +12256,7 @@ Defaults to an empty array (`[]`).
|
|
|
12262
12256
|
|
|
12263
12257
|
> **destroy**(): `this`
|
|
12264
12258
|
|
|
12265
|
-
Defined in: [charts/viz/Viz.ts:
|
|
12259
|
+
Defined in: [charts/viz/Viz.ts:660](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/Viz.ts#L660)
|
|
12266
12260
|
|
|
12267
12261
|
Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.
|
|
12268
12262
|
|
|
@@ -12376,7 +12370,7 @@ The interval, in milliseconds, for checking if the visualization is visible on t
|
|
|
12376
12370
|
|
|
12377
12371
|
> **discreteCutoff**(`_?`: `number`): `number` \| [`Plot`](#plot)
|
|
12378
12372
|
|
|
12379
|
-
Defined in: [charts/Plot/index.ts:
|
|
12373
|
+
Defined in: [charts/Plot/index.ts:490](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L490)
|
|
12380
12374
|
|
|
12381
12375
|
When the width or height of the chart is less than or equal to this pixel value, the discrete axis will not be shown. This helps produce slick sparklines. Set this value to `0` to disable the behavior entirely.
|
|
12382
12376
|
|
|
@@ -12516,7 +12510,7 @@ Defines the mapping between data and shape. The value can be a String matching a
|
|
|
12516
12510
|
|
|
12517
12511
|
> **groupPadding**(`_?`: `number`): `number` \| [`Plot`](#plot)
|
|
12518
12512
|
|
|
12519
|
-
Defined in: [charts/Plot/index.ts:
|
|
12513
|
+
Defined in: [charts/Plot/index.ts:499](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L499)
|
|
12520
12514
|
|
|
12521
12515
|
The pixel space between groups of bars.
|
|
12522
12516
|
|
|
@@ -12660,7 +12654,7 @@ Accessor function or string key for the label of each data point.
|
|
|
12660
12654
|
|
|
12661
12655
|
> **labelConnectorConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
12662
12656
|
|
|
12663
|
-
Defined in: [charts/Plot/index.ts:
|
|
12657
|
+
Defined in: [charts/Plot/index.ts:508](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L508)
|
|
12664
12658
|
|
|
12665
12659
|
The d3plus-shape config used on the Line shapes created to connect lineLabels to the end of their associated Line path.
|
|
12666
12660
|
|
|
@@ -12680,7 +12674,7 @@ The d3plus-shape config used on the Line shapes created to connect lineLabels to
|
|
|
12680
12674
|
|
|
12681
12675
|
> **labelPosition**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)
|
|
12682
12676
|
|
|
12683
|
-
Defined in: [charts/Plot/index.ts:
|
|
12677
|
+
Defined in: [charts/Plot/index.ts:518](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L518)
|
|
12684
12678
|
|
|
12685
12679
|
The behavior to be used when calculating the position and size of each shape's label(s). The value passed can either be the _String_ name of the behavior to be used for all shapes, or an accessor _Function_ that will be provided each data point and will be expected to return the behavior to be used for that data point. The availability and options for this method depend on the default logic for each Shape. As an example, the values "outside" or "inside" can be set for Bar shapes, whose "auto" default will calculate the best position dynamically based on the available space.
|
|
12686
12680
|
|
|
@@ -12844,7 +12838,7 @@ Configuration object for the legend tooltip.
|
|
|
12844
12838
|
|
|
12845
12839
|
> **lineMarkerConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
12846
12840
|
|
|
12847
|
-
Defined in: [charts/Plot/index.ts:
|
|
12841
|
+
Defined in: [charts/Plot/index.ts:530](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L530)
|
|
12848
12842
|
|
|
12849
12843
|
Shape config for the Circle shapes drawn by the lineMarkers method.
|
|
12850
12844
|
|
|
@@ -12864,7 +12858,7 @@ Shape config for the Circle shapes drawn by the lineMarkers method.
|
|
|
12864
12858
|
|
|
12865
12859
|
> **lineMarkers**(`_?`: `boolean`): `boolean` \| [`Plot`](#plot)
|
|
12866
12860
|
|
|
12867
|
-
Defined in: [charts/Plot/index.ts:
|
|
12861
|
+
Defined in: [charts/Plot/index.ts:539](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L539)
|
|
12868
12862
|
|
|
12869
12863
|
Draws circle markers on each vertex of a Line.
|
|
12870
12864
|
|
|
@@ -13303,7 +13297,7 @@ Draws the visualization given the specified configuration.
|
|
|
13303
13297
|
|
|
13304
13298
|
> **renderer**(): `"svg"` \| `"canvas"`
|
|
13305
13299
|
|
|
13306
|
-
Defined in: [charts/viz/Viz.ts:
|
|
13300
|
+
Defined in: [charts/viz/Viz.ts:292](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/Viz.ts#L292)
|
|
13307
13301
|
|
|
13308
13302
|
Selects which @d3plus/render backend paints the visible output.
|
|
13309
13303
|
`"svg"` = SvgRenderer (default), `"canvas"` = CanvasRenderer.
|
|
@@ -13321,7 +13315,7 @@ Boolean arguments both normalize to `"svg"`.
|
|
|
13321
13315
|
|
|
13322
13316
|
> **renderer**(`_`: `boolean` \| `"svg"` \| `"canvas"`): `this`
|
|
13323
13317
|
|
|
13324
|
-
Defined in: [charts/viz/Viz.ts:
|
|
13318
|
+
Defined in: [charts/viz/Viz.ts:293](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/Viz.ts#L293)
|
|
13325
13319
|
|
|
13326
13320
|
Selects which @d3plus/render backend paints the visible output.
|
|
13327
13321
|
`"svg"` = SvgRenderer (default), `"canvas"` = CanvasRenderer.
|
|
@@ -13349,7 +13343,7 @@ Boolean arguments both normalize to `"svg"`.
|
|
|
13349
13343
|
|
|
13350
13344
|
> **renderMode**(): `"full"` \| `"compute"`
|
|
13351
13345
|
|
|
13352
|
-
Defined in: [charts/viz/Viz.ts:
|
|
13346
|
+
Defined in: [charts/viz/Viz.ts:306](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/Viz.ts#L306)
|
|
13353
13347
|
|
|
13354
13348
|
"full" runs the DOM enter/update/exit for every shape; "compute"
|
|
13355
13349
|
skips DOM work and only populates the scene data (`_textData`,
|
|
@@ -13368,7 +13362,7 @@ skips DOM work and only populates the scene data (`_textData`,
|
|
|
13368
13362
|
|
|
13369
13363
|
> **renderMode**(`_`: `"full"` \| `"compute"`): `this`
|
|
13370
13364
|
|
|
13371
|
-
Defined in: [charts/viz/Viz.ts:
|
|
13365
|
+
Defined in: [charts/viz/Viz.ts:307](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/Viz.ts#L307)
|
|
13372
13366
|
|
|
13373
13367
|
"full" runs the DOM enter/update/exit for every shape; "compute"
|
|
13374
13368
|
skips DOM work and only populates the scene data (`_textData`,
|
|
@@ -13395,7 +13389,7 @@ skips DOM work and only populates the scene data (`_textData`,
|
|
|
13395
13389
|
|
|
13396
13390
|
> **renderScene**(`target`: `Element`, `opts?`: `object`): `Promise`\<\{ `renderer`: `Renderer`; `scene`: `Scene`; \}\>
|
|
13397
13391
|
|
|
13398
|
-
Defined in: [charts/viz/Viz.ts:
|
|
13392
|
+
Defined in: [charts/viz/Viz.ts:321](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/Viz.ts#L321)
|
|
13399
13393
|
|
|
13400
13394
|
Public entry point that renders this chart through the @d3plus/render
|
|
13401
13395
|
pluggable backends. The compute pass happens via render() (in an svg
|
|
@@ -13539,7 +13533,7 @@ Configuration object with key/value pairs applied as method calls on each shape.
|
|
|
13539
13533
|
|
|
13540
13534
|
> **size**(`_?`: `false` \| `PlotAccessorArg`): [`Plot`](#plot) \| `PlotAccessor`
|
|
13541
13535
|
|
|
13542
|
-
Defined in: [charts/Plot/index.ts:
|
|
13536
|
+
Defined in: [charts/Plot/index.ts:548](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L548)
|
|
13543
13537
|
|
|
13544
13538
|
Sets the size of bubbles to the given Number, data key, or function.
|
|
13545
13539
|
|
|
@@ -13557,41 +13551,56 @@ Sets the size of bubbles to the given Number, data key, or function.
|
|
|
13557
13551
|
|
|
13558
13552
|
##### stackOffset()
|
|
13559
13553
|
|
|
13560
|
-
> **stackOffset**(`_?`: `string` \|
|
|
13554
|
+
> **stackOffset**(`_?`: `string` \| `StackOffsetFn`): [`Plot`](#plot) \| `StackOffsetFn`
|
|
13561
13555
|
|
|
13562
|
-
Defined in: [charts/Plot/index.ts:
|
|
13556
|
+
Defined in: [charts/Plot/index.ts:561](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L561)
|
|
13563
13557
|
|
|
13564
|
-
Sets the
|
|
13558
|
+
Sets the vertical offset applied to stacked series. Accepts a named
|
|
13559
|
+
offset — `"diverging"` (default), `"none"`, `"expand"`, `"silhouette"`,
|
|
13560
|
+
or `"wiggle"` — or a custom offset function. Unknown names warn and fall
|
|
13561
|
+
back to `"diverging"`. If *value* is not specified, returns the current
|
|
13562
|
+
stack offset function.
|
|
13565
13563
|
|
|
13566
13564
|
###### Parameters
|
|
13567
13565
|
|
|
13568
13566
|
| Parameter | Type |
|
|
13569
13567
|
| ------ | ------ |
|
|
13570
|
-
| `_?` | `string` \|
|
|
13568
|
+
| `_?` | `string` \| `StackOffsetFn` |
|
|
13571
13569
|
|
|
13572
13570
|
###### Returns
|
|
13573
13571
|
|
|
13574
|
-
[`Plot`](#plot) \|
|
|
13572
|
+
[`Plot`](#plot) \| `StackOffsetFn`
|
|
13575
13573
|
|
|
13576
13574
|
<a id="stackorder"></a>
|
|
13577
13575
|
|
|
13578
13576
|
##### stackOrder()
|
|
13579
13577
|
|
|
13580
|
-
> **stackOrder**(`_?`: `
|
|
13578
|
+
> **stackOrder**(`_?`: `StackOrderInput`): [`Plot`](#plot) \| `string`[] \| `StackOrderFn`
|
|
13579
|
+
|
|
13580
|
+
Defined in: [charts/Plot/index.ts:581](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L581)
|
|
13581
13581
|
|
|
13582
|
-
|
|
13582
|
+
Sets the order of stacked series, from the bottom of the stack upward.
|
|
13583
|
+
Accepts:
|
|
13584
|
+
- a named order: `"descending"` (default) / `"ascending"` by summed
|
|
13585
|
+
value, `"key"` / `"keyReverse"` alphabetically by series key,
|
|
13586
|
+
`"none"` / `"data"` for input order, or d3's `"insideOut"`,
|
|
13587
|
+
`"appearance"`, `"reverse"`;
|
|
13588
|
+
- an Array of series keys for an explicit order;
|
|
13589
|
+
- a value accessor, or a `{value, order}` config, to rank series by an
|
|
13590
|
+
aggregate of any data field.
|
|
13583
13591
|
|
|
13584
|
-
|
|
13592
|
+
Unknown named strings warn and fall back to `"descending"`. If *value*
|
|
13593
|
+
is not specified, returns the current stack order.
|
|
13585
13594
|
|
|
13586
13595
|
###### Parameters
|
|
13587
13596
|
|
|
13588
13597
|
| Parameter | Type |
|
|
13589
13598
|
| ------ | ------ |
|
|
13590
|
-
| `_?` | `
|
|
13599
|
+
| `_?` | `StackOrderInput` |
|
|
13591
13600
|
|
|
13592
13601
|
###### Returns
|
|
13593
13602
|
|
|
13594
|
-
[`Plot`](#plot) \|
|
|
13603
|
+
[`Plot`](#plot) \| `string`[] \| `StackOrderFn`
|
|
13595
13604
|
|
|
13596
13605
|
<a id="subtitle"></a>
|
|
13597
13606
|
|
|
@@ -13905,6 +13914,27 @@ Tells the title whether or not to use the internal padding defined by the visual
|
|
|
13905
13914
|
|
|
13906
13915
|
[`Viz`](#viz).[`titlePadding`](#titlepadding-1)
|
|
13907
13916
|
|
|
13917
|
+
<a id="tocanvas"></a>
|
|
13918
|
+
|
|
13919
|
+
##### toCanvas()
|
|
13920
|
+
|
|
13921
|
+
> **toCanvas**(): `unknown`
|
|
13922
|
+
|
|
13923
|
+
Defined in: [charts/viz/Viz.ts:281](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/Viz.ts#L281)
|
|
13924
|
+
|
|
13925
|
+
Returns the underlying canvas element of the most recent render when the
|
|
13926
|
+
canvas backend is active (`renderer("canvas")`), or `undefined` otherwise.
|
|
13927
|
+
Server-side callers cast this to their native canvas to encode a raster
|
|
13928
|
+
(see `@d3plus/ssr`).
|
|
13929
|
+
|
|
13930
|
+
###### Returns
|
|
13931
|
+
|
|
13932
|
+
`unknown`
|
|
13933
|
+
|
|
13934
|
+
###### Inherited from
|
|
13935
|
+
|
|
13936
|
+
[`Viz`](#viz).[`toCanvas`](#tocanvas-1)
|
|
13937
|
+
|
|
13908
13938
|
<a id="tooltip"></a>
|
|
13909
13939
|
|
|
13910
13940
|
##### tooltip()
|
|
@@ -13959,7 +13989,7 @@ Configuration object for the tooltip.
|
|
|
13959
13989
|
|
|
13960
13990
|
> **toScene**(): `Scene`
|
|
13961
13991
|
|
|
13962
|
-
Defined in: [charts/Plot/index.ts:
|
|
13992
|
+
Defined in: [charts/Plot/index.ts:244](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L244)
|
|
13963
13993
|
|
|
13964
13994
|
Composes the chart's scene graph: the native shape scenes from Viz.toScene
|
|
13965
13995
|
(bars/lines/areas + labels) plus snapshots of the rendered axes, so a Plot
|
|
@@ -13973,6 +14003,28 @@ renders fully — geometry and axes — through the @d3plus/render backends.
|
|
|
13973
14003
|
|
|
13974
14004
|
[`Viz`](#viz).[`toScene`](#toscene-19)
|
|
13975
14005
|
|
|
14006
|
+
<a id="tosvgstring"></a>
|
|
14007
|
+
|
|
14008
|
+
##### toSVGString()
|
|
14009
|
+
|
|
14010
|
+
> **toSVGString**(): `string`
|
|
14011
|
+
|
|
14012
|
+
Defined in: [charts/viz/Viz.ts:271](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/Viz.ts#L271)
|
|
14013
|
+
|
|
14014
|
+
Serializes the most recently rendered output to an SVG string. Returns
|
|
14015
|
+
`""` if the chart has not been rendered yet. Both backends support this:
|
|
14016
|
+
the SVG backend returns its live `<svg>`, the canvas backend re-renders the
|
|
14017
|
+
retained scene through a throwaway SVG backend. Primarily used for
|
|
14018
|
+
server-side rendering (see `@d3plus/ssr`).
|
|
14019
|
+
|
|
14020
|
+
###### Returns
|
|
14021
|
+
|
|
14022
|
+
`string`
|
|
14023
|
+
|
|
14024
|
+
###### Inherited from
|
|
14025
|
+
|
|
14026
|
+
[`Viz`](#viz).[`toSVGString`](#tosvgstring-1)
|
|
14027
|
+
|
|
13976
14028
|
<a id="total"></a>
|
|
13977
14029
|
|
|
13978
14030
|
##### total()
|
|
@@ -14133,7 +14185,7 @@ return d === "Back" ? "Get outta here" : d;
|
|
|
14133
14185
|
|
|
14134
14186
|
> **x**(`_?`: `PlotAccessorArg`): [`Plot`](#plot) \| `PlotAccessor`
|
|
14135
14187
|
|
|
14136
|
-
Defined in: [charts/Plot/index.ts:
|
|
14188
|
+
Defined in: [charts/Plot/index.ts:590](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L590)
|
|
14137
14189
|
|
|
14138
14190
|
Accessor function or string key for the x-axis value of each data point.
|
|
14139
14191
|
|
|
@@ -14153,7 +14205,7 @@ Accessor function or string key for the x-axis value of each data point.
|
|
|
14153
14205
|
|
|
14154
14206
|
> **x2**(`_?`: `PlotAccessorArg`): [`Plot`](#plot) \| `PlotAccessor`
|
|
14155
14207
|
|
|
14156
|
-
Defined in: [charts/Plot/index.ts:
|
|
14208
|
+
Defined in: [charts/Plot/index.ts:604](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L604)
|
|
14157
14209
|
|
|
14158
14210
|
Accessor function or string key for the secondary x-axis value of each data point.
|
|
14159
14211
|
|
|
@@ -14173,7 +14225,7 @@ Accessor function or string key for the secondary x-axis value of each data poin
|
|
|
14173
14225
|
|
|
14174
14226
|
> **x2Config**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
14175
14227
|
|
|
14176
|
-
Defined in: [charts/Plot/index.ts:
|
|
14228
|
+
Defined in: [charts/Plot/index.ts:627](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L627)
|
|
14177
14229
|
|
|
14178
14230
|
A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the secondary x-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.
|
|
14179
14231
|
|
|
@@ -14193,7 +14245,7 @@ A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config use
|
|
|
14193
14245
|
|
|
14194
14246
|
> **xConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
14195
14247
|
|
|
14196
|
-
Defined in: [charts/Plot/index.ts:
|
|
14248
|
+
Defined in: [charts/Plot/index.ts:618](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L618)
|
|
14197
14249
|
|
|
14198
14250
|
A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the x-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.
|
|
14199
14251
|
|
|
@@ -14213,7 +14265,7 @@ A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config use
|
|
|
14213
14265
|
|
|
14214
14266
|
> **y**(`_?`: `PlotAccessorArg`): [`Plot`](#plot) \| `PlotAccessor`
|
|
14215
14267
|
|
|
14216
|
-
Defined in: [charts/Plot/index.ts:
|
|
14268
|
+
Defined in: [charts/Plot/index.ts:636](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L636)
|
|
14217
14269
|
|
|
14218
14270
|
Accessor function or string key for the y-axis value of each data point.
|
|
14219
14271
|
|
|
@@ -14233,7 +14285,7 @@ Accessor function or string key for the y-axis value of each data point.
|
|
|
14233
14285
|
|
|
14234
14286
|
> **y2**(`_?`: `PlotAccessorArg`): [`Plot`](#plot) \| `PlotAccessor`
|
|
14235
14287
|
|
|
14236
|
-
Defined in: [charts/Plot/index.ts:
|
|
14288
|
+
Defined in: [charts/Plot/index.ts:650](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L650)
|
|
14237
14289
|
|
|
14238
14290
|
Accessor function or string key for the secondary y-axis value of each data point.
|
|
14239
14291
|
|
|
@@ -14253,7 +14305,7 @@ Accessor function or string key for the secondary y-axis value of each data poin
|
|
|
14253
14305
|
|
|
14254
14306
|
> **y2Config**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
14255
14307
|
|
|
14256
|
-
Defined in: [charts/Plot/index.ts:
|
|
14308
|
+
Defined in: [charts/Plot/index.ts:679](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L679)
|
|
14257
14309
|
|
|
14258
14310
|
A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the secondary y-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.
|
|
14259
14311
|
|
|
@@ -14273,7 +14325,7 @@ A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config use
|
|
|
14273
14325
|
|
|
14274
14326
|
> **yConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
14275
14327
|
|
|
14276
|
-
Defined in: [charts/Plot/index.ts:
|
|
14328
|
+
Defined in: [charts/Plot/index.ts:666](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Plot/index.ts#L666)
|
|
14277
14329
|
|
|
14278
14330
|
A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config used for the y-axis. Includes additional functionality where passing "auto" as the value for the [scale](http://d3plus.org/docs/#Axis.scale) method will determine if the scale should be "linear" or "log" based on the provided data.
|
|
14279
14331
|
|
|
@@ -14492,7 +14544,7 @@ Creates SVG rectangles based on an array of data. See [this example](https://d3p
|
|
|
14492
14544
|
|
|
14493
14545
|
> `optional` **\_dataFilter**(`data`: `DataPoint`[]): `DataPoint`[]
|
|
14494
14546
|
|
|
14495
|
-
Defined in: [shapes/Shape.ts:
|
|
14547
|
+
Defined in: [shapes/Shape.ts:124](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L124)
|
|
14496
14548
|
|
|
14497
14549
|
###### Parameters
|
|
14498
14550
|
|
|
@@ -14516,7 +14568,7 @@ Defined in: [shapes/Shape.ts:119](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
14516
14568
|
|
|
14517
14569
|
> **active**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
14518
14570
|
|
|
14519
|
-
Defined in: [shapes/Shape.ts:
|
|
14571
|
+
Defined in: [shapes/Shape.ts:632](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L632)
|
|
14520
14572
|
|
|
14521
14573
|
The active callback function for highlighting shapes.
|
|
14522
14574
|
|
|
@@ -14532,7 +14584,7 @@ The active callback function for highlighting shapes.
|
|
|
14532
14584
|
|
|
14533
14585
|
> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
14534
14586
|
|
|
14535
|
-
Defined in: [shapes/Shape.ts:
|
|
14587
|
+
Defined in: [shapes/Shape.ts:633](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L633)
|
|
14536
14588
|
|
|
14537
14589
|
The active callback function for highlighting shapes.
|
|
14538
14590
|
|
|
@@ -14558,7 +14610,7 @@ The active callback function for highlighting shapes.
|
|
|
14558
14610
|
|
|
14559
14611
|
> **activeStyle**(): `Record`\<`string`, `unknown`\>
|
|
14560
14612
|
|
|
14561
|
-
Defined in: [shapes/Shape.ts:
|
|
14613
|
+
Defined in: [shapes/Shape.ts:647](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L647)
|
|
14562
14614
|
|
|
14563
14615
|
The style to apply to active shapes.
|
|
14564
14616
|
|
|
@@ -14574,7 +14626,7 @@ The style to apply to active shapes.
|
|
|
14574
14626
|
|
|
14575
14627
|
> **activeStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
14576
14628
|
|
|
14577
|
-
Defined in: [shapes/Shape.ts:
|
|
14629
|
+
Defined in: [shapes/Shape.ts:648](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L648)
|
|
14578
14630
|
|
|
14579
14631
|
The style to apply to active shapes.
|
|
14580
14632
|
|
|
@@ -14646,7 +14698,7 @@ keys (e.g. `width`/`height` for Rect) in autocomplete + type checks.
|
|
|
14646
14698
|
|
|
14647
14699
|
> **data**(): `DataPoint`[]
|
|
14648
14700
|
|
|
14649
|
-
Defined in: [shapes/Shape.ts:
|
|
14701
|
+
Defined in: [shapes/Shape.ts:659](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L659)
|
|
14650
14702
|
|
|
14651
14703
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
14652
14704
|
|
|
@@ -14662,7 +14714,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
14662
14714
|
|
|
14663
14715
|
> **data**(`_`: `DataPoint`[]): `this`
|
|
14664
14716
|
|
|
14665
|
-
Defined in: [shapes/Shape.ts:
|
|
14717
|
+
Defined in: [shapes/Shape.ts:660](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L660)
|
|
14666
14718
|
|
|
14667
14719
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
14668
14720
|
|
|
@@ -14688,7 +14740,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
14688
14740
|
|
|
14689
14741
|
> **hover**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
14690
14742
|
|
|
14691
|
-
Defined in: [shapes/Shape.ts:
|
|
14743
|
+
Defined in: [shapes/Shape.ts:668](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L668)
|
|
14692
14744
|
|
|
14693
14745
|
The hover callback function for highlighting shapes on mouseover.
|
|
14694
14746
|
|
|
@@ -14704,7 +14756,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
14704
14756
|
|
|
14705
14757
|
> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
14706
14758
|
|
|
14707
|
-
Defined in: [shapes/Shape.ts:
|
|
14759
|
+
Defined in: [shapes/Shape.ts:669](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L669)
|
|
14708
14760
|
|
|
14709
14761
|
The hover callback function for highlighting shapes on mouseover.
|
|
14710
14762
|
|
|
@@ -14730,7 +14782,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
14730
14782
|
|
|
14731
14783
|
> **hoverStyle**(): `Record`\<`string`, `unknown`\>
|
|
14732
14784
|
|
|
14733
|
-
Defined in: [shapes/Shape.ts:
|
|
14785
|
+
Defined in: [shapes/Shape.ts:682](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L682)
|
|
14734
14786
|
|
|
14735
14787
|
The style to apply to hovered shapes.
|
|
14736
14788
|
|
|
@@ -14746,7 +14798,7 @@ The style to apply to hovered shapes.
|
|
|
14746
14798
|
|
|
14747
14799
|
> **hoverStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
14748
14800
|
|
|
14749
|
-
Defined in: [shapes/Shape.ts:
|
|
14801
|
+
Defined in: [shapes/Shape.ts:683](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L683)
|
|
14750
14802
|
|
|
14751
14803
|
The style to apply to hovered shapes.
|
|
14752
14804
|
|
|
@@ -14772,7 +14824,7 @@ The style to apply to hovered shapes.
|
|
|
14772
14824
|
|
|
14773
14825
|
> **labelConfig**(): `Record`\<`string`, `unknown`\>
|
|
14774
14826
|
|
|
14775
|
-
Defined in: [shapes/Shape.ts:
|
|
14827
|
+
Defined in: [shapes/Shape.ts:693](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L693)
|
|
14776
14828
|
|
|
14777
14829
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
14778
14830
|
|
|
@@ -14788,7 +14840,7 @@ A pass-through to the config method of the TextBox class used to create a shape'
|
|
|
14788
14840
|
|
|
14789
14841
|
> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
14790
14842
|
|
|
14791
|
-
Defined in: [shapes/Shape.ts:
|
|
14843
|
+
Defined in: [shapes/Shape.ts:694](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L694)
|
|
14792
14844
|
|
|
14793
14845
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
14794
14846
|
|
|
@@ -15061,7 +15113,7 @@ Parent config used by the wrapper.
|
|
|
15061
15113
|
|
|
15062
15114
|
> **render**(`callback?`: () => `void`): `this`
|
|
15063
15115
|
|
|
15064
|
-
Defined in: [shapes/Shape.ts:
|
|
15116
|
+
Defined in: [shapes/Shape.ts:524](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L524)
|
|
15065
15117
|
|
|
15066
15118
|
###### Parameters
|
|
15067
15119
|
|
|
@@ -15085,7 +15137,7 @@ Defined in: [shapes/Shape.ts:518](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
15085
15137
|
|
|
15086
15138
|
> **select**(): `Selection`
|
|
15087
15139
|
|
|
15088
|
-
Defined in: [shapes/Shape.ts:
|
|
15140
|
+
Defined in: [shapes/Shape.ts:704](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L704)
|
|
15089
15141
|
|
|
15090
15142
|
The SVG container element as a d3 selector or DOM element.
|
|
15091
15143
|
|
|
@@ -15101,7 +15153,7 @@ The SVG container element as a d3 selector or DOM element.
|
|
|
15101
15153
|
|
|
15102
15154
|
> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`
|
|
15103
15155
|
|
|
15104
|
-
Defined in: [shapes/Shape.ts:
|
|
15156
|
+
Defined in: [shapes/Shape.ts:705](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L705)
|
|
15105
15157
|
|
|
15106
15158
|
The SVG container element as a d3 selector or DOM element.
|
|
15107
15159
|
|
|
@@ -15169,7 +15221,7 @@ Configuration object with key/value pairs applied as method calls on each shape.
|
|
|
15169
15221
|
|
|
15170
15222
|
> **sort**(): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`
|
|
15171
15223
|
|
|
15172
|
-
Defined in: [shapes/Shape.ts:
|
|
15224
|
+
Defined in: [shapes/Shape.ts:715](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L715)
|
|
15173
15225
|
|
|
15174
15226
|
A comparator function used to sort shapes for layering order.
|
|
15175
15227
|
|
|
@@ -15185,7 +15237,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
15185
15237
|
|
|
15186
15238
|
> **sort**(`_`: ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`): `this`
|
|
15187
15239
|
|
|
15188
|
-
Defined in: [shapes/Shape.ts:
|
|
15240
|
+
Defined in: [shapes/Shape.ts:716](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L716)
|
|
15189
15241
|
|
|
15190
15242
|
A comparator function used to sort shapes for layering order.
|
|
15191
15243
|
|
|
@@ -15211,7 +15263,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
15211
15263
|
|
|
15212
15264
|
> **textureDefault**(): `Record`\<`string`, `unknown`\>
|
|
15213
15265
|
|
|
15214
|
-
Defined in: [shapes/Shape.ts:
|
|
15266
|
+
Defined in: [shapes/Shape.ts:728](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L728)
|
|
15215
15267
|
|
|
15216
15268
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
15217
15269
|
|
|
@@ -15227,7 +15279,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
15227
15279
|
|
|
15228
15280
|
> **textureDefault**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
15229
15281
|
|
|
15230
|
-
Defined in: [shapes/Shape.ts:
|
|
15282
|
+
Defined in: [shapes/Shape.ts:729](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L729)
|
|
15231
15283
|
|
|
15232
15284
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
15233
15285
|
|
|
@@ -15251,7 +15303,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
15251
15303
|
|
|
15252
15304
|
> **toScene**(): `GroupNode`
|
|
15253
15305
|
|
|
15254
|
-
Defined in: [shapes/Shape.ts:
|
|
15306
|
+
Defined in: [shapes/Shape.ts:421](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L421)
|
|
15255
15307
|
|
|
15256
15308
|
Produces a backend-agnostic scene graph for this shape's data, reusing the
|
|
15257
15309
|
same accessors render() applies to the DOM. This is the migration seam toward
|
|
@@ -15327,23 +15379,22 @@ return d === "Back" ? "Get outta here" : d;
|
|
|
15327
15379
|
|
|
15328
15380
|
| Property | Type | Description | Inherited from | Defined in |
|
|
15329
15381
|
| ------ | ------ | ------ | ------ | ------ |
|
|
15330
|
-
| <a id="property-_activegroup-5"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-1).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:
|
|
15331
|
-
| <a id="property-_backgroundimageclass-5"></a> `_backgroundImageClass` | [`Image`](#image) | - | [`Shape`](#shape-1).[`_backgroundImageClass`](#property-_backgroundimageclass-6) | [shapes/Shape.ts:110](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L110) |
|
|
15382
|
+
| <a id="property-_activegroup-5"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-1).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:130](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L130) |
|
|
15332
15383
|
| <a id="property-_configdefault-15"></a> `_configDefault?` | [`D3plusConfig`](#d3plusconfig) | - | [`Shape`](#shape-1).[`_configDefault`](#property-_configdefault-16) | [utils/BaseClass.ts:82](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L82) |
|
|
15333
|
-
| <a id="property-_data-14"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-1).[`_data`](#property-_data-15) | [shapes/Shape.ts:
|
|
15334
|
-
| <a id="property-_enter-5"></a> `_enter` | `Selection` | - | [`Shape`](#shape-1).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:
|
|
15335
|
-
| <a id="property-_exit-5"></a> `_exit` | `Selection` | - | [`Shape`](#shape-1).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:
|
|
15336
|
-
| <a id="property-_group-12"></a> `_group` | `Selection` | - | [`Shape`](#shape-1).[`_group`](#property-_group-13) | [shapes/Shape.ts:
|
|
15337
|
-
| <a id="property-_hovergroup-5"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-1).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:
|
|
15338
|
-
| <a id="property-_labelclass-6"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-1).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:
|
|
15339
|
-
| <a id="property-_name-5"></a> `_name` | `string` | - | [`Shape`](#shape-1).[`_name`](#property-_name-6) | [shapes/Shape.ts:
|
|
15340
|
-
| <a id="property-_path-5"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-1).[`_path`](#property-_path-6) | [shapes/Shape.ts:
|
|
15341
|
-
| <a id="property-_scenerenderer-12"></a> `_sceneRenderer?` | `SvgRenderer` | SvgRenderer mounted by the standalone `render()` path; reused across redraws. | [`Shape`](#shape-1).[`_sceneRenderer`](#property-_scenerenderer-13) | [shapes/Shape.ts:
|
|
15342
|
-
| <a id="property-_select-14"></a> `_select` | `Selection` | - | [`Shape`](#shape-1).[`_select`](#property-_select-15) | [shapes/Shape.ts:
|
|
15343
|
-
| <a id="property-_tagname-5"></a> `_tagName` | `string` | - | [`Shape`](#shape-1).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:
|
|
15344
|
-
| <a id="property-_texturedefs-5"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-1).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:
|
|
15345
|
-
| <a id="property-_transition-10"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-1).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:
|
|
15346
|
-
| <a id="property-_update-5"></a> `_update` | `Selection` | - | [`Shape`](#shape-1).[`_update`](#property-_update-6) | [shapes/Shape.ts:
|
|
15384
|
+
| <a id="property-_data-14"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-1).[`_data`](#property-_data-15) | [shapes/Shape.ts:116](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L116) |
|
|
15385
|
+
| <a id="property-_enter-5"></a> `_enter` | `Selection` | - | [`Shape`](#shape-1).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:127](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L127) |
|
|
15386
|
+
| <a id="property-_exit-5"></a> `_exit` | `Selection` | - | [`Shape`](#shape-1).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:128](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L128) |
|
|
15387
|
+
| <a id="property-_group-12"></a> `_group` | `Selection` | - | [`Shape`](#shape-1).[`_group`](#property-_group-13) | [shapes/Shape.ts:125](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L125) |
|
|
15388
|
+
| <a id="property-_hovergroup-5"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-1).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:129](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L129) |
|
|
15389
|
+
| <a id="property-_labelclass-6"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-1).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:117](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L117) |
|
|
15390
|
+
| <a id="property-_name-5"></a> `_name` | `string` | - | [`Shape`](#shape-1).[`_name`](#property-_name-6) | [shapes/Shape.ts:118](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L118) |
|
|
15391
|
+
| <a id="property-_path-5"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-1).[`_path`](#property-_path-6) | [shapes/Shape.ts:131](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L131) |
|
|
15392
|
+
| <a id="property-_scenerenderer-12"></a> `_sceneRenderer?` | `SvgRenderer` | SvgRenderer mounted by the standalone `render()` path; reused across redraws. | [`Shape`](#shape-1).[`_sceneRenderer`](#property-_scenerenderer-13) | [shapes/Shape.ts:133](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L133) |
|
|
15393
|
+
| <a id="property-_select-14"></a> `_select` | `Selection` | - | [`Shape`](#shape-1).[`_select`](#property-_select-15) | [shapes/Shape.ts:121](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L121) |
|
|
15394
|
+
| <a id="property-_tagname-5"></a> `_tagName` | `string` | - | [`Shape`](#shape-1).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:119](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L119) |
|
|
15395
|
+
| <a id="property-_texturedefs-5"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-1).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:120](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L120) |
|
|
15396
|
+
| <a id="property-_transition-10"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-1).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:122](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L122) |
|
|
15397
|
+
| <a id="property-_update-5"></a> `_update` | `Selection` | - | [`Shape`](#shape-1).[`_update`](#property-_update-6) | [shapes/Shape.ts:126](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L126) |
|
|
15347
15398
|
| <a id="property-_uuid-15"></a> `_uuid` | `string` | - | [`Shape`](#shape-1).[`_uuid`](#property-_uuid-16) | [utils/BaseClass.ts:81](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L81) |
|
|
15348
15399
|
| <a id="property-ctx-15"></a> `ctx` | `Record`\<`string`, `unknown`\> | Chart-internal scratch (d3 layout instances, computed derived state). | [`Shape`](#shape-1).[`ctx`](#property-ctx-16) | [utils/BaseClass.ts:79](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L79) |
|
|
15349
15400
|
| <a id="property-schema-16"></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. | [`Shape`](#shape-1).[`schema`](#property-schema-17) | [utils/BaseClass.ts:77](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/BaseClass.ts#L77) |
|
|
@@ -15354,7 +15405,7 @@ return d === "Back" ? "Get outta here" : d;
|
|
|
15354
15405
|
|
|
15355
15406
|
### Shape
|
|
15356
15407
|
|
|
15357
|
-
Defined in: [shapes/Shape.ts:
|
|
15408
|
+
Defined in: [shapes/Shape.ts:110](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L110)
|
|
15358
15409
|
|
|
15359
15410
|
An abstracted class for generating shapes.
|
|
15360
15411
|
|
|
@@ -15383,7 +15434,7 @@ An abstracted class for generating shapes.
|
|
|
15383
15434
|
|
|
15384
15435
|
> `optional` **\_dataFilter**(`data`: `DataPoint`[]): `DataPoint`[]
|
|
15385
15436
|
|
|
15386
|
-
Defined in: [shapes/Shape.ts:
|
|
15437
|
+
Defined in: [shapes/Shape.ts:124](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L124)
|
|
15387
15438
|
|
|
15388
15439
|
###### Parameters
|
|
15389
15440
|
|
|
@@ -15403,7 +15454,7 @@ Defined in: [shapes/Shape.ts:119](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
15403
15454
|
|
|
15404
15455
|
> **active**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
15405
15456
|
|
|
15406
|
-
Defined in: [shapes/Shape.ts:
|
|
15457
|
+
Defined in: [shapes/Shape.ts:632](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L632)
|
|
15407
15458
|
|
|
15408
15459
|
The active callback function for highlighting shapes.
|
|
15409
15460
|
|
|
@@ -15415,7 +15466,7 @@ The active callback function for highlighting shapes.
|
|
|
15415
15466
|
|
|
15416
15467
|
> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
15417
15468
|
|
|
15418
|
-
Defined in: [shapes/Shape.ts:
|
|
15469
|
+
Defined in: [shapes/Shape.ts:633](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L633)
|
|
15419
15470
|
|
|
15420
15471
|
The active callback function for highlighting shapes.
|
|
15421
15472
|
|
|
@@ -15437,7 +15488,7 @@ The active callback function for highlighting shapes.
|
|
|
15437
15488
|
|
|
15438
15489
|
> **activeStyle**(): `Record`\<`string`, `unknown`\>
|
|
15439
15490
|
|
|
15440
|
-
Defined in: [shapes/Shape.ts:
|
|
15491
|
+
Defined in: [shapes/Shape.ts:647](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L647)
|
|
15441
15492
|
|
|
15442
15493
|
The style to apply to active shapes.
|
|
15443
15494
|
|
|
@@ -15449,7 +15500,7 @@ The style to apply to active shapes.
|
|
|
15449
15500
|
|
|
15450
15501
|
> **activeStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
15451
15502
|
|
|
15452
|
-
Defined in: [shapes/Shape.ts:
|
|
15503
|
+
Defined in: [shapes/Shape.ts:648](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L648)
|
|
15453
15504
|
|
|
15454
15505
|
The style to apply to active shapes.
|
|
15455
15506
|
|
|
@@ -15471,7 +15522,7 @@ The style to apply to active shapes.
|
|
|
15471
15522
|
|
|
15472
15523
|
> **config**(): [`BaseShapeConfig`](#baseshapeconfig)
|
|
15473
15524
|
|
|
15474
|
-
Defined in: [shapes/Shape.ts:
|
|
15525
|
+
Defined in: [shapes/Shape.ts:742](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L742)
|
|
15475
15526
|
|
|
15476
15527
|
Narrowed `.config()` for Shape. Inherited surface from
|
|
15477
15528
|
`BaseClass.config()`; the override exists only to surface per-shape
|
|
@@ -15489,7 +15540,7 @@ keys (e.g. `width`/`height` for Rect) in autocomplete + type checks.
|
|
|
15489
15540
|
|
|
15490
15541
|
> **config**(`_`: `Partial`\<[`BaseShapeConfig`](#baseshapeconfig)\>): `this`
|
|
15491
15542
|
|
|
15492
|
-
Defined in: [shapes/Shape.ts:
|
|
15543
|
+
Defined in: [shapes/Shape.ts:743](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L743)
|
|
15493
15544
|
|
|
15494
15545
|
Narrowed `.config()` for Shape. Inherited surface from
|
|
15495
15546
|
`BaseClass.config()`; the override exists only to surface per-shape
|
|
@@ -15517,7 +15568,7 @@ keys (e.g. `width`/`height` for Rect) in autocomplete + type checks.
|
|
|
15517
15568
|
|
|
15518
15569
|
> **data**(): `DataPoint`[]
|
|
15519
15570
|
|
|
15520
|
-
Defined in: [shapes/Shape.ts:
|
|
15571
|
+
Defined in: [shapes/Shape.ts:659](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L659)
|
|
15521
15572
|
|
|
15522
15573
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
15523
15574
|
|
|
@@ -15529,7 +15580,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
15529
15580
|
|
|
15530
15581
|
> **data**(`_`: `DataPoint`[]): `this`
|
|
15531
15582
|
|
|
15532
|
-
Defined in: [shapes/Shape.ts:
|
|
15583
|
+
Defined in: [shapes/Shape.ts:660](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L660)
|
|
15533
15584
|
|
|
15534
15585
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
15535
15586
|
|
|
@@ -15551,7 +15602,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
15551
15602
|
|
|
15552
15603
|
> **hover**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
15553
15604
|
|
|
15554
|
-
Defined in: [shapes/Shape.ts:
|
|
15605
|
+
Defined in: [shapes/Shape.ts:668](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L668)
|
|
15555
15606
|
|
|
15556
15607
|
The hover callback function for highlighting shapes on mouseover.
|
|
15557
15608
|
|
|
@@ -15563,7 +15614,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
15563
15614
|
|
|
15564
15615
|
> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
15565
15616
|
|
|
15566
|
-
Defined in: [shapes/Shape.ts:
|
|
15617
|
+
Defined in: [shapes/Shape.ts:669](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L669)
|
|
15567
15618
|
|
|
15568
15619
|
The hover callback function for highlighting shapes on mouseover.
|
|
15569
15620
|
|
|
@@ -15585,7 +15636,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
15585
15636
|
|
|
15586
15637
|
> **hoverStyle**(): `Record`\<`string`, `unknown`\>
|
|
15587
15638
|
|
|
15588
|
-
Defined in: [shapes/Shape.ts:
|
|
15639
|
+
Defined in: [shapes/Shape.ts:682](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L682)
|
|
15589
15640
|
|
|
15590
15641
|
The style to apply to hovered shapes.
|
|
15591
15642
|
|
|
@@ -15597,7 +15648,7 @@ The style to apply to hovered shapes.
|
|
|
15597
15648
|
|
|
15598
15649
|
> **hoverStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
15599
15650
|
|
|
15600
|
-
Defined in: [shapes/Shape.ts:
|
|
15651
|
+
Defined in: [shapes/Shape.ts:683](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L683)
|
|
15601
15652
|
|
|
15602
15653
|
The style to apply to hovered shapes.
|
|
15603
15654
|
|
|
@@ -15619,7 +15670,7 @@ The style to apply to hovered shapes.
|
|
|
15619
15670
|
|
|
15620
15671
|
> **labelConfig**(): `Record`\<`string`, `unknown`\>
|
|
15621
15672
|
|
|
15622
|
-
Defined in: [shapes/Shape.ts:
|
|
15673
|
+
Defined in: [shapes/Shape.ts:693](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L693)
|
|
15623
15674
|
|
|
15624
15675
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
15625
15676
|
|
|
@@ -15631,7 +15682,7 @@ A pass-through to the config method of the TextBox class used to create a shape'
|
|
|
15631
15682
|
|
|
15632
15683
|
> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
15633
15684
|
|
|
15634
|
-
Defined in: [shapes/Shape.ts:
|
|
15685
|
+
Defined in: [shapes/Shape.ts:694](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L694)
|
|
15635
15686
|
|
|
15636
15687
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
15637
15688
|
|
|
@@ -15900,7 +15951,7 @@ Parent config used by the wrapper.
|
|
|
15900
15951
|
|
|
15901
15952
|
> **render**(`callback?`: () => `void`): `this`
|
|
15902
15953
|
|
|
15903
|
-
Defined in: [shapes/Shape.ts:
|
|
15954
|
+
Defined in: [shapes/Shape.ts:524](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L524)
|
|
15904
15955
|
|
|
15905
15956
|
###### Parameters
|
|
15906
15957
|
|
|
@@ -15920,7 +15971,7 @@ Defined in: [shapes/Shape.ts:518](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
15920
15971
|
|
|
15921
15972
|
> **select**(): `Selection`
|
|
15922
15973
|
|
|
15923
|
-
Defined in: [shapes/Shape.ts:
|
|
15974
|
+
Defined in: [shapes/Shape.ts:704](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L704)
|
|
15924
15975
|
|
|
15925
15976
|
The SVG container element as a d3 selector or DOM element.
|
|
15926
15977
|
|
|
@@ -15932,7 +15983,7 @@ The SVG container element as a d3 selector or DOM element.
|
|
|
15932
15983
|
|
|
15933
15984
|
> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`
|
|
15934
15985
|
|
|
15935
|
-
Defined in: [shapes/Shape.ts:
|
|
15986
|
+
Defined in: [shapes/Shape.ts:705](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L705)
|
|
15936
15987
|
|
|
15937
15988
|
The SVG container element as a d3 selector or DOM element.
|
|
15938
15989
|
|
|
@@ -15996,7 +16047,7 @@ Configuration object with key/value pairs applied as method calls on each shape.
|
|
|
15996
16047
|
|
|
15997
16048
|
> **sort**(): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`
|
|
15998
16049
|
|
|
15999
|
-
Defined in: [shapes/Shape.ts:
|
|
16050
|
+
Defined in: [shapes/Shape.ts:715](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L715)
|
|
16000
16051
|
|
|
16001
16052
|
A comparator function used to sort shapes for layering order.
|
|
16002
16053
|
|
|
@@ -16008,7 +16059,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
16008
16059
|
|
|
16009
16060
|
> **sort**(`_`: ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`): `this`
|
|
16010
16061
|
|
|
16011
|
-
Defined in: [shapes/Shape.ts:
|
|
16062
|
+
Defined in: [shapes/Shape.ts:716](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L716)
|
|
16012
16063
|
|
|
16013
16064
|
A comparator function used to sort shapes for layering order.
|
|
16014
16065
|
|
|
@@ -16030,7 +16081,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
16030
16081
|
|
|
16031
16082
|
> **textureDefault**(): `Record`\<`string`, `unknown`\>
|
|
16032
16083
|
|
|
16033
|
-
Defined in: [shapes/Shape.ts:
|
|
16084
|
+
Defined in: [shapes/Shape.ts:728](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L728)
|
|
16034
16085
|
|
|
16035
16086
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
16036
16087
|
|
|
@@ -16042,7 +16093,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
16042
16093
|
|
|
16043
16094
|
> **textureDefault**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
16044
16095
|
|
|
16045
|
-
Defined in: [shapes/Shape.ts:
|
|
16096
|
+
Defined in: [shapes/Shape.ts:729](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L729)
|
|
16046
16097
|
|
|
16047
16098
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
16048
16099
|
|
|
@@ -16062,7 +16113,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
16062
16113
|
|
|
16063
16114
|
> **toScene**(): `GroupNode`
|
|
16064
16115
|
|
|
16065
|
-
Defined in: [shapes/Shape.ts:
|
|
16116
|
+
Defined in: [shapes/Shape.ts:421](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L421)
|
|
16066
16117
|
|
|
16067
16118
|
Produces a backend-agnostic scene graph for this shape's data, reusing the
|
|
16068
16119
|
same accessors render() applies to the DOM. This is the migration seam toward
|
|
@@ -16134,23 +16185,22 @@ return d === "Back" ? "Get outta here" : d;
|
|
|
16134
16185
|
|
|
16135
16186
|
| Property | Type | Description | Inherited from | Defined in |
|
|
16136
16187
|
| ------ | ------ | ------ | ------ | ------ |
|
|
16137
|
-
| <a id="property-_activegroup-6"></a> `_activeGroup` | `Selection` | - | - | [shapes/Shape.ts:
|
|
16138
|
-
| <a id="property-_backgroundimageclass-6"></a> `_backgroundImageClass` | [`Image`](#image) | - | - | [shapes/Shape.ts:110](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L110) |
|
|
16188
|
+
| <a id="property-_activegroup-6"></a> `_activeGroup` | `Selection` | - | - | [shapes/Shape.ts:130](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L130) |
|
|
16139
16189
|
| <a id="property-_configdefault-16"></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) |
|
|
16140
|
-
| <a id="property-_data-15"></a> `_data` | `DataPoint`[] | - | - | [shapes/Shape.ts:
|
|
16141
|
-
| <a id="property-_enter-6"></a> `_enter` | `Selection` | - | - | [shapes/Shape.ts:
|
|
16142
|
-
| <a id="property-_exit-6"></a> `_exit` | `Selection` | - | - | [shapes/Shape.ts:
|
|
16143
|
-
| <a id="property-_group-13"></a> `_group` | `Selection` | - | - | [shapes/Shape.ts:
|
|
16144
|
-
| <a id="property-_hovergroup-6"></a> `_hoverGroup` | `Selection` | - | - | [shapes/Shape.ts:
|
|
16145
|
-
| <a id="property-_labelclass-7"></a> `_labelClass` | [`TextBox`](#textbox) | - | - | [shapes/Shape.ts:
|
|
16146
|
-
| <a id="property-_name-6"></a> `_name` | `string` | - | - | [shapes/Shape.ts:
|
|
16147
|
-
| <a id="property-_path-6"></a> `_path` | `Record`\<`string`, `unknown`\> | - | - | [shapes/Shape.ts:
|
|
16148
|
-
| <a id="property-_scenerenderer-13"></a> `_sceneRenderer?` | `SvgRenderer` | SvgRenderer mounted by the standalone `render()` path; reused across redraws. | - | [shapes/Shape.ts:
|
|
16149
|
-
| <a id="property-_select-15"></a> `_select` | `Selection` | - | - | [shapes/Shape.ts:
|
|
16150
|
-
| <a id="property-_tagname-6"></a> `_tagName` | `string` | - | - | [shapes/Shape.ts:
|
|
16151
|
-
| <a id="property-_texturedefs-6"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | - | [shapes/Shape.ts:
|
|
16152
|
-
| <a id="property-_transition-11"></a> `_transition` | `Transition`\<`BaseType`\> | - | - | [shapes/Shape.ts:
|
|
16153
|
-
| <a id="property-_update-6"></a> `_update` | `Selection` | - | - | [shapes/Shape.ts:
|
|
16190
|
+
| <a id="property-_data-15"></a> `_data` | `DataPoint`[] | - | - | [shapes/Shape.ts:116](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L116) |
|
|
16191
|
+
| <a id="property-_enter-6"></a> `_enter` | `Selection` | - | - | [shapes/Shape.ts:127](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L127) |
|
|
16192
|
+
| <a id="property-_exit-6"></a> `_exit` | `Selection` | - | - | [shapes/Shape.ts:128](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L128) |
|
|
16193
|
+
| <a id="property-_group-13"></a> `_group` | `Selection` | - | - | [shapes/Shape.ts:125](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L125) |
|
|
16194
|
+
| <a id="property-_hovergroup-6"></a> `_hoverGroup` | `Selection` | - | - | [shapes/Shape.ts:129](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L129) |
|
|
16195
|
+
| <a id="property-_labelclass-7"></a> `_labelClass` | [`TextBox`](#textbox) | - | - | [shapes/Shape.ts:117](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L117) |
|
|
16196
|
+
| <a id="property-_name-6"></a> `_name` | `string` | - | - | [shapes/Shape.ts:118](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L118) |
|
|
16197
|
+
| <a id="property-_path-6"></a> `_path` | `Record`\<`string`, `unknown`\> | - | - | [shapes/Shape.ts:131](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L131) |
|
|
16198
|
+
| <a id="property-_scenerenderer-13"></a> `_sceneRenderer?` | `SvgRenderer` | SvgRenderer mounted by the standalone `render()` path; reused across redraws. | - | [shapes/Shape.ts:133](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L133) |
|
|
16199
|
+
| <a id="property-_select-15"></a> `_select` | `Selection` | - | - | [shapes/Shape.ts:121](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L121) |
|
|
16200
|
+
| <a id="property-_tagname-6"></a> `_tagName` | `string` | - | - | [shapes/Shape.ts:119](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L119) |
|
|
16201
|
+
| <a id="property-_texturedefs-6"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | - | [shapes/Shape.ts:120](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L120) |
|
|
16202
|
+
| <a id="property-_transition-11"></a> `_transition` | `Transition`\<`BaseType`\> | - | - | [shapes/Shape.ts:122](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L122) |
|
|
16203
|
+
| <a id="property-_update-6"></a> `_update` | `Selection` | - | - | [shapes/Shape.ts:126](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/Shape.ts#L126) |
|
|
16154
16204
|
| <a id="property-_uuid-16"></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) |
|
|
16155
16205
|
| <a id="property-ctx-16"></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) |
|
|
16156
16206
|
| <a id="property-schema-17"></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) |
|
|
@@ -18094,7 +18144,7 @@ Viz auto-sets this when rendering: chart.tooltipClass.parent(chart._select.node(
|
|
|
18094
18144
|
|
|
18095
18145
|
###### Call Signature
|
|
18096
18146
|
|
|
18097
|
-
> **position**(): (`d`: `DataPoint`, `i?`: `number`) => `
|
|
18147
|
+
> **position**(): (`d`: `DataPoint`, `i?`: `number`) => `HTMLElement` \| `number`[]
|
|
18098
18148
|
|
|
18099
18149
|
Defined in: [components/Tooltip.ts:517](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Tooltip.ts#L517)
|
|
18100
18150
|
|
|
@@ -18102,7 +18152,7 @@ The position of each tooltip. Can be an HTMLElement to anchor to, a selection st
|
|
|
18102
18152
|
|
|
18103
18153
|
###### Returns
|
|
18104
18154
|
|
|
18105
|
-
(`d`: `DataPoint`, `i?`: `number`) => `
|
|
18155
|
+
(`d`: `DataPoint`, `i?`: `number`) => `HTMLElement` \| `number`[]
|
|
18106
18156
|
|
|
18107
18157
|
###### Example
|
|
18108
18158
|
|
|
@@ -18114,7 +18164,7 @@ return [d.x, d.y];
|
|
|
18114
18164
|
|
|
18115
18165
|
###### Call Signature
|
|
18116
18166
|
|
|
18117
|
-
> **position**(`_`: `string` \| `
|
|
18167
|
+
> **position**(`_`: `string` \| `HTMLElement` \| `number`[] \| ((`d`: `DataPoint`, `i?`: `number`) => `HTMLElement` \| `number`[])): `this`
|
|
18118
18168
|
|
|
18119
18169
|
Defined in: [components/Tooltip.ts:518](https://github.com/d3plus/d3plus/blob/main/packages/core/src/components/Tooltip.ts#L518)
|
|
18120
18170
|
|
|
@@ -18124,7 +18174,7 @@ The position of each tooltip. Can be an HTMLElement to anchor to, a selection st
|
|
|
18124
18174
|
|
|
18125
18175
|
| Parameter | Type |
|
|
18126
18176
|
| ------ | ------ |
|
|
18127
|
-
| `_` | `string` \| `
|
|
18177
|
+
| `_` | `string` \| `HTMLElement` \| `number`[] \| ((`d`: `DataPoint`, `i?`: `number`) => `HTMLElement` \| `number`[]) |
|
|
18128
18178
|
|
|
18129
18179
|
###### Returns
|
|
18130
18180
|
|
|
@@ -18535,7 +18585,7 @@ Creates an x/y plot based on an array of data. See [this example](https://d3plus
|
|
|
18535
18585
|
|
|
18536
18586
|
> **\_drawSceneToTarget**(`durationOverride?`: `number`): `void`
|
|
18537
18587
|
|
|
18538
|
-
Defined in: [charts/viz/Viz.ts:
|
|
18588
|
+
Defined in: [charts/viz/Viz.ts:344](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/Viz.ts#L344)
|
|
18539
18589
|
|
|
18540
18590
|
Renders this chart through the @d3plus/render pluggable backends. Called
|
|
18541
18591
|
automatically by `render()`. The compute pass draws into `this._select`
|
|
@@ -18560,7 +18610,7 @@ svg's children get cleared so only the scene output is visible.
|
|
|
18560
18610
|
|
|
18561
18611
|
> **\_scheduleSceneRepaint**(): `void`
|
|
18562
18612
|
|
|
18563
|
-
Defined in: [charts/viz/Viz.ts:
|
|
18613
|
+
Defined in: [charts/viz/Viz.ts:644](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/Viz.ts#L644)
|
|
18564
18614
|
|
|
18565
18615
|
Coalesces interaction-driven scene repaints (hover/active dimming) into a
|
|
18566
18616
|
single paint per animation frame. A fast pointer sweep across a dense
|
|
@@ -18919,7 +18969,7 @@ Defaults to an empty array (`[]`).
|
|
|
18919
18969
|
|
|
18920
18970
|
> **destroy**(): `this`
|
|
18921
18971
|
|
|
18922
|
-
Defined in: [charts/viz/Viz.ts:
|
|
18972
|
+
Defined in: [charts/viz/Viz.ts:660](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/Viz.ts#L660)
|
|
18923
18973
|
|
|
18924
18974
|
Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.
|
|
18925
18975
|
|
|
@@ -19832,7 +19882,7 @@ Draws the visualization given the specified configuration.
|
|
|
19832
19882
|
|
|
19833
19883
|
> **renderer**(): `"svg"` \| `"canvas"`
|
|
19834
19884
|
|
|
19835
|
-
Defined in: [charts/viz/Viz.ts:
|
|
19885
|
+
Defined in: [charts/viz/Viz.ts:292](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/Viz.ts#L292)
|
|
19836
19886
|
|
|
19837
19887
|
Selects which @d3plus/render backend paints the visible output.
|
|
19838
19888
|
`"svg"` = SvgRenderer (default), `"canvas"` = CanvasRenderer.
|
|
@@ -19846,7 +19896,7 @@ Boolean arguments both normalize to `"svg"`.
|
|
|
19846
19896
|
|
|
19847
19897
|
> **renderer**(`_`: `boolean` \| `"svg"` \| `"canvas"`): `this`
|
|
19848
19898
|
|
|
19849
|
-
Defined in: [charts/viz/Viz.ts:
|
|
19899
|
+
Defined in: [charts/viz/Viz.ts:293](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/Viz.ts#L293)
|
|
19850
19900
|
|
|
19851
19901
|
Selects which @d3plus/render backend paints the visible output.
|
|
19852
19902
|
`"svg"` = SvgRenderer (default), `"canvas"` = CanvasRenderer.
|
|
@@ -19870,7 +19920,7 @@ Boolean arguments both normalize to `"svg"`.
|
|
|
19870
19920
|
|
|
19871
19921
|
> **renderMode**(): `"full"` \| `"compute"`
|
|
19872
19922
|
|
|
19873
|
-
Defined in: [charts/viz/Viz.ts:
|
|
19923
|
+
Defined in: [charts/viz/Viz.ts:306](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/Viz.ts#L306)
|
|
19874
19924
|
|
|
19875
19925
|
"full" runs the DOM enter/update/exit for every shape; "compute"
|
|
19876
19926
|
skips DOM work and only populates the scene data (`_textData`,
|
|
@@ -19885,7 +19935,7 @@ skips DOM work and only populates the scene data (`_textData`,
|
|
|
19885
19935
|
|
|
19886
19936
|
> **renderMode**(`_`: `"full"` \| `"compute"`): `this`
|
|
19887
19937
|
|
|
19888
|
-
Defined in: [charts/viz/Viz.ts:
|
|
19938
|
+
Defined in: [charts/viz/Viz.ts:307](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/Viz.ts#L307)
|
|
19889
19939
|
|
|
19890
19940
|
"full" runs the DOM enter/update/exit for every shape; "compute"
|
|
19891
19941
|
skips DOM work and only populates the scene data (`_textData`,
|
|
@@ -19908,7 +19958,7 @@ skips DOM work and only populates the scene data (`_textData`,
|
|
|
19908
19958
|
|
|
19909
19959
|
> **renderScene**(`target`: `Element`, `opts?`: `object`): `Promise`\<\{ `renderer`: `Renderer`; `scene`: `Scene`; \}\>
|
|
19910
19960
|
|
|
19911
|
-
Defined in: [charts/viz/Viz.ts:
|
|
19961
|
+
Defined in: [charts/viz/Viz.ts:321](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/Viz.ts#L321)
|
|
19912
19962
|
|
|
19913
19963
|
Public entry point that renders this chart through the @d3plus/render
|
|
19914
19964
|
pluggable backends. The compute pass happens via render() (in an svg
|
|
@@ -20354,6 +20404,23 @@ Tells the title whether or not to use the internal padding defined by the visual
|
|
|
20354
20404
|
|
|
20355
20405
|
`VizBase.titlePadding`
|
|
20356
20406
|
|
|
20407
|
+
<a id="tocanvas-1"></a>
|
|
20408
|
+
|
|
20409
|
+
##### toCanvas()
|
|
20410
|
+
|
|
20411
|
+
> **toCanvas**(): `unknown`
|
|
20412
|
+
|
|
20413
|
+
Defined in: [charts/viz/Viz.ts:281](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/Viz.ts#L281)
|
|
20414
|
+
|
|
20415
|
+
Returns the underlying canvas element of the most recent render when the
|
|
20416
|
+
canvas backend is active (`renderer("canvas")`), or `undefined` otherwise.
|
|
20417
|
+
Server-side callers cast this to their native canvas to encode a raster
|
|
20418
|
+
(see `@d3plus/ssr`).
|
|
20419
|
+
|
|
20420
|
+
###### Returns
|
|
20421
|
+
|
|
20422
|
+
`unknown`
|
|
20423
|
+
|
|
20357
20424
|
<a id="tooltip-2"></a>
|
|
20358
20425
|
|
|
20359
20426
|
##### tooltip()
|
|
@@ -20422,6 +20489,24 @@ by the most recent render. Combines:
|
|
|
20422
20489
|
|
|
20423
20490
|
`Scene`
|
|
20424
20491
|
|
|
20492
|
+
<a id="tosvgstring-1"></a>
|
|
20493
|
+
|
|
20494
|
+
##### toSVGString()
|
|
20495
|
+
|
|
20496
|
+
> **toSVGString**(): `string`
|
|
20497
|
+
|
|
20498
|
+
Defined in: [charts/viz/Viz.ts:271](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/viz/Viz.ts#L271)
|
|
20499
|
+
|
|
20500
|
+
Serializes the most recently rendered output to an SVG string. Returns
|
|
20501
|
+
`""` if the chart has not been rendered yet. Both backends support this:
|
|
20502
|
+
the SVG backend returns its live `<svg>`, the canvas backend re-renders the
|
|
20503
|
+
retained scene through a throwaway SVG backend. Primarily used for
|
|
20504
|
+
server-side rendering (see `@d3plus/ssr`).
|
|
20505
|
+
|
|
20506
|
+
###### Returns
|
|
20507
|
+
|
|
20508
|
+
`string`
|
|
20509
|
+
|
|
20425
20510
|
<a id="total-1"></a>
|
|
20426
20511
|
|
|
20427
20512
|
##### total()
|
|
@@ -21528,7 +21613,7 @@ Extends [`Plot`](#plot) — accepts all of its configuration. Adds or overrides
|
|
|
21528
21613
|
| `legend` | — |
|
|
21529
21614
|
|
|
21530
21615
|
|
|
21531
|
-
Defined in: [charts/BarChart/index.ts:
|
|
21616
|
+
Defined in: [charts/BarChart/index.ts:53](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/BarChart/index.ts#L53)
|
|
21532
21617
|
|
|
21533
21618
|
Creates a bar chart based on an array of data.
|
|
21534
21619
|
|
|
@@ -21615,7 +21700,7 @@ Extends [`Viz`](#viz) — accepts all of its configuration. Adds or overrides th
|
|
|
21615
21700
|
| `shapeConfig` | — |
|
|
21616
21701
|
|
|
21617
21702
|
|
|
21618
|
-
Defined in: [charts/Geomap/index.ts:
|
|
21703
|
+
Defined in: [charts/Geomap/index.ts:499](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Geomap/index.ts#L499)
|
|
21619
21704
|
|
|
21620
21705
|
Creates a geographical map with zooming, panning, image tiles, and the ability to layer choropleth paths and coordinate points.
|
|
21621
21706
|
|
|
@@ -21659,7 +21744,7 @@ Extends [`Viz`](#viz) — accepts all of its configuration. Adds or overrides th
|
|
|
21659
21744
|
| `label` | — |
|
|
21660
21745
|
|
|
21661
21746
|
|
|
21662
|
-
Defined in: [charts/Matrix/index.ts:
|
|
21747
|
+
Defined in: [charts/Matrix/index.ts:105](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Matrix/index.ts#L105)
|
|
21663
21748
|
|
|
21664
21749
|
Creates a simple rows/columns Matrix view of any dataset.
|
|
21665
21750
|
|
|
@@ -21712,7 +21797,7 @@ Extends [`Viz`](#viz) — accepts all of its configuration. Adds or overrides th
|
|
|
21712
21797
|
| `on` | — |
|
|
21713
21798
|
|
|
21714
21799
|
|
|
21715
|
-
Defined in: [charts/Pack/index.ts:
|
|
21800
|
+
Defined in: [charts/Pack/index.ts:162](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Pack/index.ts#L162)
|
|
21716
21801
|
|
|
21717
21802
|
Uses the d3 pack layout to create a Circle Packing chart based on an array of data.
|
|
21718
21803
|
|
|
@@ -21737,7 +21822,7 @@ Extends [`Viz`](#viz) — accepts all of its configuration. Adds or overrides th
|
|
|
21737
21822
|
| `legend` | — |
|
|
21738
21823
|
|
|
21739
21824
|
|
|
21740
|
-
Defined in: [charts/Pie/index.ts:
|
|
21825
|
+
Defined in: [charts/Pie/index.ts:128](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Pie/index.ts#L128)
|
|
21741
21826
|
|
|
21742
21827
|
Uses the d3 pie layout to create SVG arcs based on an array of data.
|
|
21743
21828
|
|
|
@@ -21808,7 +21893,7 @@ Extends [`Viz`](#viz) — accepts all of its configuration. Adds or overrides th
|
|
|
21808
21893
|
| `label` | — |
|
|
21809
21894
|
|
|
21810
21895
|
|
|
21811
|
-
Defined in: [charts/RadialMatrix/index.ts:
|
|
21896
|
+
Defined in: [charts/RadialMatrix/index.ts:138](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/RadialMatrix/index.ts#L138)
|
|
21812
21897
|
|
|
21813
21898
|
Creates a radial layout of a rows/columns Matrix of any dataset.
|
|
21814
21899
|
|
|
@@ -21945,7 +22030,7 @@ Extends [`Viz`](#viz) — accepts all of its configuration. Adds or overrides th
|
|
|
21945
22030
|
| `legend` | — |
|
|
21946
22031
|
|
|
21947
22032
|
|
|
21948
|
-
Defined in: [charts/Treemap/index.ts:
|
|
22033
|
+
Defined in: [charts/Treemap/index.ts:183](https://github.com/d3plus/d3plus/blob/main/packages/core/src/charts/Treemap/index.ts#L183)
|
|
21949
22034
|
|
|
21950
22035
|
Uses the d3 treemap layout to create SVG rectangles based on an array of data.
|
|
21951
22036
|
|
|
@@ -21955,7 +22040,7 @@ Uses the d3 treemap layout to create SVG rectangles based on an array of data.
|
|
|
21955
22040
|
|
|
21956
22041
|
### AreaConfig
|
|
21957
22042
|
|
|
21958
|
-
Defined in: [shapes/shapeConfig.ts:
|
|
22043
|
+
Defined in: [shapes/shapeConfig.ts:190](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L190)
|
|
21959
22044
|
|
|
21960
22045
|
Area-specific config (curve, defined, dual-edge x/y).
|
|
21961
22046
|
|
|
@@ -21976,49 +22061,50 @@ Area-specific config (curve, defined, dual-edge x/y).
|
|
|
21976
22061
|
| <a id="property-activestyle"></a> `activeStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for active data points. | [`BaseShapeConfig`](#baseshapeconfig).[`activeStyle`](#property-activestyle-2) | [shapes/shapeConfig.ts:56](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L56) |
|
|
21977
22062
|
| <a id="property-arialabel"></a> `ariaLabel?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA label per datum (accessibility). | [`BaseShapeConfig`](#baseshapeconfig).[`ariaLabel`](#property-arialabel-2) | [shapes/shapeConfig.ts:59](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L59) |
|
|
21978
22063
|
| <a id="property-backgroundimage"></a> `backgroundImage?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Optional background image per datum (url or accessor returning a url). | [`BaseShapeConfig`](#baseshapeconfig).[`backgroundImage`](#property-backgroundimage-2) | [shapes/shapeConfig.ts:61](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L61) |
|
|
21979
|
-
| <a id="property-
|
|
22064
|
+
| <a id="property-backgroundimagefit"></a> `backgroundImageFit?` | [`ConstOrAccessor`](#constoraccessor)\<`"cover"` \| `"contain"`\> | How a `backgroundImage` fits its shape: `"cover"` (default) fills the shape's bounding box, cropping the overflow and clipping to the outline; `"contain"` fits the whole image, centered and fully visible, inside the shape's largest inscribed rectangle. | [`BaseShapeConfig`](#baseshapeconfig).[`backgroundImageFit`](#property-backgroundimagefit-2) | [shapes/shapeConfig.ts:68](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L68) |
|
|
22065
|
+
| <a id="property-curve"></a> `curve?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | - | - | [shapes/shapeConfig.ts:191](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L191) |
|
|
21980
22066
|
| <a id="property-data"></a> `data?` | `DataPoint`[] | Data array driving the shape. | [`BaseShapeConfig`](#baseshapeconfig).[`data`](#property-data-2) | [shapes/shapeConfig.ts:49](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L49) |
|
|
21981
|
-
| <a id="property-defined"></a> `defined?` | (`d`: `DataPoint`) => `boolean` | Determines whether a data point is defined (a gap in the area when false). | - | [shapes/shapeConfig.ts:
|
|
21982
|
-
| <a id="property-discrete"></a> `discrete?` | `"x"` \| `"y"` | Discrete-axis key ("x" | "y") for charts that flip layout per axis. | [`BaseShapeConfig`](#baseshapeconfig).[`discrete`](#property-discrete-2) | [shapes/shapeConfig.ts:
|
|
21983
|
-
| <a id="property-duration"></a> `duration?` | `number` | Animation duration in ms. | [`BaseShapeConfig`](#baseshapeconfig).[`duration`](#property-duration-2) | [shapes/shapeConfig.ts:
|
|
21984
|
-
| <a id="property-fill"></a> `fill?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Fill color or accessor returning one. | [`BaseShapeConfig`](#baseshapeconfig).[`fill`](#property-fill-2) | [shapes/shapeConfig.ts:
|
|
21985
|
-
| <a id="property-fillopacity"></a> `fillOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Fill opacity (0..1). | [`BaseShapeConfig`](#baseshapeconfig).[`fillOpacity`](#property-fillopacity-2) | [shapes/shapeConfig.ts:
|
|
21986
|
-
| <a id="property-hitarea"></a> `hitArea?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\>) | Hit-area shape: function returning bounds or static bounds. | [`BaseShapeConfig`](#baseshapeconfig).[`hitArea`](#property-hitarea-2) | [shapes/shapeConfig.ts:
|
|
21987
|
-
| <a id="property-hover"></a> `hover?` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | Predicate or null marking which data points are currently hovered. | [`BaseShapeConfig`](#baseshapeconfig).[`hover`](#property-hover-2) | [shapes/shapeConfig.ts:
|
|
21988
|
-
| <a id="property-hoveropacity"></a> `hoverOpacity?` | `number` | Opacity applied to non-hovered data points. | [`BaseShapeConfig`](#baseshapeconfig).[`hoverOpacity`](#property-hoveropacity-2) | [shapes/shapeConfig.ts:
|
|
21989
|
-
| <a id="property-hoverstyle"></a> `hoverStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for hovered data points. | [`BaseShapeConfig`](#baseshapeconfig).[`hoverStyle`](#property-hoverstyle-2) | [shapes/shapeConfig.ts:
|
|
21990
|
-
| <a id="property-id"></a> `id?` | `AccessorFn` | Unique-id accessor per datum (used for keyed enter/update/exit). | [`BaseShapeConfig`](#baseshapeconfig).[`id`](#property-id-2) | [shapes/shapeConfig.ts:
|
|
21991
|
-
| <a id="property-label"></a> `label?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `false` \| `string`[]\> | Label text(s) per datum. False/undefined skips. | [`BaseShapeConfig`](#baseshapeconfig).[`label`](#property-label-3) | [shapes/shapeConfig.ts:
|
|
21992
|
-
| <a id="property-labelbounds"></a> `labelBounds?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\> \| `Record`\<`string`, `unknown`\>[]) | Label-bounds accessor (where to mount the label). | [`BaseShapeConfig`](#baseshapeconfig).[`labelBounds`](#property-labelbounds-2) | [shapes/shapeConfig.ts:
|
|
21993
|
-
| <a id="property-labelconfig"></a> `labelConfig?` | `Record`\<`string`, `unknown`\> | Label TextBox config (font, padding, etc.). | [`BaseShapeConfig`](#baseshapeconfig).[`labelConfig`](#property-labelconfig-2) | [shapes/shapeConfig.ts:
|
|
21994
|
-
| <a id="property-on"></a> `on?` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | Event handlers (Object.<event, handler>). | [`BaseShapeConfig`](#baseshapeconfig).[`on`](#property-on-2) | [shapes/shapeConfig.ts:
|
|
21995
|
-
| <a id="property-opacity"></a> `opacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Overall opacity (0..1). | [`BaseShapeConfig`](#baseshapeconfig).[`opacity`](#property-opacity-2) | [shapes/shapeConfig.ts:
|
|
21996
|
-
| <a id="property-pointerevents"></a> `pointerEvents?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `pointer-events` attribute per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`pointerEvents`](#property-pointerevents-2) | [shapes/shapeConfig.ts:
|
|
21997
|
-
| <a id="property-rendermode"></a> `renderMode?` | `"full"` \| `"compute"` | "full" runs the DOM enter/update/exit; "compute" skips DOM. | [`BaseShapeConfig`](#baseshapeconfig).[`renderMode`](#property-rendermode-2) | [shapes/shapeConfig.ts:
|
|
21998
|
-
| <a id="property-role"></a> `role?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA role per datum (accessibility). | [`BaseShapeConfig`](#baseshapeconfig).[`role`](#property-role-2) | [shapes/shapeConfig.ts:
|
|
21999
|
-
| <a id="property-rotate"></a> `rotate?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Rotation in degrees per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`rotate`](#property-rotate-2) | [shapes/shapeConfig.ts:
|
|
22000
|
-
| <a id="property-rx"></a> `rx?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `rx` (rect rounded-corner x) — applies to Rect/Bar. | [`BaseShapeConfig`](#baseshapeconfig).[`rx`](#property-rx-2) | [shapes/shapeConfig.ts:
|
|
22001
|
-
| <a id="property-ry"></a> `ry?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `ry` (rect rounded-corner y) — applies to Rect/Bar. | [`BaseShapeConfig`](#baseshapeconfig).[`ry`](#property-ry-2) | [shapes/shapeConfig.ts:
|
|
22002
|
-
| <a id="property-scale"></a> `scale?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Scale factor (1 = identity). | [`BaseShapeConfig`](#baseshapeconfig).[`scale`](#property-scale-3) | [shapes/shapeConfig.ts:
|
|
22003
|
-
| <a id="property-select"></a> `select?` | `string` \| `HTMLElement` \| `SVGElement` \| `null` | Where to mount the shape's DOM (CSS selector, element, or null). | [`BaseShapeConfig`](#baseshapeconfig).[`select`](#property-select-2) | [shapes/shapeConfig.ts:
|
|
22004
|
-
| <a id="property-shaperendering"></a> `shapeRendering?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `shape-rendering` attribute per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`shapeRendering`](#property-shaperendering-2) | [shapes/shapeConfig.ts:
|
|
22005
|
-
| <a id="property-sort"></a> `sort?` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | d3-style sort comparator. | [`BaseShapeConfig`](#baseshapeconfig).[`sort`](#property-sort-2) | [shapes/shapeConfig.ts:
|
|
22006
|
-
| <a id="property-stroke"></a> `stroke?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Stroke color. | [`BaseShapeConfig`](#baseshapeconfig).[`stroke`](#property-stroke-2) | [shapes/shapeConfig.ts:
|
|
22007
|
-
| <a id="property-strokedasharray"></a> `strokeDasharray?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-dasharray`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeDasharray`](#property-strokedasharray-2) | [shapes/shapeConfig.ts:
|
|
22008
|
-
| <a id="property-strokelinecap"></a> `strokeLinecap?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-linecap`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeLinecap`](#property-strokelinecap-2) | [shapes/shapeConfig.ts:
|
|
22009
|
-
| <a id="property-strokeopacity"></a> `strokeOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `stroke-opacity`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeOpacity`](#property-strokeopacity-2) | [shapes/shapeConfig.ts:
|
|
22010
|
-
| <a id="property-strokewidth"></a> `strokeWidth?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Stroke width in pixels. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeWidth`](#property-strokewidth-2) | [shapes/shapeConfig.ts:
|
|
22011
|
-
| <a id="property-textanchor"></a> `textAnchor?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `text-anchor` for labels. | [`BaseShapeConfig`](#baseshapeconfig).[`textAnchor`](#property-textanchor-2) | [shapes/shapeConfig.ts:
|
|
22012
|
-
| <a id="property-texture"></a> `texture?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `Record`\<`string`, `unknown`\>\> | Texture (per textures.js) — name string or full config. | [`BaseShapeConfig`](#baseshapeconfig).[`texture`](#property-texture-2) | [shapes/shapeConfig.ts:
|
|
22013
|
-
| <a id="property-texturedefault"></a> `textureDefault?` | `Record`\<`string`, `unknown`\> | Default texture config merged into the per-datum texture. | [`BaseShapeConfig`](#baseshapeconfig).[`textureDefault`](#property-texturedefault-2) | [shapes/shapeConfig.ts:
|
|
22014
|
-
| <a id="property-vectoreffect"></a> `vectorEffect?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `vector-effect` (e.g. "non-scaling-stroke"). | [`BaseShapeConfig`](#baseshapeconfig).[`vectorEffect`](#property-vectoreffect-2) | [shapes/shapeConfig.ts:
|
|
22015
|
-
| <a id="property-verticalalign"></a> `verticalAlign?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Label vertical-align ("top"/"middle"/"bottom"). | [`BaseShapeConfig`](#baseshapeconfig).[`verticalAlign`](#property-verticalalign-2) | [shapes/shapeConfig.ts:
|
|
22016
|
-
| <a id="property-x"></a> `x?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | X position. | [`BaseShapeConfig`](#baseshapeconfig).[`x`](#property-x-2) | [shapes/shapeConfig.ts:
|
|
22017
|
-
| <a id="property-x0"></a> `x0?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | - | [shapes/shapeConfig.ts:
|
|
22018
|
-
| <a id="property-x1"></a> `x1?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> \| `null` | - | - | [shapes/shapeConfig.ts:
|
|
22019
|
-
| <a id="property-y"></a> `y?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Y position. | [`BaseShapeConfig`](#baseshapeconfig).[`y`](#property-y-2) | [shapes/shapeConfig.ts:
|
|
22020
|
-
| <a id="property-y0"></a> `y0?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | - | [shapes/shapeConfig.ts:
|
|
22021
|
-
| <a id="property-y1"></a> `y1?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> \| `null` | - | - | [shapes/shapeConfig.ts:
|
|
22067
|
+
| <a id="property-defined"></a> `defined?` | (`d`: `DataPoint`) => `boolean` | Determines whether a data point is defined (a gap in the area when false). | - | [shapes/shapeConfig.ts:193](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L193) |
|
|
22068
|
+
| <a id="property-discrete"></a> `discrete?` | `"x"` \| `"y"` | Discrete-axis key ("x" | "y") for charts that flip layout per axis. | [`BaseShapeConfig`](#baseshapeconfig).[`discrete`](#property-discrete-2) | [shapes/shapeConfig.ts:71](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L71) |
|
|
22069
|
+
| <a id="property-duration"></a> `duration?` | `number` | Animation duration in ms. | [`BaseShapeConfig`](#baseshapeconfig).[`duration`](#property-duration-2) | [shapes/shapeConfig.ts:73](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L73) |
|
|
22070
|
+
| <a id="property-fill"></a> `fill?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Fill color or accessor returning one. | [`BaseShapeConfig`](#baseshapeconfig).[`fill`](#property-fill-2) | [shapes/shapeConfig.ts:76](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L76) |
|
|
22071
|
+
| <a id="property-fillopacity"></a> `fillOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Fill opacity (0..1). | [`BaseShapeConfig`](#baseshapeconfig).[`fillOpacity`](#property-fillopacity-2) | [shapes/shapeConfig.ts:78](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L78) |
|
|
22072
|
+
| <a id="property-hitarea"></a> `hitArea?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\>) | Hit-area shape: function returning bounds or static bounds. | [`BaseShapeConfig`](#baseshapeconfig).[`hitArea`](#property-hitarea-2) | [shapes/shapeConfig.ts:88](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L88) |
|
|
22073
|
+
| <a id="property-hover"></a> `hover?` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | Predicate or null marking which data points are currently hovered. | [`BaseShapeConfig`](#baseshapeconfig).[`hover`](#property-hover-2) | [shapes/shapeConfig.ts:81](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L81) |
|
|
22074
|
+
| <a id="property-hoveropacity"></a> `hoverOpacity?` | `number` | Opacity applied to non-hovered data points. | [`BaseShapeConfig`](#baseshapeconfig).[`hoverOpacity`](#property-hoveropacity-2) | [shapes/shapeConfig.ts:83](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L83) |
|
|
22075
|
+
| <a id="property-hoverstyle"></a> `hoverStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for hovered data points. | [`BaseShapeConfig`](#baseshapeconfig).[`hoverStyle`](#property-hoverstyle-2) | [shapes/shapeConfig.ts:85](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L85) |
|
|
22076
|
+
| <a id="property-id"></a> `id?` | `AccessorFn` | Unique-id accessor per datum (used for keyed enter/update/exit). | [`BaseShapeConfig`](#baseshapeconfig).[`id`](#property-id-2) | [shapes/shapeConfig.ts:93](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L93) |
|
|
22077
|
+
| <a id="property-label"></a> `label?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `false` \| `string`[]\> | Label text(s) per datum. False/undefined skips. | [`BaseShapeConfig`](#baseshapeconfig).[`label`](#property-label-3) | [shapes/shapeConfig.ts:95](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L95) |
|
|
22078
|
+
| <a id="property-labelbounds"></a> `labelBounds?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\> \| `Record`\<`string`, `unknown`\>[]) | Label-bounds accessor (where to mount the label). | [`BaseShapeConfig`](#baseshapeconfig).[`labelBounds`](#property-labelbounds-2) | [shapes/shapeConfig.ts:97](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L97) |
|
|
22079
|
+
| <a id="property-labelconfig"></a> `labelConfig?` | `Record`\<`string`, `unknown`\> | Label TextBox config (font, padding, etc.). | [`BaseShapeConfig`](#baseshapeconfig).[`labelConfig`](#property-labelconfig-2) | [shapes/shapeConfig.ts:101](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L101) |
|
|
22080
|
+
| <a id="property-on"></a> `on?` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | Event handlers (Object.<event, handler>). | [`BaseShapeConfig`](#baseshapeconfig).[`on`](#property-on-2) | [shapes/shapeConfig.ts:159](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L159) |
|
|
22081
|
+
| <a id="property-opacity"></a> `opacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Overall opacity (0..1). | [`BaseShapeConfig`](#baseshapeconfig).[`opacity`](#property-opacity-2) | [shapes/shapeConfig.ts:104](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L104) |
|
|
22082
|
+
| <a id="property-pointerevents"></a> `pointerEvents?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `pointer-events` attribute per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`pointerEvents`](#property-pointerevents-2) | [shapes/shapeConfig.ts:106](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L106) |
|
|
22083
|
+
| <a id="property-rendermode"></a> `renderMode?` | `"full"` \| `"compute"` | "full" runs the DOM enter/update/exit; "compute" skips DOM. | [`BaseShapeConfig`](#baseshapeconfig).[`renderMode`](#property-rendermode-2) | [shapes/shapeConfig.ts:120](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L120) |
|
|
22084
|
+
| <a id="property-role"></a> `role?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA role per datum (accessibility). | [`BaseShapeConfig`](#baseshapeconfig).[`role`](#property-role-2) | [shapes/shapeConfig.ts:108](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L108) |
|
|
22085
|
+
| <a id="property-rotate"></a> `rotate?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Rotation in degrees per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`rotate`](#property-rotate-2) | [shapes/shapeConfig.ts:111](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L111) |
|
|
22086
|
+
| <a id="property-rx"></a> `rx?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `rx` (rect rounded-corner x) — applies to Rect/Bar. | [`BaseShapeConfig`](#baseshapeconfig).[`rx`](#property-rx-2) | [shapes/shapeConfig.ts:113](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L113) |
|
|
22087
|
+
| <a id="property-ry"></a> `ry?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `ry` (rect rounded-corner y) — applies to Rect/Bar. | [`BaseShapeConfig`](#baseshapeconfig).[`ry`](#property-ry-2) | [shapes/shapeConfig.ts:115](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L115) |
|
|
22088
|
+
| <a id="property-scale"></a> `scale?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Scale factor (1 = identity). | [`BaseShapeConfig`](#baseshapeconfig).[`scale`](#property-scale-3) | [shapes/shapeConfig.ts:117](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L117) |
|
|
22089
|
+
| <a id="property-select"></a> `select?` | `string` \| `HTMLElement` \| `SVGElement` \| `null` | Where to mount the shape's DOM (CSS selector, element, or null). | [`BaseShapeConfig`](#baseshapeconfig).[`select`](#property-select-2) | [shapes/shapeConfig.ts:122](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L122) |
|
|
22090
|
+
| <a id="property-shaperendering"></a> `shapeRendering?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `shape-rendering` attribute per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`shapeRendering`](#property-shaperendering-2) | [shapes/shapeConfig.ts:125](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L125) |
|
|
22091
|
+
| <a id="property-sort"></a> `sort?` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | d3-style sort comparator. | [`BaseShapeConfig`](#baseshapeconfig).[`sort`](#property-sort-2) | [shapes/shapeConfig.ts:128](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L128) |
|
|
22092
|
+
| <a id="property-stroke"></a> `stroke?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Stroke color. | [`BaseShapeConfig`](#baseshapeconfig).[`stroke`](#property-stroke-2) | [shapes/shapeConfig.ts:131](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L131) |
|
|
22093
|
+
| <a id="property-strokedasharray"></a> `strokeDasharray?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-dasharray`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeDasharray`](#property-strokedasharray-2) | [shapes/shapeConfig.ts:133](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L133) |
|
|
22094
|
+
| <a id="property-strokelinecap"></a> `strokeLinecap?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-linecap`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeLinecap`](#property-strokelinecap-2) | [shapes/shapeConfig.ts:135](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L135) |
|
|
22095
|
+
| <a id="property-strokeopacity"></a> `strokeOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `stroke-opacity`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeOpacity`](#property-strokeopacity-2) | [shapes/shapeConfig.ts:137](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L137) |
|
|
22096
|
+
| <a id="property-strokewidth"></a> `strokeWidth?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Stroke width in pixels. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeWidth`](#property-strokewidth-2) | [shapes/shapeConfig.ts:139](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L139) |
|
|
22097
|
+
| <a id="property-textanchor"></a> `textAnchor?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `text-anchor` for labels. | [`BaseShapeConfig`](#baseshapeconfig).[`textAnchor`](#property-textanchor-2) | [shapes/shapeConfig.ts:142](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L142) |
|
|
22098
|
+
| <a id="property-texture"></a> `texture?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `Record`\<`string`, `unknown`\>\> | Texture (per textures.js) — name string or full config. | [`BaseShapeConfig`](#baseshapeconfig).[`texture`](#property-texture-2) | [shapes/shapeConfig.ts:144](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L144) |
|
|
22099
|
+
| <a id="property-texturedefault"></a> `textureDefault?` | `Record`\<`string`, `unknown`\> | Default texture config merged into the per-datum texture. | [`BaseShapeConfig`](#baseshapeconfig).[`textureDefault`](#property-texturedefault-2) | [shapes/shapeConfig.ts:146](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L146) |
|
|
22100
|
+
| <a id="property-vectoreffect"></a> `vectorEffect?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `vector-effect` (e.g. "non-scaling-stroke"). | [`BaseShapeConfig`](#baseshapeconfig).[`vectorEffect`](#property-vectoreffect-2) | [shapes/shapeConfig.ts:149](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L149) |
|
|
22101
|
+
| <a id="property-verticalalign"></a> `verticalAlign?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Label vertical-align ("top"/"middle"/"bottom"). | [`BaseShapeConfig`](#baseshapeconfig).[`verticalAlign`](#property-verticalalign-2) | [shapes/shapeConfig.ts:151](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L151) |
|
|
22102
|
+
| <a id="property-x"></a> `x?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | X position. | [`BaseShapeConfig`](#baseshapeconfig).[`x`](#property-x-2) | [shapes/shapeConfig.ts:154](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L154) |
|
|
22103
|
+
| <a id="property-x0"></a> `x0?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | - | [shapes/shapeConfig.ts:194](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L194) |
|
|
22104
|
+
| <a id="property-x1"></a> `x1?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> \| `null` | - | - | [shapes/shapeConfig.ts:195](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L195) |
|
|
22105
|
+
| <a id="property-y"></a> `y?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Y position. | [`BaseShapeConfig`](#baseshapeconfig).[`y`](#property-y-2) | [shapes/shapeConfig.ts:156](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L156) |
|
|
22106
|
+
| <a id="property-y0"></a> `y0?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | - | [shapes/shapeConfig.ts:196](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L196) |
|
|
22107
|
+
| <a id="property-y1"></a> `y1?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> \| `null` | - | - | [shapes/shapeConfig.ts:197](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L197) |
|
|
22022
22108
|
|
|
22023
22109
|
***
|
|
22024
22110
|
|
|
@@ -22055,7 +22141,7 @@ Defined in: [utils/D3plusConfig.ts:44](https://github.com/d3plus/d3plus/blob/mai
|
|
|
22055
22141
|
|
|
22056
22142
|
### BarConfig
|
|
22057
22143
|
|
|
22058
|
-
Defined in: [shapes/shapeConfig.ts:
|
|
22144
|
+
Defined in: [shapes/shapeConfig.ts:206](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L206)
|
|
22059
22145
|
|
|
22060
22146
|
Bar-specific config (Rect + start/end coords).
|
|
22061
22147
|
|
|
@@ -22076,51 +22162,52 @@ Bar-specific config (Rect + start/end coords).
|
|
|
22076
22162
|
| <a id="property-activestyle-1"></a> `activeStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for active data points. | [`RectConfig`](#rectconfig-3).[`activeStyle`](#property-activestyle-6) | [shapes/shapeConfig.ts:56](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L56) |
|
|
22077
22163
|
| <a id="property-arialabel-1"></a> `ariaLabel?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA label per datum (accessibility). | [`RectConfig`](#rectconfig-3).[`ariaLabel`](#property-arialabel-6) | [shapes/shapeConfig.ts:59](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L59) |
|
|
22078
22164
|
| <a id="property-backgroundimage-1"></a> `backgroundImage?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Optional background image per datum (url or accessor returning a url). | [`RectConfig`](#rectconfig-3).[`backgroundImage`](#property-backgroundimage-6) | [shapes/shapeConfig.ts:61](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L61) |
|
|
22165
|
+
| <a id="property-backgroundimagefit-1"></a> `backgroundImageFit?` | [`ConstOrAccessor`](#constoraccessor)\<`"cover"` \| `"contain"`\> | How a `backgroundImage` fits its shape: `"cover"` (default) fills the shape's bounding box, cropping the overflow and clipping to the outline; `"contain"` fits the whole image, centered and fully visible, inside the shape's largest inscribed rectangle. | [`RectConfig`](#rectconfig-3).[`backgroundImageFit`](#property-backgroundimagefit-6) | [shapes/shapeConfig.ts:68](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L68) |
|
|
22079
22166
|
| <a id="property-data-1"></a> `data?` | `DataPoint`[] | Data array driving the shape. | [`RectConfig`](#rectconfig-3).[`data`](#property-data-9) | [shapes/shapeConfig.ts:49](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L49) |
|
|
22080
|
-
| <a id="property-discrete-1"></a> `discrete?` | `"x"` \| `"y"` | Discrete-axis key ("x" | "y") for charts that flip layout per axis. | [`RectConfig`](#rectconfig-3).[`discrete`](#property-discrete-7) | [shapes/shapeConfig.ts:
|
|
22081
|
-
| <a id="property-duration-1"></a> `duration?` | `number` | Animation duration in ms. | [`RectConfig`](#rectconfig-3).[`duration`](#property-duration-8) | [shapes/shapeConfig.ts:
|
|
22082
|
-
| <a id="property-fill-1"></a> `fill?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Fill color or accessor returning one. | [`RectConfig`](#rectconfig-3).[`fill`](#property-fill-6) | [shapes/shapeConfig.ts:
|
|
22083
|
-
| <a id="property-fillopacity-1"></a> `fillOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Fill opacity (0..1). | [`RectConfig`](#rectconfig-3).[`fillOpacity`](#property-fillopacity-6) | [shapes/shapeConfig.ts:
|
|
22084
|
-
| <a id="property-height"></a> `height?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [`RectConfig`](#rectconfig-3).[`height`](#property-height-3) | [shapes/shapeConfig.ts:
|
|
22085
|
-
| <a id="property-hitarea-1"></a> `hitArea?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\>) | Hit-area shape: function returning bounds or static bounds. | [`RectConfig`](#rectconfig-3).[`hitArea`](#property-hitarea-6) | [shapes/shapeConfig.ts:
|
|
22086
|
-
| <a id="property-hover-1"></a> `hover?` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | Predicate or null marking which data points are currently hovered. | [`RectConfig`](#rectconfig-3).[`hover`](#property-hover-8) | [shapes/shapeConfig.ts:
|
|
22087
|
-
| <a id="property-hoveropacity-1"></a> `hoverOpacity?` | `number` | Opacity applied to non-hovered data points. | [`RectConfig`](#rectconfig-3).[`hoverOpacity`](#property-hoveropacity-6) | [shapes/shapeConfig.ts:
|
|
22088
|
-
| <a id="property-hoverstyle-1"></a> `hoverStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for hovered data points. | [`RectConfig`](#rectconfig-3).[`hoverStyle`](#property-hoverstyle-6) | [shapes/shapeConfig.ts:
|
|
22089
|
-
| <a id="property-id-1"></a> `id?` | `AccessorFn` | Unique-id accessor per datum (used for keyed enter/update/exit). | [`RectConfig`](#rectconfig-3).[`id`](#property-id-7) | [shapes/shapeConfig.ts:
|
|
22090
|
-
| <a id="property-label-2"></a> `label?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `false` \| `string`[]\> | Label text(s) per datum. False/undefined skips. | [`RectConfig`](#rectconfig-3).[`label`](#property-label-8) | [shapes/shapeConfig.ts:
|
|
22091
|
-
| <a id="property-labelbounds-1"></a> `labelBounds?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\> \| `Record`\<`string`, `unknown`\>[]) | Label-bounds accessor (where to mount the label). | [`RectConfig`](#rectconfig-3).[`labelBounds`](#property-labelbounds-6) | [shapes/shapeConfig.ts:
|
|
22092
|
-
| <a id="property-labelconfig-1"></a> `labelConfig?` | `Record`\<`string`, `unknown`\> | Label TextBox config (font, padding, etc.). | [`RectConfig`](#rectconfig-3).[`labelConfig`](#property-labelconfig-6) | [shapes/shapeConfig.ts:
|
|
22093
|
-
| <a id="property-on-1"></a> `on?` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | Event handlers (Object.<event, handler>). | [`RectConfig`](#rectconfig-3).[`on`](#property-on-7) | [shapes/shapeConfig.ts:
|
|
22094
|
-
| <a id="property-opacity-1"></a> `opacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Overall opacity (0..1). | [`RectConfig`](#rectconfig-3).[`opacity`](#property-opacity-7) | [shapes/shapeConfig.ts:
|
|
22095
|
-
| <a id="property-pointerevents-1"></a> `pointerEvents?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `pointer-events` attribute per datum. | [`RectConfig`](#rectconfig-3).[`pointerEvents`](#property-pointerevents-7) | [shapes/shapeConfig.ts:
|
|
22096
|
-
| <a id="property-rendermode-1"></a> `renderMode?` | `"full"` \| `"compute"` | "full" runs the DOM enter/update/exit; "compute" skips DOM. | [`RectConfig`](#rectconfig-3).[`renderMode`](#property-rendermode-6) | [shapes/shapeConfig.ts:
|
|
22097
|
-
| <a id="property-role-1"></a> `role?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA role per datum (accessibility). | [`RectConfig`](#rectconfig-3).[`role`](#property-role-6) | [shapes/shapeConfig.ts:
|
|
22098
|
-
| <a id="property-rotate-1"></a> `rotate?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Rotation in degrees per datum. | [`RectConfig`](#rectconfig-3).[`rotate`](#property-rotate-6) | [shapes/shapeConfig.ts:
|
|
22099
|
-
| <a id="property-rx-1"></a> `rx?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `rx` (rect rounded-corner x) — applies to Rect/Bar. | [`RectConfig`](#rectconfig-3).[`rx`](#property-rx-6) | [shapes/shapeConfig.ts:
|
|
22100
|
-
| <a id="property-ry-1"></a> `ry?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `ry` (rect rounded-corner y) — applies to Rect/Bar. | [`RectConfig`](#rectconfig-3).[`ry`](#property-ry-6) | [shapes/shapeConfig.ts:
|
|
22101
|
-
| <a id="property-scale-2"></a> `scale?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Scale factor (1 = identity). | [`RectConfig`](#rectconfig-3).[`scale`](#property-scale-7) | [shapes/shapeConfig.ts:
|
|
22102
|
-
| <a id="property-select-1"></a> `select?` | `string` \| `HTMLElement` \| `SVGElement` \| `null` | Where to mount the shape's DOM (CSS selector, element, or null). | [`RectConfig`](#rectconfig-3).[`select`](#property-select-8) | [shapes/shapeConfig.ts:
|
|
22103
|
-
| <a id="property-shaperendering-1"></a> `shapeRendering?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `shape-rendering` attribute per datum. | [`RectConfig`](#rectconfig-3).[`shapeRendering`](#property-shaperendering-6) | [shapes/shapeConfig.ts:
|
|
22104
|
-
| <a id="property-sort-1"></a> `sort?` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | d3-style sort comparator. | [`RectConfig`](#rectconfig-3).[`sort`](#property-sort-6) | [shapes/shapeConfig.ts:
|
|
22105
|
-
| <a id="property-stroke-1"></a> `stroke?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Stroke color. | [`RectConfig`](#rectconfig-3).[`stroke`](#property-stroke-6) | [shapes/shapeConfig.ts:
|
|
22106
|
-
| <a id="property-strokedasharray-1"></a> `strokeDasharray?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-dasharray`. | [`RectConfig`](#rectconfig-3).[`strokeDasharray`](#property-strokedasharray-6) | [shapes/shapeConfig.ts:
|
|
22107
|
-
| <a id="property-strokelinecap-1"></a> `strokeLinecap?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-linecap`. | [`RectConfig`](#rectconfig-3).[`strokeLinecap`](#property-strokelinecap-6) | [shapes/shapeConfig.ts:
|
|
22108
|
-
| <a id="property-strokeopacity-1"></a> `strokeOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `stroke-opacity`. | [`RectConfig`](#rectconfig-3).[`strokeOpacity`](#property-strokeopacity-6) | [shapes/shapeConfig.ts:
|
|
22109
|
-
| <a id="property-strokewidth-1"></a> `strokeWidth?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Stroke width in pixels. | [`RectConfig`](#rectconfig-3).[`strokeWidth`](#property-strokewidth-6) | [shapes/shapeConfig.ts:
|
|
22110
|
-
| <a id="property-textanchor-1"></a> `textAnchor?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `text-anchor` for labels. | [`RectConfig`](#rectconfig-3).[`textAnchor`](#property-textanchor-6) | [shapes/shapeConfig.ts:
|
|
22111
|
-
| <a id="property-texture-1"></a> `texture?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `Record`\<`string`, `unknown`\>\> | Texture (per textures.js) — name string or full config. | [`RectConfig`](#rectconfig-3).[`texture`](#property-texture-6) | [shapes/shapeConfig.ts:
|
|
22112
|
-
| <a id="property-texturedefault-1"></a> `textureDefault?` | `Record`\<`string`, `unknown`\> | Default texture config merged into the per-datum texture. | [`RectConfig`](#rectconfig-3).[`textureDefault`](#property-texturedefault-6) | [shapes/shapeConfig.ts:
|
|
22113
|
-
| <a id="property-trail"></a> `trail?` | `boolean` | Sweep a tapering motion trail behind the rect as it moves between frames. | [`RectConfig`](#rectconfig-3).[`trail`](#property-trail-2) | [shapes/shapeConfig.ts:
|
|
22114
|
-
| <a id="property-trailpersist"></a> `trailPersist?` | `number` \| `boolean` | Steps of trail history to keep (number), or `true` for a long fading tail. | [`RectConfig`](#rectconfig-3).[`trailPersist`](#property-trailpersist-2) | [shapes/shapeConfig.ts:
|
|
22115
|
-
| <a id="property-vectoreffect-1"></a> `vectorEffect?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `vector-effect` (e.g. "non-scaling-stroke"). | [`RectConfig`](#rectconfig-3).[`vectorEffect`](#property-vectoreffect-6) | [shapes/shapeConfig.ts:
|
|
22116
|
-
| <a id="property-verticalalign-1"></a> `verticalAlign?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Label vertical-align ("top"/"middle"/"bottom"). | [`RectConfig`](#rectconfig-3).[`verticalAlign`](#property-verticalalign-6) | [shapes/shapeConfig.ts:
|
|
22117
|
-
| <a id="property-width"></a> `width?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [`RectConfig`](#rectconfig-3).[`width`](#property-width-3) | [shapes/shapeConfig.ts:
|
|
22118
|
-
| <a id="property-x-1"></a> `x?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | X position. | [`RectConfig`](#rectconfig-3).[`x`](#property-x-9) | [shapes/shapeConfig.ts:
|
|
22119
|
-
| <a id="property-x0-1"></a> `x0?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | - | [shapes/shapeConfig.ts:
|
|
22120
|
-
| <a id="property-x1-1"></a> `x1?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> \| `null` | - | - | [shapes/shapeConfig.ts:
|
|
22121
|
-
| <a id="property-y-1"></a> `y?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Y position. | [`RectConfig`](#rectconfig-3).[`y`](#property-y-9) | [shapes/shapeConfig.ts:
|
|
22122
|
-
| <a id="property-y0-1"></a> `y0?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | - | [shapes/shapeConfig.ts:
|
|
22123
|
-
| <a id="property-y1-1"></a> `y1?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> \| `null` | - | - | [shapes/shapeConfig.ts:
|
|
22167
|
+
| <a id="property-discrete-1"></a> `discrete?` | `"x"` \| `"y"` | Discrete-axis key ("x" | "y") for charts that flip layout per axis. | [`RectConfig`](#rectconfig-3).[`discrete`](#property-discrete-7) | [shapes/shapeConfig.ts:71](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L71) |
|
|
22168
|
+
| <a id="property-duration-1"></a> `duration?` | `number` | Animation duration in ms. | [`RectConfig`](#rectconfig-3).[`duration`](#property-duration-8) | [shapes/shapeConfig.ts:73](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L73) |
|
|
22169
|
+
| <a id="property-fill-1"></a> `fill?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Fill color or accessor returning one. | [`RectConfig`](#rectconfig-3).[`fill`](#property-fill-6) | [shapes/shapeConfig.ts:76](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L76) |
|
|
22170
|
+
| <a id="property-fillopacity-1"></a> `fillOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Fill opacity (0..1). | [`RectConfig`](#rectconfig-3).[`fillOpacity`](#property-fillopacity-6) | [shapes/shapeConfig.ts:78](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L78) |
|
|
22171
|
+
| <a id="property-height"></a> `height?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [`RectConfig`](#rectconfig-3).[`height`](#property-height-3) | [shapes/shapeConfig.ts:167](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L167) |
|
|
22172
|
+
| <a id="property-hitarea-1"></a> `hitArea?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\>) | Hit-area shape: function returning bounds or static bounds. | [`RectConfig`](#rectconfig-3).[`hitArea`](#property-hitarea-6) | [shapes/shapeConfig.ts:88](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L88) |
|
|
22173
|
+
| <a id="property-hover-1"></a> `hover?` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | Predicate or null marking which data points are currently hovered. | [`RectConfig`](#rectconfig-3).[`hover`](#property-hover-8) | [shapes/shapeConfig.ts:81](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L81) |
|
|
22174
|
+
| <a id="property-hoveropacity-1"></a> `hoverOpacity?` | `number` | Opacity applied to non-hovered data points. | [`RectConfig`](#rectconfig-3).[`hoverOpacity`](#property-hoveropacity-6) | [shapes/shapeConfig.ts:83](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L83) |
|
|
22175
|
+
| <a id="property-hoverstyle-1"></a> `hoverStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for hovered data points. | [`RectConfig`](#rectconfig-3).[`hoverStyle`](#property-hoverstyle-6) | [shapes/shapeConfig.ts:85](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L85) |
|
|
22176
|
+
| <a id="property-id-1"></a> `id?` | `AccessorFn` | Unique-id accessor per datum (used for keyed enter/update/exit). | [`RectConfig`](#rectconfig-3).[`id`](#property-id-7) | [shapes/shapeConfig.ts:93](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L93) |
|
|
22177
|
+
| <a id="property-label-2"></a> `label?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `false` \| `string`[]\> | Label text(s) per datum. False/undefined skips. | [`RectConfig`](#rectconfig-3).[`label`](#property-label-8) | [shapes/shapeConfig.ts:95](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L95) |
|
|
22178
|
+
| <a id="property-labelbounds-1"></a> `labelBounds?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\> \| `Record`\<`string`, `unknown`\>[]) | Label-bounds accessor (where to mount the label). | [`RectConfig`](#rectconfig-3).[`labelBounds`](#property-labelbounds-6) | [shapes/shapeConfig.ts:97](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L97) |
|
|
22179
|
+
| <a id="property-labelconfig-1"></a> `labelConfig?` | `Record`\<`string`, `unknown`\> | Label TextBox config (font, padding, etc.). | [`RectConfig`](#rectconfig-3).[`labelConfig`](#property-labelconfig-6) | [shapes/shapeConfig.ts:101](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L101) |
|
|
22180
|
+
| <a id="property-on-1"></a> `on?` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | Event handlers (Object.<event, handler>). | [`RectConfig`](#rectconfig-3).[`on`](#property-on-7) | [shapes/shapeConfig.ts:159](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L159) |
|
|
22181
|
+
| <a id="property-opacity-1"></a> `opacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Overall opacity (0..1). | [`RectConfig`](#rectconfig-3).[`opacity`](#property-opacity-7) | [shapes/shapeConfig.ts:104](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L104) |
|
|
22182
|
+
| <a id="property-pointerevents-1"></a> `pointerEvents?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `pointer-events` attribute per datum. | [`RectConfig`](#rectconfig-3).[`pointerEvents`](#property-pointerevents-7) | [shapes/shapeConfig.ts:106](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L106) |
|
|
22183
|
+
| <a id="property-rendermode-1"></a> `renderMode?` | `"full"` \| `"compute"` | "full" runs the DOM enter/update/exit; "compute" skips DOM. | [`RectConfig`](#rectconfig-3).[`renderMode`](#property-rendermode-6) | [shapes/shapeConfig.ts:120](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L120) |
|
|
22184
|
+
| <a id="property-role-1"></a> `role?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA role per datum (accessibility). | [`RectConfig`](#rectconfig-3).[`role`](#property-role-6) | [shapes/shapeConfig.ts:108](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L108) |
|
|
22185
|
+
| <a id="property-rotate-1"></a> `rotate?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Rotation in degrees per datum. | [`RectConfig`](#rectconfig-3).[`rotate`](#property-rotate-6) | [shapes/shapeConfig.ts:111](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L111) |
|
|
22186
|
+
| <a id="property-rx-1"></a> `rx?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `rx` (rect rounded-corner x) — applies to Rect/Bar. | [`RectConfig`](#rectconfig-3).[`rx`](#property-rx-6) | [shapes/shapeConfig.ts:113](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L113) |
|
|
22187
|
+
| <a id="property-ry-1"></a> `ry?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `ry` (rect rounded-corner y) — applies to Rect/Bar. | [`RectConfig`](#rectconfig-3).[`ry`](#property-ry-6) | [shapes/shapeConfig.ts:115](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L115) |
|
|
22188
|
+
| <a id="property-scale-2"></a> `scale?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Scale factor (1 = identity). | [`RectConfig`](#rectconfig-3).[`scale`](#property-scale-7) | [shapes/shapeConfig.ts:117](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L117) |
|
|
22189
|
+
| <a id="property-select-1"></a> `select?` | `string` \| `HTMLElement` \| `SVGElement` \| `null` | Where to mount the shape's DOM (CSS selector, element, or null). | [`RectConfig`](#rectconfig-3).[`select`](#property-select-8) | [shapes/shapeConfig.ts:122](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L122) |
|
|
22190
|
+
| <a id="property-shaperendering-1"></a> `shapeRendering?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `shape-rendering` attribute per datum. | [`RectConfig`](#rectconfig-3).[`shapeRendering`](#property-shaperendering-6) | [shapes/shapeConfig.ts:125](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L125) |
|
|
22191
|
+
| <a id="property-sort-1"></a> `sort?` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | d3-style sort comparator. | [`RectConfig`](#rectconfig-3).[`sort`](#property-sort-6) | [shapes/shapeConfig.ts:128](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L128) |
|
|
22192
|
+
| <a id="property-stroke-1"></a> `stroke?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Stroke color. | [`RectConfig`](#rectconfig-3).[`stroke`](#property-stroke-6) | [shapes/shapeConfig.ts:131](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L131) |
|
|
22193
|
+
| <a id="property-strokedasharray-1"></a> `strokeDasharray?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-dasharray`. | [`RectConfig`](#rectconfig-3).[`strokeDasharray`](#property-strokedasharray-6) | [shapes/shapeConfig.ts:133](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L133) |
|
|
22194
|
+
| <a id="property-strokelinecap-1"></a> `strokeLinecap?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-linecap`. | [`RectConfig`](#rectconfig-3).[`strokeLinecap`](#property-strokelinecap-6) | [shapes/shapeConfig.ts:135](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L135) |
|
|
22195
|
+
| <a id="property-strokeopacity-1"></a> `strokeOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `stroke-opacity`. | [`RectConfig`](#rectconfig-3).[`strokeOpacity`](#property-strokeopacity-6) | [shapes/shapeConfig.ts:137](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L137) |
|
|
22196
|
+
| <a id="property-strokewidth-1"></a> `strokeWidth?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Stroke width in pixels. | [`RectConfig`](#rectconfig-3).[`strokeWidth`](#property-strokewidth-6) | [shapes/shapeConfig.ts:139](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L139) |
|
|
22197
|
+
| <a id="property-textanchor-1"></a> `textAnchor?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `text-anchor` for labels. | [`RectConfig`](#rectconfig-3).[`textAnchor`](#property-textanchor-6) | [shapes/shapeConfig.ts:142](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L142) |
|
|
22198
|
+
| <a id="property-texture-1"></a> `texture?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `Record`\<`string`, `unknown`\>\> | Texture (per textures.js) — name string or full config. | [`RectConfig`](#rectconfig-3).[`texture`](#property-texture-6) | [shapes/shapeConfig.ts:144](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L144) |
|
|
22199
|
+
| <a id="property-texturedefault-1"></a> `textureDefault?` | `Record`\<`string`, `unknown`\> | Default texture config merged into the per-datum texture. | [`RectConfig`](#rectconfig-3).[`textureDefault`](#property-texturedefault-6) | [shapes/shapeConfig.ts:146](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L146) |
|
|
22200
|
+
| <a id="property-trail"></a> `trail?` | `boolean` | Sweep a tapering motion trail behind the rect as it moves between frames. | [`RectConfig`](#rectconfig-3).[`trail`](#property-trail-2) | [shapes/shapeConfig.ts:169](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L169) |
|
|
22201
|
+
| <a id="property-trailpersist"></a> `trailPersist?` | `number` \| `boolean` | Steps of trail history to keep (number), or `true` for a long fading tail. | [`RectConfig`](#rectconfig-3).[`trailPersist`](#property-trailpersist-2) | [shapes/shapeConfig.ts:171](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L171) |
|
|
22202
|
+
| <a id="property-vectoreffect-1"></a> `vectorEffect?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `vector-effect` (e.g. "non-scaling-stroke"). | [`RectConfig`](#rectconfig-3).[`vectorEffect`](#property-vectoreffect-6) | [shapes/shapeConfig.ts:149](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L149) |
|
|
22203
|
+
| <a id="property-verticalalign-1"></a> `verticalAlign?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Label vertical-align ("top"/"middle"/"bottom"). | [`RectConfig`](#rectconfig-3).[`verticalAlign`](#property-verticalalign-6) | [shapes/shapeConfig.ts:151](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L151) |
|
|
22204
|
+
| <a id="property-width"></a> `width?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [`RectConfig`](#rectconfig-3).[`width`](#property-width-3) | [shapes/shapeConfig.ts:166](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L166) |
|
|
22205
|
+
| <a id="property-x-1"></a> `x?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | X position. | [`RectConfig`](#rectconfig-3).[`x`](#property-x-9) | [shapes/shapeConfig.ts:154](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L154) |
|
|
22206
|
+
| <a id="property-x0-1"></a> `x0?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | - | [shapes/shapeConfig.ts:207](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L207) |
|
|
22207
|
+
| <a id="property-x1-1"></a> `x1?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> \| `null` | - | - | [shapes/shapeConfig.ts:208](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L208) |
|
|
22208
|
+
| <a id="property-y-1"></a> `y?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Y position. | [`RectConfig`](#rectconfig-3).[`y`](#property-y-9) | [shapes/shapeConfig.ts:156](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L156) |
|
|
22209
|
+
| <a id="property-y0-1"></a> `y0?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | - | [shapes/shapeConfig.ts:209](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L209) |
|
|
22210
|
+
| <a id="property-y1-1"></a> `y1?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> \| `null` | - | - | [shapes/shapeConfig.ts:210](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L210) |
|
|
22124
22211
|
|
|
22125
22212
|
***
|
|
22126
22213
|
|
|
@@ -22154,43 +22241,44 @@ these via `.config(...)` regardless of geometry.
|
|
|
22154
22241
|
| <a id="property-activestyle-2"></a> `activeStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for active data points. | [shapes/shapeConfig.ts:56](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L56) |
|
|
22155
22242
|
| <a id="property-arialabel-2"></a> `ariaLabel?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA label per datum (accessibility). | [shapes/shapeConfig.ts:59](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L59) |
|
|
22156
22243
|
| <a id="property-backgroundimage-2"></a> `backgroundImage?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Optional background image per datum (url or accessor returning a url). | [shapes/shapeConfig.ts:61](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L61) |
|
|
22244
|
+
| <a id="property-backgroundimagefit-2"></a> `backgroundImageFit?` | [`ConstOrAccessor`](#constoraccessor)\<`"cover"` \| `"contain"`\> | How a `backgroundImage` fits its shape: `"cover"` (default) fills the shape's bounding box, cropping the overflow and clipping to the outline; `"contain"` fits the whole image, centered and fully visible, inside the shape's largest inscribed rectangle. | [shapes/shapeConfig.ts:68](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L68) |
|
|
22157
22245
|
| <a id="property-data-2"></a> `data?` | `DataPoint`[] | Data array driving the shape. | [shapes/shapeConfig.ts:49](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L49) |
|
|
22158
|
-
| <a id="property-discrete-2"></a> `discrete?` | `"x"` \| `"y"` | Discrete-axis key ("x" | "y") for charts that flip layout per axis. | [shapes/shapeConfig.ts:
|
|
22159
|
-
| <a id="property-duration-2"></a> `duration?` | `number` | Animation duration in ms. | [shapes/shapeConfig.ts:
|
|
22160
|
-
| <a id="property-fill-2"></a> `fill?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Fill color or accessor returning one. | [shapes/shapeConfig.ts:
|
|
22161
|
-
| <a id="property-fillopacity-2"></a> `fillOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Fill opacity (0..1). | [shapes/shapeConfig.ts:
|
|
22162
|
-
| <a id="property-hitarea-2"></a> `hitArea?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\>) | Hit-area shape: function returning bounds or static bounds. | [shapes/shapeConfig.ts:
|
|
22163
|
-
| <a id="property-hover-2"></a> `hover?` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | Predicate or null marking which data points are currently hovered. | [shapes/shapeConfig.ts:
|
|
22164
|
-
| <a id="property-hoveropacity-2"></a> `hoverOpacity?` | `number` | Opacity applied to non-hovered data points. | [shapes/shapeConfig.ts:
|
|
22165
|
-
| <a id="property-hoverstyle-2"></a> `hoverStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for hovered data points. | [shapes/shapeConfig.ts:
|
|
22166
|
-
| <a id="property-id-2"></a> `id?` | `AccessorFn` | Unique-id accessor per datum (used for keyed enter/update/exit). | [shapes/shapeConfig.ts:
|
|
22167
|
-
| <a id="property-label-3"></a> `label?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `false` \| `string`[]\> | Label text(s) per datum. False/undefined skips. | [shapes/shapeConfig.ts:
|
|
22168
|
-
| <a id="property-labelbounds-2"></a> `labelBounds?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\> \| `Record`\<`string`, `unknown`\>[]) | Label-bounds accessor (where to mount the label). | [shapes/shapeConfig.ts:
|
|
22169
|
-
| <a id="property-labelconfig-2"></a> `labelConfig?` | `Record`\<`string`, `unknown`\> | Label TextBox config (font, padding, etc.). | [shapes/shapeConfig.ts:
|
|
22170
|
-
| <a id="property-on-2"></a> `on?` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | Event handlers (Object.<event, handler>). | [shapes/shapeConfig.ts:
|
|
22171
|
-
| <a id="property-opacity-2"></a> `opacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Overall opacity (0..1). | [shapes/shapeConfig.ts:
|
|
22172
|
-
| <a id="property-pointerevents-2"></a> `pointerEvents?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `pointer-events` attribute per datum. | [shapes/shapeConfig.ts:
|
|
22173
|
-
| <a id="property-rendermode-2"></a> `renderMode?` | `"full"` \| `"compute"` | "full" runs the DOM enter/update/exit; "compute" skips DOM. | [shapes/shapeConfig.ts:
|
|
22174
|
-
| <a id="property-role-2"></a> `role?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA role per datum (accessibility). | [shapes/shapeConfig.ts:
|
|
22175
|
-
| <a id="property-rotate-2"></a> `rotate?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Rotation in degrees per datum. | [shapes/shapeConfig.ts:
|
|
22176
|
-
| <a id="property-rx-2"></a> `rx?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `rx` (rect rounded-corner x) — applies to Rect/Bar. | [shapes/shapeConfig.ts:
|
|
22177
|
-
| <a id="property-ry-2"></a> `ry?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `ry` (rect rounded-corner y) — applies to Rect/Bar. | [shapes/shapeConfig.ts:
|
|
22178
|
-
| <a id="property-scale-3"></a> `scale?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Scale factor (1 = identity). | [shapes/shapeConfig.ts:
|
|
22179
|
-
| <a id="property-select-2"></a> `select?` | `string` \| `HTMLElement` \| `SVGElement` \| `null` | Where to mount the shape's DOM (CSS selector, element, or null). | [shapes/shapeConfig.ts:
|
|
22180
|
-
| <a id="property-shaperendering-2"></a> `shapeRendering?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `shape-rendering` attribute per datum. | [shapes/shapeConfig.ts:
|
|
22181
|
-
| <a id="property-sort-2"></a> `sort?` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | d3-style sort comparator. | [shapes/shapeConfig.ts:
|
|
22182
|
-
| <a id="property-stroke-2"></a> `stroke?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Stroke color. | [shapes/shapeConfig.ts:
|
|
22183
|
-
| <a id="property-strokedasharray-2"></a> `strokeDasharray?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-dasharray`. | [shapes/shapeConfig.ts:
|
|
22184
|
-
| <a id="property-strokelinecap-2"></a> `strokeLinecap?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-linecap`. | [shapes/shapeConfig.ts:
|
|
22185
|
-
| <a id="property-strokeopacity-2"></a> `strokeOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `stroke-opacity`. | [shapes/shapeConfig.ts:
|
|
22186
|
-
| <a id="property-strokewidth-2"></a> `strokeWidth?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Stroke width in pixels. | [shapes/shapeConfig.ts:
|
|
22187
|
-
| <a id="property-textanchor-2"></a> `textAnchor?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `text-anchor` for labels. | [shapes/shapeConfig.ts:
|
|
22188
|
-
| <a id="property-texture-2"></a> `texture?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `Record`\<`string`, `unknown`\>\> | Texture (per textures.js) — name string or full config. | [shapes/shapeConfig.ts:
|
|
22189
|
-
| <a id="property-texturedefault-2"></a> `textureDefault?` | `Record`\<`string`, `unknown`\> | Default texture config merged into the per-datum texture. | [shapes/shapeConfig.ts:
|
|
22190
|
-
| <a id="property-vectoreffect-2"></a> `vectorEffect?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `vector-effect` (e.g. "non-scaling-stroke"). | [shapes/shapeConfig.ts:
|
|
22191
|
-
| <a id="property-verticalalign-2"></a> `verticalAlign?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Label vertical-align ("top"/"middle"/"bottom"). | [shapes/shapeConfig.ts:
|
|
22192
|
-
| <a id="property-x-2"></a> `x?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | X position. | [shapes/shapeConfig.ts:
|
|
22193
|
-
| <a id="property-y-2"></a> `y?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Y position. | [shapes/shapeConfig.ts:
|
|
22246
|
+
| <a id="property-discrete-2"></a> `discrete?` | `"x"` \| `"y"` | Discrete-axis key ("x" | "y") for charts that flip layout per axis. | [shapes/shapeConfig.ts:71](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L71) |
|
|
22247
|
+
| <a id="property-duration-2"></a> `duration?` | `number` | Animation duration in ms. | [shapes/shapeConfig.ts:73](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L73) |
|
|
22248
|
+
| <a id="property-fill-2"></a> `fill?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Fill color or accessor returning one. | [shapes/shapeConfig.ts:76](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L76) |
|
|
22249
|
+
| <a id="property-fillopacity-2"></a> `fillOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Fill opacity (0..1). | [shapes/shapeConfig.ts:78](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L78) |
|
|
22250
|
+
| <a id="property-hitarea-2"></a> `hitArea?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\>) | Hit-area shape: function returning bounds or static bounds. | [shapes/shapeConfig.ts:88](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L88) |
|
|
22251
|
+
| <a id="property-hover-2"></a> `hover?` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | Predicate or null marking which data points are currently hovered. | [shapes/shapeConfig.ts:81](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L81) |
|
|
22252
|
+
| <a id="property-hoveropacity-2"></a> `hoverOpacity?` | `number` | Opacity applied to non-hovered data points. | [shapes/shapeConfig.ts:83](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L83) |
|
|
22253
|
+
| <a id="property-hoverstyle-2"></a> `hoverStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for hovered data points. | [shapes/shapeConfig.ts:85](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L85) |
|
|
22254
|
+
| <a id="property-id-2"></a> `id?` | `AccessorFn` | Unique-id accessor per datum (used for keyed enter/update/exit). | [shapes/shapeConfig.ts:93](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L93) |
|
|
22255
|
+
| <a id="property-label-3"></a> `label?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `false` \| `string`[]\> | Label text(s) per datum. False/undefined skips. | [shapes/shapeConfig.ts:95](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L95) |
|
|
22256
|
+
| <a id="property-labelbounds-2"></a> `labelBounds?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\> \| `Record`\<`string`, `unknown`\>[]) | Label-bounds accessor (where to mount the label). | [shapes/shapeConfig.ts:97](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L97) |
|
|
22257
|
+
| <a id="property-labelconfig-2"></a> `labelConfig?` | `Record`\<`string`, `unknown`\> | Label TextBox config (font, padding, etc.). | [shapes/shapeConfig.ts:101](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L101) |
|
|
22258
|
+
| <a id="property-on-2"></a> `on?` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | Event handlers (Object.<event, handler>). | [shapes/shapeConfig.ts:159](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L159) |
|
|
22259
|
+
| <a id="property-opacity-2"></a> `opacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Overall opacity (0..1). | [shapes/shapeConfig.ts:104](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L104) |
|
|
22260
|
+
| <a id="property-pointerevents-2"></a> `pointerEvents?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `pointer-events` attribute per datum. | [shapes/shapeConfig.ts:106](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L106) |
|
|
22261
|
+
| <a id="property-rendermode-2"></a> `renderMode?` | `"full"` \| `"compute"` | "full" runs the DOM enter/update/exit; "compute" skips DOM. | [shapes/shapeConfig.ts:120](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L120) |
|
|
22262
|
+
| <a id="property-role-2"></a> `role?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA role per datum (accessibility). | [shapes/shapeConfig.ts:108](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L108) |
|
|
22263
|
+
| <a id="property-rotate-2"></a> `rotate?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Rotation in degrees per datum. | [shapes/shapeConfig.ts:111](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L111) |
|
|
22264
|
+
| <a id="property-rx-2"></a> `rx?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `rx` (rect rounded-corner x) — applies to Rect/Bar. | [shapes/shapeConfig.ts:113](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L113) |
|
|
22265
|
+
| <a id="property-ry-2"></a> `ry?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `ry` (rect rounded-corner y) — applies to Rect/Bar. | [shapes/shapeConfig.ts:115](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L115) |
|
|
22266
|
+
| <a id="property-scale-3"></a> `scale?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Scale factor (1 = identity). | [shapes/shapeConfig.ts:117](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L117) |
|
|
22267
|
+
| <a id="property-select-2"></a> `select?` | `string` \| `HTMLElement` \| `SVGElement` \| `null` | Where to mount the shape's DOM (CSS selector, element, or null). | [shapes/shapeConfig.ts:122](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L122) |
|
|
22268
|
+
| <a id="property-shaperendering-2"></a> `shapeRendering?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `shape-rendering` attribute per datum. | [shapes/shapeConfig.ts:125](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L125) |
|
|
22269
|
+
| <a id="property-sort-2"></a> `sort?` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | d3-style sort comparator. | [shapes/shapeConfig.ts:128](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L128) |
|
|
22270
|
+
| <a id="property-stroke-2"></a> `stroke?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Stroke color. | [shapes/shapeConfig.ts:131](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L131) |
|
|
22271
|
+
| <a id="property-strokedasharray-2"></a> `strokeDasharray?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-dasharray`. | [shapes/shapeConfig.ts:133](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L133) |
|
|
22272
|
+
| <a id="property-strokelinecap-2"></a> `strokeLinecap?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-linecap`. | [shapes/shapeConfig.ts:135](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L135) |
|
|
22273
|
+
| <a id="property-strokeopacity-2"></a> `strokeOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `stroke-opacity`. | [shapes/shapeConfig.ts:137](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L137) |
|
|
22274
|
+
| <a id="property-strokewidth-2"></a> `strokeWidth?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Stroke width in pixels. | [shapes/shapeConfig.ts:139](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L139) |
|
|
22275
|
+
| <a id="property-textanchor-2"></a> `textAnchor?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `text-anchor` for labels. | [shapes/shapeConfig.ts:142](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L142) |
|
|
22276
|
+
| <a id="property-texture-2"></a> `texture?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `Record`\<`string`, `unknown`\>\> | Texture (per textures.js) — name string or full config. | [shapes/shapeConfig.ts:144](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L144) |
|
|
22277
|
+
| <a id="property-texturedefault-2"></a> `textureDefault?` | `Record`\<`string`, `unknown`\> | Default texture config merged into the per-datum texture. | [shapes/shapeConfig.ts:146](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L146) |
|
|
22278
|
+
| <a id="property-vectoreffect-2"></a> `vectorEffect?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `vector-effect` (e.g. "non-scaling-stroke"). | [shapes/shapeConfig.ts:149](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L149) |
|
|
22279
|
+
| <a id="property-verticalalign-2"></a> `verticalAlign?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Label vertical-align ("top"/"middle"/"bottom"). | [shapes/shapeConfig.ts:151](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L151) |
|
|
22280
|
+
| <a id="property-x-2"></a> `x?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | X position. | [shapes/shapeConfig.ts:154](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L154) |
|
|
22281
|
+
| <a id="property-y-2"></a> `y?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Y position. | [shapes/shapeConfig.ts:156](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L156) |
|
|
22194
22282
|
|
|
22195
22283
|
***
|
|
22196
22284
|
|
|
@@ -22198,7 +22286,7 @@ these via `.config(...)` regardless of geometry.
|
|
|
22198
22286
|
|
|
22199
22287
|
### BoxConfig
|
|
22200
22288
|
|
|
22201
|
-
Defined in: [shapes/shapeConfig.ts:
|
|
22289
|
+
Defined in: [shapes/shapeConfig.ts:230](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L230)
|
|
22202
22290
|
|
|
22203
22291
|
Box-specific config (whisker + median + outliers; subset of Shape).
|
|
22204
22292
|
|
|
@@ -22210,18 +22298,18 @@ Box-specific config (whisker + median + outliers; subset of Shape).
|
|
|
22210
22298
|
|
|
22211
22299
|
| Property | Type | Description | Defined in |
|
|
22212
22300
|
| ------ | ------ | ------ | ------ |
|
|
22213
|
-
| <a id="property-data-3"></a> `data?` | `DataPoint`[] | - | [shapes/shapeConfig.ts:
|
|
22214
|
-
| <a id="property-medianconfig"></a> `medianConfig?` | `Record`\<`string`, `unknown`\> | - | [shapes/shapeConfig.ts:
|
|
22215
|
-
| <a id="property-orient"></a> `orient?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Orientation: "vertical" or "horizontal". | [shapes/shapeConfig.ts:
|
|
22216
|
-
| <a id="property-outlier"></a> `outlier?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Outlier accessor (per-datum predicate). | [shapes/shapeConfig.ts:
|
|
22217
|
-
| <a id="property-outlierconfig"></a> `outlierConfig?` | `Record`\<`string`, `unknown`\> | - | [shapes/shapeConfig.ts:
|
|
22218
|
-
| <a id="property-rectconfig"></a> `rectConfig?` | `Record`\<`string`, `unknown`\> | - | [shapes/shapeConfig.ts:
|
|
22219
|
-
| <a id="property-rectwidth"></a> `rectWidth?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [shapes/shapeConfig.ts:
|
|
22220
|
-
| <a id="property-select-3"></a> `select?` | `string` \| `HTMLElement` \| `SVGElement` \| `null` | - | [shapes/shapeConfig.ts:
|
|
22221
|
-
| <a id="property-whiskerconfig"></a> `whiskerConfig?` | `Record`\<`string`, `unknown`\> | - | [shapes/shapeConfig.ts:
|
|
22222
|
-
| <a id="property-whiskermode"></a> `whiskerMode?` | `string` \| `number` \| (`string` \| `number`)[] | Whisker mode: single mode string/number or [low, high] pair. | [shapes/shapeConfig.ts:
|
|
22223
|
-
| <a id="property-x-3"></a> `x?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [shapes/shapeConfig.ts:
|
|
22224
|
-
| <a id="property-y-3"></a> `y?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [shapes/shapeConfig.ts:
|
|
22301
|
+
| <a id="property-data-3"></a> `data?` | `DataPoint`[] | - | [shapes/shapeConfig.ts:231](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L231) |
|
|
22302
|
+
| <a id="property-medianconfig"></a> `medianConfig?` | `Record`\<`string`, `unknown`\> | - | [shapes/shapeConfig.ts:232](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L232) |
|
|
22303
|
+
| <a id="property-orient"></a> `orient?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Orientation: "vertical" or "horizontal". | [shapes/shapeConfig.ts:234](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L234) |
|
|
22304
|
+
| <a id="property-outlier"></a> `outlier?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Outlier accessor (per-datum predicate). | [shapes/shapeConfig.ts:236](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L236) |
|
|
22305
|
+
| <a id="property-outlierconfig"></a> `outlierConfig?` | `Record`\<`string`, `unknown`\> | - | [shapes/shapeConfig.ts:237](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L237) |
|
|
22306
|
+
| <a id="property-rectconfig"></a> `rectConfig?` | `Record`\<`string`, `unknown`\> | - | [shapes/shapeConfig.ts:238](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L238) |
|
|
22307
|
+
| <a id="property-rectwidth"></a> `rectWidth?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [shapes/shapeConfig.ts:239](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L239) |
|
|
22308
|
+
| <a id="property-select-3"></a> `select?` | `string` \| `HTMLElement` \| `SVGElement` \| `null` | - | [shapes/shapeConfig.ts:240](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L240) |
|
|
22309
|
+
| <a id="property-whiskerconfig"></a> `whiskerConfig?` | `Record`\<`string`, `unknown`\> | - | [shapes/shapeConfig.ts:241](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L241) |
|
|
22310
|
+
| <a id="property-whiskermode"></a> `whiskerMode?` | `string` \| `number` \| (`string` \| `number`)[] | Whisker mode: single mode string/number or [low, high] pair. | [shapes/shapeConfig.ts:243](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L243) |
|
|
22311
|
+
| <a id="property-x-3"></a> `x?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [shapes/shapeConfig.ts:244](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L244) |
|
|
22312
|
+
| <a id="property-y-3"></a> `y?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [shapes/shapeConfig.ts:245](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L245) |
|
|
22225
22313
|
|
|
22226
22314
|
***
|
|
22227
22315
|
|
|
@@ -22229,7 +22317,7 @@ Box-specific config (whisker + median + outliers; subset of Shape).
|
|
|
22229
22317
|
|
|
22230
22318
|
### CircleConfig
|
|
22231
22319
|
|
|
22232
|
-
Defined in: [shapes/shapeConfig.ts:
|
|
22320
|
+
Defined in: [shapes/shapeConfig.ts:175](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L175)
|
|
22233
22321
|
|
|
22234
22322
|
Circle-specific config (radius).
|
|
22235
22323
|
|
|
@@ -22250,46 +22338,47 @@ Circle-specific config (radius).
|
|
|
22250
22338
|
| <a id="property-activestyle-3"></a> `activeStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for active data points. | [`BaseShapeConfig`](#baseshapeconfig).[`activeStyle`](#property-activestyle-2) | [shapes/shapeConfig.ts:56](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L56) |
|
|
22251
22339
|
| <a id="property-arialabel-3"></a> `ariaLabel?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA label per datum (accessibility). | [`BaseShapeConfig`](#baseshapeconfig).[`ariaLabel`](#property-arialabel-2) | [shapes/shapeConfig.ts:59](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L59) |
|
|
22252
22340
|
| <a id="property-backgroundimage-3"></a> `backgroundImage?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Optional background image per datum (url or accessor returning a url). | [`BaseShapeConfig`](#baseshapeconfig).[`backgroundImage`](#property-backgroundimage-2) | [shapes/shapeConfig.ts:61](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L61) |
|
|
22341
|
+
| <a id="property-backgroundimagefit-3"></a> `backgroundImageFit?` | [`ConstOrAccessor`](#constoraccessor)\<`"cover"` \| `"contain"`\> | How a `backgroundImage` fits its shape: `"cover"` (default) fills the shape's bounding box, cropping the overflow and clipping to the outline; `"contain"` fits the whole image, centered and fully visible, inside the shape's largest inscribed rectangle. | [`BaseShapeConfig`](#baseshapeconfig).[`backgroundImageFit`](#property-backgroundimagefit-2) | [shapes/shapeConfig.ts:68](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L68) |
|
|
22253
22342
|
| <a id="property-data-4"></a> `data?` | `DataPoint`[] | Data array driving the shape. | [`BaseShapeConfig`](#baseshapeconfig).[`data`](#property-data-2) | [shapes/shapeConfig.ts:49](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L49) |
|
|
22254
|
-
| <a id="property-discrete-3"></a> `discrete?` | `"x"` \| `"y"` | Discrete-axis key ("x" | "y") for charts that flip layout per axis. | [`BaseShapeConfig`](#baseshapeconfig).[`discrete`](#property-discrete-2) | [shapes/shapeConfig.ts:
|
|
22255
|
-
| <a id="property-duration-3"></a> `duration?` | `number` | Animation duration in ms. | [`BaseShapeConfig`](#baseshapeconfig).[`duration`](#property-duration-2) | [shapes/shapeConfig.ts:
|
|
22256
|
-
| <a id="property-fill-3"></a> `fill?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Fill color or accessor returning one. | [`BaseShapeConfig`](#baseshapeconfig).[`fill`](#property-fill-2) | [shapes/shapeConfig.ts:
|
|
22257
|
-
| <a id="property-fillopacity-3"></a> `fillOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Fill opacity (0..1). | [`BaseShapeConfig`](#baseshapeconfig).[`fillOpacity`](#property-fillopacity-2) | [shapes/shapeConfig.ts:
|
|
22258
|
-
| <a id="property-hitarea-3"></a> `hitArea?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\>) | Hit-area shape: function returning bounds or static bounds. | [`BaseShapeConfig`](#baseshapeconfig).[`hitArea`](#property-hitarea-2) | [shapes/shapeConfig.ts:
|
|
22259
|
-
| <a id="property-hover-3"></a> `hover?` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | Predicate or null marking which data points are currently hovered. | [`BaseShapeConfig`](#baseshapeconfig).[`hover`](#property-hover-2) | [shapes/shapeConfig.ts:
|
|
22260
|
-
| <a id="property-hoveropacity-3"></a> `hoverOpacity?` | `number` | Opacity applied to non-hovered data points. | [`BaseShapeConfig`](#baseshapeconfig).[`hoverOpacity`](#property-hoveropacity-2) | [shapes/shapeConfig.ts:
|
|
22261
|
-
| <a id="property-hoverstyle-3"></a> `hoverStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for hovered data points. | [`BaseShapeConfig`](#baseshapeconfig).[`hoverStyle`](#property-hoverstyle-2) | [shapes/shapeConfig.ts:
|
|
22262
|
-
| <a id="property-id-3"></a> `id?` | `AccessorFn` | Unique-id accessor per datum (used for keyed enter/update/exit). | [`BaseShapeConfig`](#baseshapeconfig).[`id`](#property-id-2) | [shapes/shapeConfig.ts:
|
|
22263
|
-
| <a id="property-label-4"></a> `label?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `false` \| `string`[]\> | Label text(s) per datum. False/undefined skips. | [`BaseShapeConfig`](#baseshapeconfig).[`label`](#property-label-3) | [shapes/shapeConfig.ts:
|
|
22264
|
-
| <a id="property-labelbounds-3"></a> `labelBounds?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\> \| `Record`\<`string`, `unknown`\>[]) | Label-bounds accessor (where to mount the label). | [`BaseShapeConfig`](#baseshapeconfig).[`labelBounds`](#property-labelbounds-2) | [shapes/shapeConfig.ts:
|
|
22265
|
-
| <a id="property-labelconfig-3"></a> `labelConfig?` | `Record`\<`string`, `unknown`\> | Label TextBox config (font, padding, etc.). | [`BaseShapeConfig`](#baseshapeconfig).[`labelConfig`](#property-labelconfig-2) | [shapes/shapeConfig.ts:
|
|
22266
|
-
| <a id="property-on-3"></a> `on?` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | Event handlers (Object.<event, handler>). | [`BaseShapeConfig`](#baseshapeconfig).[`on`](#property-on-2) | [shapes/shapeConfig.ts:
|
|
22267
|
-
| <a id="property-opacity-3"></a> `opacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Overall opacity (0..1). | [`BaseShapeConfig`](#baseshapeconfig).[`opacity`](#property-opacity-2) | [shapes/shapeConfig.ts:
|
|
22268
|
-
| <a id="property-pointerevents-3"></a> `pointerEvents?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `pointer-events` attribute per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`pointerEvents`](#property-pointerevents-2) | [shapes/shapeConfig.ts:
|
|
22269
|
-
| <a id="property-r"></a> `r?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | - | [shapes/shapeConfig.ts:
|
|
22270
|
-
| <a id="property-rendermode-3"></a> `renderMode?` | `"full"` \| `"compute"` | "full" runs the DOM enter/update/exit; "compute" skips DOM. | [`BaseShapeConfig`](#baseshapeconfig).[`renderMode`](#property-rendermode-2) | [shapes/shapeConfig.ts:
|
|
22271
|
-
| <a id="property-role-3"></a> `role?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA role per datum (accessibility). | [`BaseShapeConfig`](#baseshapeconfig).[`role`](#property-role-2) | [shapes/shapeConfig.ts:
|
|
22272
|
-
| <a id="property-rotate-3"></a> `rotate?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Rotation in degrees per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`rotate`](#property-rotate-2) | [shapes/shapeConfig.ts:
|
|
22273
|
-
| <a id="property-rx-3"></a> `rx?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `rx` (rect rounded-corner x) — applies to Rect/Bar. | [`BaseShapeConfig`](#baseshapeconfig).[`rx`](#property-rx-2) | [shapes/shapeConfig.ts:
|
|
22274
|
-
| <a id="property-ry-3"></a> `ry?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `ry` (rect rounded-corner y) — applies to Rect/Bar. | [`BaseShapeConfig`](#baseshapeconfig).[`ry`](#property-ry-2) | [shapes/shapeConfig.ts:
|
|
22275
|
-
| <a id="property-scale-4"></a> `scale?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Scale factor (1 = identity). | [`BaseShapeConfig`](#baseshapeconfig).[`scale`](#property-scale-3) | [shapes/shapeConfig.ts:
|
|
22276
|
-
| <a id="property-select-4"></a> `select?` | `string` \| `HTMLElement` \| `SVGElement` \| `null` | Where to mount the shape's DOM (CSS selector, element, or null). | [`BaseShapeConfig`](#baseshapeconfig).[`select`](#property-select-2) | [shapes/shapeConfig.ts:
|
|
22277
|
-
| <a id="property-shaperendering-3"></a> `shapeRendering?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `shape-rendering` attribute per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`shapeRendering`](#property-shaperendering-2) | [shapes/shapeConfig.ts:
|
|
22278
|
-
| <a id="property-sort-3"></a> `sort?` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | d3-style sort comparator. | [`BaseShapeConfig`](#baseshapeconfig).[`sort`](#property-sort-2) | [shapes/shapeConfig.ts:
|
|
22279
|
-
| <a id="property-stroke-3"></a> `stroke?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Stroke color. | [`BaseShapeConfig`](#baseshapeconfig).[`stroke`](#property-stroke-2) | [shapes/shapeConfig.ts:
|
|
22280
|
-
| <a id="property-strokedasharray-3"></a> `strokeDasharray?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-dasharray`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeDasharray`](#property-strokedasharray-2) | [shapes/shapeConfig.ts:
|
|
22281
|
-
| <a id="property-strokelinecap-3"></a> `strokeLinecap?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-linecap`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeLinecap`](#property-strokelinecap-2) | [shapes/shapeConfig.ts:
|
|
22282
|
-
| <a id="property-strokeopacity-3"></a> `strokeOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `stroke-opacity`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeOpacity`](#property-strokeopacity-2) | [shapes/shapeConfig.ts:
|
|
22283
|
-
| <a id="property-strokewidth-3"></a> `strokeWidth?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Stroke width in pixels. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeWidth`](#property-strokewidth-2) | [shapes/shapeConfig.ts:
|
|
22284
|
-
| <a id="property-textanchor-3"></a> `textAnchor?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `text-anchor` for labels. | [`BaseShapeConfig`](#baseshapeconfig).[`textAnchor`](#property-textanchor-2) | [shapes/shapeConfig.ts:
|
|
22285
|
-
| <a id="property-texture-3"></a> `texture?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `Record`\<`string`, `unknown`\>\> | Texture (per textures.js) — name string or full config. | [`BaseShapeConfig`](#baseshapeconfig).[`texture`](#property-texture-2) | [shapes/shapeConfig.ts:
|
|
22286
|
-
| <a id="property-texturedefault-3"></a> `textureDefault?` | `Record`\<`string`, `unknown`\> | Default texture config merged into the per-datum texture. | [`BaseShapeConfig`](#baseshapeconfig).[`textureDefault`](#property-texturedefault-2) | [shapes/shapeConfig.ts:
|
|
22287
|
-
| <a id="property-trail-1"></a> `trail?` | `boolean` | Sweep a tapering motion trail behind the point as it moves between frames. | - | [shapes/shapeConfig.ts:
|
|
22288
|
-
| <a id="property-trailpersist-1"></a> `trailPersist?` | `number` \| `boolean` | Steps of trail history to keep (number), or `true` for a long fading tail. | - | [shapes/shapeConfig.ts:
|
|
22289
|
-
| <a id="property-vectoreffect-3"></a> `vectorEffect?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `vector-effect` (e.g. "non-scaling-stroke"). | [`BaseShapeConfig`](#baseshapeconfig).[`vectorEffect`](#property-vectoreffect-2) | [shapes/shapeConfig.ts:
|
|
22290
|
-
| <a id="property-verticalalign-3"></a> `verticalAlign?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Label vertical-align ("top"/"middle"/"bottom"). | [`BaseShapeConfig`](#baseshapeconfig).[`verticalAlign`](#property-verticalalign-2) | [shapes/shapeConfig.ts:
|
|
22291
|
-
| <a id="property-x-4"></a> `x?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | X position. | [`BaseShapeConfig`](#baseshapeconfig).[`x`](#property-x-2) | [shapes/shapeConfig.ts:
|
|
22292
|
-
| <a id="property-y-4"></a> `y?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Y position. | [`BaseShapeConfig`](#baseshapeconfig).[`y`](#property-y-2) | [shapes/shapeConfig.ts:
|
|
22343
|
+
| <a id="property-discrete-3"></a> `discrete?` | `"x"` \| `"y"` | Discrete-axis key ("x" | "y") for charts that flip layout per axis. | [`BaseShapeConfig`](#baseshapeconfig).[`discrete`](#property-discrete-2) | [shapes/shapeConfig.ts:71](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L71) |
|
|
22344
|
+
| <a id="property-duration-3"></a> `duration?` | `number` | Animation duration in ms. | [`BaseShapeConfig`](#baseshapeconfig).[`duration`](#property-duration-2) | [shapes/shapeConfig.ts:73](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L73) |
|
|
22345
|
+
| <a id="property-fill-3"></a> `fill?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Fill color or accessor returning one. | [`BaseShapeConfig`](#baseshapeconfig).[`fill`](#property-fill-2) | [shapes/shapeConfig.ts:76](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L76) |
|
|
22346
|
+
| <a id="property-fillopacity-3"></a> `fillOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Fill opacity (0..1). | [`BaseShapeConfig`](#baseshapeconfig).[`fillOpacity`](#property-fillopacity-2) | [shapes/shapeConfig.ts:78](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L78) |
|
|
22347
|
+
| <a id="property-hitarea-3"></a> `hitArea?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\>) | Hit-area shape: function returning bounds or static bounds. | [`BaseShapeConfig`](#baseshapeconfig).[`hitArea`](#property-hitarea-2) | [shapes/shapeConfig.ts:88](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L88) |
|
|
22348
|
+
| <a id="property-hover-3"></a> `hover?` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | Predicate or null marking which data points are currently hovered. | [`BaseShapeConfig`](#baseshapeconfig).[`hover`](#property-hover-2) | [shapes/shapeConfig.ts:81](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L81) |
|
|
22349
|
+
| <a id="property-hoveropacity-3"></a> `hoverOpacity?` | `number` | Opacity applied to non-hovered data points. | [`BaseShapeConfig`](#baseshapeconfig).[`hoverOpacity`](#property-hoveropacity-2) | [shapes/shapeConfig.ts:83](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L83) |
|
|
22350
|
+
| <a id="property-hoverstyle-3"></a> `hoverStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for hovered data points. | [`BaseShapeConfig`](#baseshapeconfig).[`hoverStyle`](#property-hoverstyle-2) | [shapes/shapeConfig.ts:85](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L85) |
|
|
22351
|
+
| <a id="property-id-3"></a> `id?` | `AccessorFn` | Unique-id accessor per datum (used for keyed enter/update/exit). | [`BaseShapeConfig`](#baseshapeconfig).[`id`](#property-id-2) | [shapes/shapeConfig.ts:93](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L93) |
|
|
22352
|
+
| <a id="property-label-4"></a> `label?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `false` \| `string`[]\> | Label text(s) per datum. False/undefined skips. | [`BaseShapeConfig`](#baseshapeconfig).[`label`](#property-label-3) | [shapes/shapeConfig.ts:95](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L95) |
|
|
22353
|
+
| <a id="property-labelbounds-3"></a> `labelBounds?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\> \| `Record`\<`string`, `unknown`\>[]) | Label-bounds accessor (where to mount the label). | [`BaseShapeConfig`](#baseshapeconfig).[`labelBounds`](#property-labelbounds-2) | [shapes/shapeConfig.ts:97](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L97) |
|
|
22354
|
+
| <a id="property-labelconfig-3"></a> `labelConfig?` | `Record`\<`string`, `unknown`\> | Label TextBox config (font, padding, etc.). | [`BaseShapeConfig`](#baseshapeconfig).[`labelConfig`](#property-labelconfig-2) | [shapes/shapeConfig.ts:101](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L101) |
|
|
22355
|
+
| <a id="property-on-3"></a> `on?` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | Event handlers (Object.<event, handler>). | [`BaseShapeConfig`](#baseshapeconfig).[`on`](#property-on-2) | [shapes/shapeConfig.ts:159](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L159) |
|
|
22356
|
+
| <a id="property-opacity-3"></a> `opacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Overall opacity (0..1). | [`BaseShapeConfig`](#baseshapeconfig).[`opacity`](#property-opacity-2) | [shapes/shapeConfig.ts:104](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L104) |
|
|
22357
|
+
| <a id="property-pointerevents-3"></a> `pointerEvents?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `pointer-events` attribute per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`pointerEvents`](#property-pointerevents-2) | [shapes/shapeConfig.ts:106](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L106) |
|
|
22358
|
+
| <a id="property-r"></a> `r?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | - | [shapes/shapeConfig.ts:176](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L176) |
|
|
22359
|
+
| <a id="property-rendermode-3"></a> `renderMode?` | `"full"` \| `"compute"` | "full" runs the DOM enter/update/exit; "compute" skips DOM. | [`BaseShapeConfig`](#baseshapeconfig).[`renderMode`](#property-rendermode-2) | [shapes/shapeConfig.ts:120](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L120) |
|
|
22360
|
+
| <a id="property-role-3"></a> `role?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA role per datum (accessibility). | [`BaseShapeConfig`](#baseshapeconfig).[`role`](#property-role-2) | [shapes/shapeConfig.ts:108](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L108) |
|
|
22361
|
+
| <a id="property-rotate-3"></a> `rotate?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Rotation in degrees per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`rotate`](#property-rotate-2) | [shapes/shapeConfig.ts:111](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L111) |
|
|
22362
|
+
| <a id="property-rx-3"></a> `rx?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `rx` (rect rounded-corner x) — applies to Rect/Bar. | [`BaseShapeConfig`](#baseshapeconfig).[`rx`](#property-rx-2) | [shapes/shapeConfig.ts:113](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L113) |
|
|
22363
|
+
| <a id="property-ry-3"></a> `ry?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `ry` (rect rounded-corner y) — applies to Rect/Bar. | [`BaseShapeConfig`](#baseshapeconfig).[`ry`](#property-ry-2) | [shapes/shapeConfig.ts:115](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L115) |
|
|
22364
|
+
| <a id="property-scale-4"></a> `scale?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Scale factor (1 = identity). | [`BaseShapeConfig`](#baseshapeconfig).[`scale`](#property-scale-3) | [shapes/shapeConfig.ts:117](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L117) |
|
|
22365
|
+
| <a id="property-select-4"></a> `select?` | `string` \| `HTMLElement` \| `SVGElement` \| `null` | Where to mount the shape's DOM (CSS selector, element, or null). | [`BaseShapeConfig`](#baseshapeconfig).[`select`](#property-select-2) | [shapes/shapeConfig.ts:122](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L122) |
|
|
22366
|
+
| <a id="property-shaperendering-3"></a> `shapeRendering?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `shape-rendering` attribute per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`shapeRendering`](#property-shaperendering-2) | [shapes/shapeConfig.ts:125](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L125) |
|
|
22367
|
+
| <a id="property-sort-3"></a> `sort?` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | d3-style sort comparator. | [`BaseShapeConfig`](#baseshapeconfig).[`sort`](#property-sort-2) | [shapes/shapeConfig.ts:128](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L128) |
|
|
22368
|
+
| <a id="property-stroke-3"></a> `stroke?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Stroke color. | [`BaseShapeConfig`](#baseshapeconfig).[`stroke`](#property-stroke-2) | [shapes/shapeConfig.ts:131](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L131) |
|
|
22369
|
+
| <a id="property-strokedasharray-3"></a> `strokeDasharray?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-dasharray`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeDasharray`](#property-strokedasharray-2) | [shapes/shapeConfig.ts:133](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L133) |
|
|
22370
|
+
| <a id="property-strokelinecap-3"></a> `strokeLinecap?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-linecap`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeLinecap`](#property-strokelinecap-2) | [shapes/shapeConfig.ts:135](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L135) |
|
|
22371
|
+
| <a id="property-strokeopacity-3"></a> `strokeOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `stroke-opacity`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeOpacity`](#property-strokeopacity-2) | [shapes/shapeConfig.ts:137](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L137) |
|
|
22372
|
+
| <a id="property-strokewidth-3"></a> `strokeWidth?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Stroke width in pixels. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeWidth`](#property-strokewidth-2) | [shapes/shapeConfig.ts:139](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L139) |
|
|
22373
|
+
| <a id="property-textanchor-3"></a> `textAnchor?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `text-anchor` for labels. | [`BaseShapeConfig`](#baseshapeconfig).[`textAnchor`](#property-textanchor-2) | [shapes/shapeConfig.ts:142](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L142) |
|
|
22374
|
+
| <a id="property-texture-3"></a> `texture?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `Record`\<`string`, `unknown`\>\> | Texture (per textures.js) — name string or full config. | [`BaseShapeConfig`](#baseshapeconfig).[`texture`](#property-texture-2) | [shapes/shapeConfig.ts:144](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L144) |
|
|
22375
|
+
| <a id="property-texturedefault-3"></a> `textureDefault?` | `Record`\<`string`, `unknown`\> | Default texture config merged into the per-datum texture. | [`BaseShapeConfig`](#baseshapeconfig).[`textureDefault`](#property-texturedefault-2) | [shapes/shapeConfig.ts:146](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L146) |
|
|
22376
|
+
| <a id="property-trail-1"></a> `trail?` | `boolean` | Sweep a tapering motion trail behind the point as it moves between frames. | - | [shapes/shapeConfig.ts:178](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L178) |
|
|
22377
|
+
| <a id="property-trailpersist-1"></a> `trailPersist?` | `number` \| `boolean` | Steps of trail history to keep (number), or `true` for a long fading tail. | - | [shapes/shapeConfig.ts:180](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L180) |
|
|
22378
|
+
| <a id="property-vectoreffect-3"></a> `vectorEffect?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `vector-effect` (e.g. "non-scaling-stroke"). | [`BaseShapeConfig`](#baseshapeconfig).[`vectorEffect`](#property-vectoreffect-2) | [shapes/shapeConfig.ts:149](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L149) |
|
|
22379
|
+
| <a id="property-verticalalign-3"></a> `verticalAlign?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Label vertical-align ("top"/"middle"/"bottom"). | [`BaseShapeConfig`](#baseshapeconfig).[`verticalAlign`](#property-verticalalign-2) | [shapes/shapeConfig.ts:151](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L151) |
|
|
22380
|
+
| <a id="property-x-4"></a> `x?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | X position. | [`BaseShapeConfig`](#baseshapeconfig).[`x`](#property-x-2) | [shapes/shapeConfig.ts:154](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L154) |
|
|
22381
|
+
| <a id="property-y-4"></a> `y?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Y position. | [`BaseShapeConfig`](#baseshapeconfig).[`y`](#property-y-2) | [shapes/shapeConfig.ts:156](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L156) |
|
|
22293
22382
|
|
|
22294
22383
|
***
|
|
22295
22384
|
|
|
@@ -22391,48 +22480,49 @@ Allows additional custom properties.
|
|
|
22391
22480
|
| <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
22481
|
| <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
22482
|
| <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-
|
|
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-
|
|
22425
|
-
| <a id="property-
|
|
22426
|
-
| <a id="property-
|
|
22427
|
-
| <a id="property-
|
|
22428
|
-
| <a id="property-
|
|
22429
|
-
| <a id="property-
|
|
22430
|
-
| <a id="property-
|
|
22431
|
-
| <a id="property-
|
|
22432
|
-
| <a id="property-
|
|
22433
|
-
| <a id="property-
|
|
22434
|
-
| <a id="property-
|
|
22435
|
-
| <a id="property-
|
|
22483
|
+
| <a id="property-stackoffset"></a> `stackOffset?` | `string` \| ((`series`: `number`[][][], `order`: `number`[]) => `void`) | Vertical offset applied to stacked series. One of `"diverging"` (default — positive and negative values split around zero), `"none"`, `"expand"` (normalize each stack to 100%), `"silhouette"` (streamgraph), or `"wiggle"` (minimize slope changes); or a custom offset function. | [utils/D3plusConfig.ts:404](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L404) |
|
|
22484
|
+
| <a id="property-stackorder"></a> `stackOrder?` | `string` \| `string`[] \| \{ `order?`: `"ascending"` \| `"descending"`; `value`: `string` \| ((`d`: `DataPoint`) => `unknown`); \} \| ((`d`: `DataPoint`) => `unknown`) | Order of stacked series, from the bottom of the stack upward. Accepts a named order (`"descending"` [default] / `"ascending"` by summed value, `"key"` / `"keyReverse"` alphabetically, `"none"` / `"data"` for input order, or d3's `"insideOut"` / `"appearance"` / `"reverse"`), an Array of series keys for an explicit order, a value accessor, or a `{value, order}` config to rank series by an aggregate of any data field. | [utils/D3plusConfig.ts:413](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L413) |
|
|
22485
|
+
| <a id="property-subtitle"></a> `subtitle?` | `string` \| ((`data`: `DataPoint`[]) => `string`) | Subtitle text, or an accessor returning it. | [utils/D3plusConfig.ts:419](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L419) |
|
|
22486
|
+
| <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:421](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L421) |
|
|
22487
|
+
| <a id="property-sum"></a> `sum?` | `DataPointAccessor`\<`number`\> | Value accessor for treemaps and aggregation. | [utils/D3plusConfig.ts:423](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L423) |
|
|
22488
|
+
| <a id="property-svgdesc"></a> `svgDesc?` | `string` | Accessible description applied to the root SVG (`<desc>`). | [utils/D3plusConfig.ts:425](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L425) |
|
|
22489
|
+
| <a id="property-svgtitle"></a> `svgTitle?` | `string` | Accessible title applied to the root SVG (`<title>`). | [utils/D3plusConfig.ts:427](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L427) |
|
|
22490
|
+
| <a id="property-threshold"></a> `threshold?` | `number` | Threshold value for grouping small slices. | [utils/D3plusConfig.ts:429](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L429) |
|
|
22491
|
+
| <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:431](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L431) |
|
|
22492
|
+
| <a id="property-tiles"></a> `tiles?` | `boolean` | Whether to show map tiles. | [utils/D3plusConfig.ts:435](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L435) |
|
|
22493
|
+
| <a id="property-tileurl"></a> `tileUrl?` | `string` | URL to XYZ map tiles. | [utils/D3plusConfig.ts:433](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L433) |
|
|
22494
|
+
| <a id="property-time"></a> `time?` | `string` | Time key for temporal data. | [utils/D3plusConfig.ts:437](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L437) |
|
|
22495
|
+
| <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:439](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L439) |
|
|
22496
|
+
| <a id="property-timeline"></a> `timeline?` | `boolean` | Whether to show the timeline component. | [utils/D3plusConfig.ts:441](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L441) |
|
|
22497
|
+
| <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:443](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L443) |
|
|
22498
|
+
| <a id="property-title-1"></a> `title?` | `string` \| ((`data`: `DataPoint`[]) => `string`) | Chart title or title accessor function. | [utils/D3plusConfig.ts:445](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L445) |
|
|
22499
|
+
| <a id="property-titleconfig"></a> `titleConfig?` | `Record`\<`string`, `string` \| `number`\> | CSS style configuration for the title. | [utils/D3plusConfig.ts:447](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L447) |
|
|
22500
|
+
| <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:449](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L449) |
|
|
22501
|
+
| <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:451](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L451) |
|
|
22502
|
+
| <a id="property-tooltipconfig"></a> `tooltipConfig?` | [`TooltipConfig`](#tooltipconfig-3) | Configuration for the tooltip component. | [utils/D3plusConfig.ts:453](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L453) |
|
|
22503
|
+
| <a id="property-topojson"></a> `topojson?` | `string` \| `object` | Path or object for the topojson data. | [utils/D3plusConfig.ts:455](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L455) |
|
|
22504
|
+
| <a id="property-topojsonfill"></a> `topojsonFill?` | `string` | CSS color to fill the map shapes. | [utils/D3plusConfig.ts:457](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L457) |
|
|
22505
|
+
| <a id="property-topojsonid"></a> `topojsonId?` | (`obj`: `Record`\<`string`, `unknown`\>) => `string` | Accessor function for topojson feature IDs. | [utils/D3plusConfig.ts:459](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L459) |
|
|
22506
|
+
| <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:461](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L461) |
|
|
22507
|
+
| <a id="property-value"></a> `value?` | `DataPointAccessor`\<`number`\> | Value accessor for the visualization. | [utils/D3plusConfig.ts:463](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L463) |
|
|
22508
|
+
| <a id="property-width-1"></a> `width?` | `number` | Overall width of the visualization in pixels. | [utils/D3plusConfig.ts:465](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L465) |
|
|
22509
|
+
| <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:467](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L467) |
|
|
22510
|
+
| <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:473](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L473) |
|
|
22511
|
+
| <a id="property-x2sort"></a> `x2Sort?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` | Defines a custom sorting comparator function for discrete x2 axes. | [utils/D3plusConfig.ts:477](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L477) |
|
|
22512
|
+
| <a id="property-xconfig"></a> `xConfig?` | [`AxisConfig`](#axisconfig-2) | Configuration for the x-axis. | [utils/D3plusConfig.ts:469](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L469) |
|
|
22513
|
+
| <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:471](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L471) |
|
|
22514
|
+
| <a id="property-xsort"></a> `xSort?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` | Custom sort function for x-axis values. | [utils/D3plusConfig.ts:475](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L475) |
|
|
22515
|
+
| <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:479](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L479) |
|
|
22516
|
+
| <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:485](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L485) |
|
|
22517
|
+
| <a id="property-y2sort"></a> `y2Sort?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` | Defines a custom sorting comparator function for discrete y2 axes. | [utils/D3plusConfig.ts:489](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L489) |
|
|
22518
|
+
| <a id="property-yconfig"></a> `yConfig?` | [`AxisConfig`](#axisconfig-2) | Configuration for the y-axis. | [utils/D3plusConfig.ts:481](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L481) |
|
|
22519
|
+
| <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:483](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L483) |
|
|
22520
|
+
| <a id="property-ysort"></a> `ySort?` | (`a`: `DataPoint`, `b`: `DataPoint`) => `number` | Custom sort function for y-axis values. | [utils/D3plusConfig.ts:487](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L487) |
|
|
22521
|
+
| <a id="property-zoom"></a> `zoom?` | `boolean` | Set to false to disable zooming on Geomap and Network. | [utils/D3plusConfig.ts:491](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L491) |
|
|
22522
|
+
| <a id="property-zoomfactor"></a> `zoomFactor?` | `number` | Multiplier applied to programmatic zoom steps. | [utils/D3plusConfig.ts:493](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L493) |
|
|
22523
|
+
| <a id="property-zoommax"></a> `zoomMax?` | `number` | Maximum zoom scale factor. | [utils/D3plusConfig.ts:495](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L495) |
|
|
22524
|
+
| <a id="property-zoompan"></a> `zoomPan?` | `boolean` | Whether panning (drag) is enabled while zoomed. | [utils/D3plusConfig.ts:497](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L497) |
|
|
22525
|
+
| <a id="property-zoomscroll"></a> `zoomScroll?` | `boolean` | Whether scroll-wheel zooming is enabled. | [utils/D3plusConfig.ts:499](https://github.com/d3plus/d3plus/blob/main/packages/core/src/utils/D3plusConfig.ts#L499) |
|
|
22436
22526
|
|
|
22437
22527
|
***
|
|
22438
22528
|
|
|
@@ -22440,7 +22530,7 @@ Allows additional custom properties.
|
|
|
22440
22530
|
|
|
22441
22531
|
### ImageConfig
|
|
22442
22532
|
|
|
22443
|
-
Defined in: [shapes/shapeConfig.ts:
|
|
22533
|
+
Defined in: [shapes/shapeConfig.ts:214](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L214)
|
|
22444
22534
|
|
|
22445
22535
|
Image-specific config (url + dimensions).
|
|
22446
22536
|
|
|
@@ -22448,17 +22538,17 @@ Image-specific config (url + dimensions).
|
|
|
22448
22538
|
|
|
22449
22539
|
| Property | Type | Description | Defined in |
|
|
22450
22540
|
| ------ | ------ | ------ | ------ |
|
|
22451
|
-
| <a id="property-data-6"></a> `data?` | `DataPoint`[] | - | [shapes/shapeConfig.ts:
|
|
22452
|
-
| <a id="property-duration-5"></a> `duration?` | `number` | - | [shapes/shapeConfig.ts:
|
|
22453
|
-
| <a id="property-height-2"></a> `height?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [shapes/shapeConfig.ts:
|
|
22454
|
-
| <a id="property-id-4"></a> `id?` | `AccessorFn` | - | [shapes/shapeConfig.ts:
|
|
22455
|
-
| <a id="property-opacity-4"></a> `opacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [shapes/shapeConfig.ts:
|
|
22456
|
-
| <a id="property-pointerevents-4"></a> `pointerEvents?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | - | [shapes/shapeConfig.ts:
|
|
22457
|
-
| <a id="property-select-5"></a> `select?` | `string` \| `HTMLElement` \| `SVGElement` \| `null` | - | [shapes/shapeConfig.ts:
|
|
22458
|
-
| <a id="property-url"></a> `url?` | `AccessorFn` | URL accessor returning the image src. | [shapes/shapeConfig.ts:
|
|
22459
|
-
| <a id="property-width-2"></a> `width?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [shapes/shapeConfig.ts:
|
|
22460
|
-
| <a id="property-x-6"></a> `x?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [shapes/shapeConfig.ts:
|
|
22461
|
-
| <a id="property-y-6"></a> `y?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [shapes/shapeConfig.ts:
|
|
22541
|
+
| <a id="property-data-6"></a> `data?` | `DataPoint`[] | - | [shapes/shapeConfig.ts:215](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L215) |
|
|
22542
|
+
| <a id="property-duration-5"></a> `duration?` | `number` | - | [shapes/shapeConfig.ts:216](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L216) |
|
|
22543
|
+
| <a id="property-height-2"></a> `height?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [shapes/shapeConfig.ts:217](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L217) |
|
|
22544
|
+
| <a id="property-id-4"></a> `id?` | `AccessorFn` | - | [shapes/shapeConfig.ts:218](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L218) |
|
|
22545
|
+
| <a id="property-opacity-4"></a> `opacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [shapes/shapeConfig.ts:219](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L219) |
|
|
22546
|
+
| <a id="property-pointerevents-4"></a> `pointerEvents?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | - | [shapes/shapeConfig.ts:220](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L220) |
|
|
22547
|
+
| <a id="property-select-5"></a> `select?` | `string` \| `HTMLElement` \| `SVGElement` \| `null` | - | [shapes/shapeConfig.ts:221](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L221) |
|
|
22548
|
+
| <a id="property-url"></a> `url?` | `AccessorFn` | URL accessor returning the image src. | [shapes/shapeConfig.ts:223](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L223) |
|
|
22549
|
+
| <a id="property-width-2"></a> `width?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [shapes/shapeConfig.ts:224](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L224) |
|
|
22550
|
+
| <a id="property-x-6"></a> `x?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [shapes/shapeConfig.ts:225](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L225) |
|
|
22551
|
+
| <a id="property-y-6"></a> `y?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [shapes/shapeConfig.ts:226](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L226) |
|
|
22462
22552
|
|
|
22463
22553
|
***
|
|
22464
22554
|
|
|
@@ -22482,7 +22572,7 @@ Defined in: [utils/D3plusConfig.ts:214](https://github.com/d3plus/d3plus/blob/ma
|
|
|
22482
22572
|
|
|
22483
22573
|
### LineConfig
|
|
22484
22574
|
|
|
22485
|
-
Defined in: [shapes/shapeConfig.ts:
|
|
22575
|
+
Defined in: [shapes/shapeConfig.ts:184](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L184)
|
|
22486
22576
|
|
|
22487
22577
|
Line-specific config (curve + defined).
|
|
22488
22578
|
|
|
@@ -22503,45 +22593,46 @@ Line-specific config (curve + defined).
|
|
|
22503
22593
|
| <a id="property-activestyle-4"></a> `activeStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for active data points. | [`BaseShapeConfig`](#baseshapeconfig).[`activeStyle`](#property-activestyle-2) | [shapes/shapeConfig.ts:56](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L56) |
|
|
22504
22594
|
| <a id="property-arialabel-4"></a> `ariaLabel?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA label per datum (accessibility). | [`BaseShapeConfig`](#baseshapeconfig).[`ariaLabel`](#property-arialabel-2) | [shapes/shapeConfig.ts:59](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L59) |
|
|
22505
22595
|
| <a id="property-backgroundimage-4"></a> `backgroundImage?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Optional background image per datum (url or accessor returning a url). | [`BaseShapeConfig`](#baseshapeconfig).[`backgroundImage`](#property-backgroundimage-2) | [shapes/shapeConfig.ts:61](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L61) |
|
|
22506
|
-
| <a id="property-
|
|
22596
|
+
| <a id="property-backgroundimagefit-4"></a> `backgroundImageFit?` | [`ConstOrAccessor`](#constoraccessor)\<`"cover"` \| `"contain"`\> | How a `backgroundImage` fits its shape: `"cover"` (default) fills the shape's bounding box, cropping the overflow and clipping to the outline; `"contain"` fits the whole image, centered and fully visible, inside the shape's largest inscribed rectangle. | [`BaseShapeConfig`](#baseshapeconfig).[`backgroundImageFit`](#property-backgroundimagefit-2) | [shapes/shapeConfig.ts:68](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L68) |
|
|
22597
|
+
| <a id="property-curve-1"></a> `curve?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | - | - | [shapes/shapeConfig.ts:185](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L185) |
|
|
22507
22598
|
| <a id="property-data-7"></a> `data?` | `DataPoint`[] | Data array driving the shape. | [`BaseShapeConfig`](#baseshapeconfig).[`data`](#property-data-2) | [shapes/shapeConfig.ts:49](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L49) |
|
|
22508
|
-
| <a id="property-defined-1"></a> `defined?` | `AccessorFn` | - | - | [shapes/shapeConfig.ts:
|
|
22509
|
-
| <a id="property-discrete-5"></a> `discrete?` | `"x"` \| `"y"` | Discrete-axis key ("x" | "y") for charts that flip layout per axis. | [`BaseShapeConfig`](#baseshapeconfig).[`discrete`](#property-discrete-2) | [shapes/shapeConfig.ts:
|
|
22510
|
-
| <a id="property-duration-6"></a> `duration?` | `number` | Animation duration in ms. | [`BaseShapeConfig`](#baseshapeconfig).[`duration`](#property-duration-2) | [shapes/shapeConfig.ts:
|
|
22511
|
-
| <a id="property-fill-4"></a> `fill?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Fill color or accessor returning one. | [`BaseShapeConfig`](#baseshapeconfig).[`fill`](#property-fill-2) | [shapes/shapeConfig.ts:
|
|
22512
|
-
| <a id="property-fillopacity-4"></a> `fillOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Fill opacity (0..1). | [`BaseShapeConfig`](#baseshapeconfig).[`fillOpacity`](#property-fillopacity-2) | [shapes/shapeConfig.ts:
|
|
22513
|
-
| <a id="property-hitarea-4"></a> `hitArea?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\>) | Hit-area shape: function returning bounds or static bounds. | [`BaseShapeConfig`](#baseshapeconfig).[`hitArea`](#property-hitarea-2) | [shapes/shapeConfig.ts:
|
|
22514
|
-
| <a id="property-hover-6"></a> `hover?` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | Predicate or null marking which data points are currently hovered. | [`BaseShapeConfig`](#baseshapeconfig).[`hover`](#property-hover-2) | [shapes/shapeConfig.ts:
|
|
22515
|
-
| <a id="property-hoveropacity-4"></a> `hoverOpacity?` | `number` | Opacity applied to non-hovered data points. | [`BaseShapeConfig`](#baseshapeconfig).[`hoverOpacity`](#property-hoveropacity-2) | [shapes/shapeConfig.ts:
|
|
22516
|
-
| <a id="property-hoverstyle-4"></a> `hoverStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for hovered data points. | [`BaseShapeConfig`](#baseshapeconfig).[`hoverStyle`](#property-hoverstyle-2) | [shapes/shapeConfig.ts:
|
|
22517
|
-
| <a id="property-id-5"></a> `id?` | `AccessorFn` | Unique-id accessor per datum (used for keyed enter/update/exit). | [`BaseShapeConfig`](#baseshapeconfig).[`id`](#property-id-2) | [shapes/shapeConfig.ts:
|
|
22518
|
-
| <a id="property-label-6"></a> `label?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `false` \| `string`[]\> | Label text(s) per datum. False/undefined skips. | [`BaseShapeConfig`](#baseshapeconfig).[`label`](#property-label-3) | [shapes/shapeConfig.ts:
|
|
22519
|
-
| <a id="property-labelbounds-4"></a> `labelBounds?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\> \| `Record`\<`string`, `unknown`\>[]) | Label-bounds accessor (where to mount the label). | [`BaseShapeConfig`](#baseshapeconfig).[`labelBounds`](#property-labelbounds-2) | [shapes/shapeConfig.ts:
|
|
22520
|
-
| <a id="property-labelconfig-4"></a> `labelConfig?` | `Record`\<`string`, `unknown`\> | Label TextBox config (font, padding, etc.). | [`BaseShapeConfig`](#baseshapeconfig).[`labelConfig`](#property-labelconfig-2) | [shapes/shapeConfig.ts:
|
|
22521
|
-
| <a id="property-on-5"></a> `on?` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | Event handlers (Object.<event, handler>). | [`BaseShapeConfig`](#baseshapeconfig).[`on`](#property-on-2) | [shapes/shapeConfig.ts:
|
|
22522
|
-
| <a id="property-opacity-5"></a> `opacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Overall opacity (0..1). | [`BaseShapeConfig`](#baseshapeconfig).[`opacity`](#property-opacity-2) | [shapes/shapeConfig.ts:
|
|
22523
|
-
| <a id="property-pointerevents-5"></a> `pointerEvents?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `pointer-events` attribute per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`pointerEvents`](#property-pointerevents-2) | [shapes/shapeConfig.ts:
|
|
22524
|
-
| <a id="property-rendermode-4"></a> `renderMode?` | `"full"` \| `"compute"` | "full" runs the DOM enter/update/exit; "compute" skips DOM. | [`BaseShapeConfig`](#baseshapeconfig).[`renderMode`](#property-rendermode-2) | [shapes/shapeConfig.ts:
|
|
22525
|
-
| <a id="property-role-4"></a> `role?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA role per datum (accessibility). | [`BaseShapeConfig`](#baseshapeconfig).[`role`](#property-role-2) | [shapes/shapeConfig.ts:
|
|
22526
|
-
| <a id="property-rotate-4"></a> `rotate?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Rotation in degrees per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`rotate`](#property-rotate-2) | [shapes/shapeConfig.ts:
|
|
22527
|
-
| <a id="property-rx-4"></a> `rx?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `rx` (rect rounded-corner x) — applies to Rect/Bar. | [`BaseShapeConfig`](#baseshapeconfig).[`rx`](#property-rx-2) | [shapes/shapeConfig.ts:
|
|
22528
|
-
| <a id="property-ry-4"></a> `ry?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `ry` (rect rounded-corner y) — applies to Rect/Bar. | [`BaseShapeConfig`](#baseshapeconfig).[`ry`](#property-ry-2) | [shapes/shapeConfig.ts:
|
|
22529
|
-
| <a id="property-scale-5"></a> `scale?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Scale factor (1 = identity). | [`BaseShapeConfig`](#baseshapeconfig).[`scale`](#property-scale-3) | [shapes/shapeConfig.ts:
|
|
22530
|
-
| <a id="property-select-6"></a> `select?` | `string` \| `HTMLElement` \| `SVGElement` \| `null` | Where to mount the shape's DOM (CSS selector, element, or null). | [`BaseShapeConfig`](#baseshapeconfig).[`select`](#property-select-2) | [shapes/shapeConfig.ts:
|
|
22531
|
-
| <a id="property-shaperendering-4"></a> `shapeRendering?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `shape-rendering` attribute per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`shapeRendering`](#property-shaperendering-2) | [shapes/shapeConfig.ts:
|
|
22532
|
-
| <a id="property-sort-4"></a> `sort?` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | d3-style sort comparator. | [`BaseShapeConfig`](#baseshapeconfig).[`sort`](#property-sort-2) | [shapes/shapeConfig.ts:
|
|
22533
|
-
| <a id="property-stroke-4"></a> `stroke?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Stroke color. | [`BaseShapeConfig`](#baseshapeconfig).[`stroke`](#property-stroke-2) | [shapes/shapeConfig.ts:
|
|
22534
|
-
| <a id="property-strokedasharray-4"></a> `strokeDasharray?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-dasharray`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeDasharray`](#property-strokedasharray-2) | [shapes/shapeConfig.ts:
|
|
22535
|
-
| <a id="property-strokelinecap-4"></a> `strokeLinecap?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-linecap`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeLinecap`](#property-strokelinecap-2) | [shapes/shapeConfig.ts:
|
|
22536
|
-
| <a id="property-strokeopacity-4"></a> `strokeOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `stroke-opacity`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeOpacity`](#property-strokeopacity-2) | [shapes/shapeConfig.ts:
|
|
22537
|
-
| <a id="property-strokewidth-4"></a> `strokeWidth?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Stroke width in pixels. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeWidth`](#property-strokewidth-2) | [shapes/shapeConfig.ts:
|
|
22538
|
-
| <a id="property-textanchor-4"></a> `textAnchor?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `text-anchor` for labels. | [`BaseShapeConfig`](#baseshapeconfig).[`textAnchor`](#property-textanchor-2) | [shapes/shapeConfig.ts:
|
|
22539
|
-
| <a id="property-texture-4"></a> `texture?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `Record`\<`string`, `unknown`\>\> | Texture (per textures.js) — name string or full config. | [`BaseShapeConfig`](#baseshapeconfig).[`texture`](#property-texture-2) | [shapes/shapeConfig.ts:
|
|
22540
|
-
| <a id="property-texturedefault-4"></a> `textureDefault?` | `Record`\<`string`, `unknown`\> | Default texture config merged into the per-datum texture. | [`BaseShapeConfig`](#baseshapeconfig).[`textureDefault`](#property-texturedefault-2) | [shapes/shapeConfig.ts:
|
|
22541
|
-
| <a id="property-vectoreffect-4"></a> `vectorEffect?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `vector-effect` (e.g. "non-scaling-stroke"). | [`BaseShapeConfig`](#baseshapeconfig).[`vectorEffect`](#property-vectoreffect-2) | [shapes/shapeConfig.ts:
|
|
22542
|
-
| <a id="property-verticalalign-4"></a> `verticalAlign?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Label vertical-align ("top"/"middle"/"bottom"). | [`BaseShapeConfig`](#baseshapeconfig).[`verticalAlign`](#property-verticalalign-2) | [shapes/shapeConfig.ts:
|
|
22543
|
-
| <a id="property-x-7"></a> `x?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | X position. | [`BaseShapeConfig`](#baseshapeconfig).[`x`](#property-x-2) | [shapes/shapeConfig.ts:
|
|
22544
|
-
| <a id="property-y-7"></a> `y?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Y position. | [`BaseShapeConfig`](#baseshapeconfig).[`y`](#property-y-2) | [shapes/shapeConfig.ts:
|
|
22599
|
+
| <a id="property-defined-1"></a> `defined?` | `AccessorFn` | - | - | [shapes/shapeConfig.ts:186](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L186) |
|
|
22600
|
+
| <a id="property-discrete-5"></a> `discrete?` | `"x"` \| `"y"` | Discrete-axis key ("x" | "y") for charts that flip layout per axis. | [`BaseShapeConfig`](#baseshapeconfig).[`discrete`](#property-discrete-2) | [shapes/shapeConfig.ts:71](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L71) |
|
|
22601
|
+
| <a id="property-duration-6"></a> `duration?` | `number` | Animation duration in ms. | [`BaseShapeConfig`](#baseshapeconfig).[`duration`](#property-duration-2) | [shapes/shapeConfig.ts:73](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L73) |
|
|
22602
|
+
| <a id="property-fill-4"></a> `fill?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Fill color or accessor returning one. | [`BaseShapeConfig`](#baseshapeconfig).[`fill`](#property-fill-2) | [shapes/shapeConfig.ts:76](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L76) |
|
|
22603
|
+
| <a id="property-fillopacity-4"></a> `fillOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Fill opacity (0..1). | [`BaseShapeConfig`](#baseshapeconfig).[`fillOpacity`](#property-fillopacity-2) | [shapes/shapeConfig.ts:78](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L78) |
|
|
22604
|
+
| <a id="property-hitarea-4"></a> `hitArea?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\>) | Hit-area shape: function returning bounds or static bounds. | [`BaseShapeConfig`](#baseshapeconfig).[`hitArea`](#property-hitarea-2) | [shapes/shapeConfig.ts:88](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L88) |
|
|
22605
|
+
| <a id="property-hover-6"></a> `hover?` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | Predicate or null marking which data points are currently hovered. | [`BaseShapeConfig`](#baseshapeconfig).[`hover`](#property-hover-2) | [shapes/shapeConfig.ts:81](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L81) |
|
|
22606
|
+
| <a id="property-hoveropacity-4"></a> `hoverOpacity?` | `number` | Opacity applied to non-hovered data points. | [`BaseShapeConfig`](#baseshapeconfig).[`hoverOpacity`](#property-hoveropacity-2) | [shapes/shapeConfig.ts:83](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L83) |
|
|
22607
|
+
| <a id="property-hoverstyle-4"></a> `hoverStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for hovered data points. | [`BaseShapeConfig`](#baseshapeconfig).[`hoverStyle`](#property-hoverstyle-2) | [shapes/shapeConfig.ts:85](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L85) |
|
|
22608
|
+
| <a id="property-id-5"></a> `id?` | `AccessorFn` | Unique-id accessor per datum (used for keyed enter/update/exit). | [`BaseShapeConfig`](#baseshapeconfig).[`id`](#property-id-2) | [shapes/shapeConfig.ts:93](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L93) |
|
|
22609
|
+
| <a id="property-label-6"></a> `label?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `false` \| `string`[]\> | Label text(s) per datum. False/undefined skips. | [`BaseShapeConfig`](#baseshapeconfig).[`label`](#property-label-3) | [shapes/shapeConfig.ts:95](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L95) |
|
|
22610
|
+
| <a id="property-labelbounds-4"></a> `labelBounds?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\> \| `Record`\<`string`, `unknown`\>[]) | Label-bounds accessor (where to mount the label). | [`BaseShapeConfig`](#baseshapeconfig).[`labelBounds`](#property-labelbounds-2) | [shapes/shapeConfig.ts:97](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L97) |
|
|
22611
|
+
| <a id="property-labelconfig-4"></a> `labelConfig?` | `Record`\<`string`, `unknown`\> | Label TextBox config (font, padding, etc.). | [`BaseShapeConfig`](#baseshapeconfig).[`labelConfig`](#property-labelconfig-2) | [shapes/shapeConfig.ts:101](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L101) |
|
|
22612
|
+
| <a id="property-on-5"></a> `on?` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | Event handlers (Object.<event, handler>). | [`BaseShapeConfig`](#baseshapeconfig).[`on`](#property-on-2) | [shapes/shapeConfig.ts:159](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L159) |
|
|
22613
|
+
| <a id="property-opacity-5"></a> `opacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Overall opacity (0..1). | [`BaseShapeConfig`](#baseshapeconfig).[`opacity`](#property-opacity-2) | [shapes/shapeConfig.ts:104](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L104) |
|
|
22614
|
+
| <a id="property-pointerevents-5"></a> `pointerEvents?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `pointer-events` attribute per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`pointerEvents`](#property-pointerevents-2) | [shapes/shapeConfig.ts:106](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L106) |
|
|
22615
|
+
| <a id="property-rendermode-4"></a> `renderMode?` | `"full"` \| `"compute"` | "full" runs the DOM enter/update/exit; "compute" skips DOM. | [`BaseShapeConfig`](#baseshapeconfig).[`renderMode`](#property-rendermode-2) | [shapes/shapeConfig.ts:120](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L120) |
|
|
22616
|
+
| <a id="property-role-4"></a> `role?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA role per datum (accessibility). | [`BaseShapeConfig`](#baseshapeconfig).[`role`](#property-role-2) | [shapes/shapeConfig.ts:108](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L108) |
|
|
22617
|
+
| <a id="property-rotate-4"></a> `rotate?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Rotation in degrees per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`rotate`](#property-rotate-2) | [shapes/shapeConfig.ts:111](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L111) |
|
|
22618
|
+
| <a id="property-rx-4"></a> `rx?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `rx` (rect rounded-corner x) — applies to Rect/Bar. | [`BaseShapeConfig`](#baseshapeconfig).[`rx`](#property-rx-2) | [shapes/shapeConfig.ts:113](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L113) |
|
|
22619
|
+
| <a id="property-ry-4"></a> `ry?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `ry` (rect rounded-corner y) — applies to Rect/Bar. | [`BaseShapeConfig`](#baseshapeconfig).[`ry`](#property-ry-2) | [shapes/shapeConfig.ts:115](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L115) |
|
|
22620
|
+
| <a id="property-scale-5"></a> `scale?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Scale factor (1 = identity). | [`BaseShapeConfig`](#baseshapeconfig).[`scale`](#property-scale-3) | [shapes/shapeConfig.ts:117](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L117) |
|
|
22621
|
+
| <a id="property-select-6"></a> `select?` | `string` \| `HTMLElement` \| `SVGElement` \| `null` | Where to mount the shape's DOM (CSS selector, element, or null). | [`BaseShapeConfig`](#baseshapeconfig).[`select`](#property-select-2) | [shapes/shapeConfig.ts:122](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L122) |
|
|
22622
|
+
| <a id="property-shaperendering-4"></a> `shapeRendering?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `shape-rendering` attribute per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`shapeRendering`](#property-shaperendering-2) | [shapes/shapeConfig.ts:125](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L125) |
|
|
22623
|
+
| <a id="property-sort-4"></a> `sort?` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | d3-style sort comparator. | [`BaseShapeConfig`](#baseshapeconfig).[`sort`](#property-sort-2) | [shapes/shapeConfig.ts:128](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L128) |
|
|
22624
|
+
| <a id="property-stroke-4"></a> `stroke?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Stroke color. | [`BaseShapeConfig`](#baseshapeconfig).[`stroke`](#property-stroke-2) | [shapes/shapeConfig.ts:131](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L131) |
|
|
22625
|
+
| <a id="property-strokedasharray-4"></a> `strokeDasharray?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-dasharray`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeDasharray`](#property-strokedasharray-2) | [shapes/shapeConfig.ts:133](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L133) |
|
|
22626
|
+
| <a id="property-strokelinecap-4"></a> `strokeLinecap?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-linecap`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeLinecap`](#property-strokelinecap-2) | [shapes/shapeConfig.ts:135](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L135) |
|
|
22627
|
+
| <a id="property-strokeopacity-4"></a> `strokeOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `stroke-opacity`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeOpacity`](#property-strokeopacity-2) | [shapes/shapeConfig.ts:137](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L137) |
|
|
22628
|
+
| <a id="property-strokewidth-4"></a> `strokeWidth?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Stroke width in pixels. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeWidth`](#property-strokewidth-2) | [shapes/shapeConfig.ts:139](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L139) |
|
|
22629
|
+
| <a id="property-textanchor-4"></a> `textAnchor?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `text-anchor` for labels. | [`BaseShapeConfig`](#baseshapeconfig).[`textAnchor`](#property-textanchor-2) | [shapes/shapeConfig.ts:142](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L142) |
|
|
22630
|
+
| <a id="property-texture-4"></a> `texture?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `Record`\<`string`, `unknown`\>\> | Texture (per textures.js) — name string or full config. | [`BaseShapeConfig`](#baseshapeconfig).[`texture`](#property-texture-2) | [shapes/shapeConfig.ts:144](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L144) |
|
|
22631
|
+
| <a id="property-texturedefault-4"></a> `textureDefault?` | `Record`\<`string`, `unknown`\> | Default texture config merged into the per-datum texture. | [`BaseShapeConfig`](#baseshapeconfig).[`textureDefault`](#property-texturedefault-2) | [shapes/shapeConfig.ts:146](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L146) |
|
|
22632
|
+
| <a id="property-vectoreffect-4"></a> `vectorEffect?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `vector-effect` (e.g. "non-scaling-stroke"). | [`BaseShapeConfig`](#baseshapeconfig).[`vectorEffect`](#property-vectoreffect-2) | [shapes/shapeConfig.ts:149](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L149) |
|
|
22633
|
+
| <a id="property-verticalalign-4"></a> `verticalAlign?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Label vertical-align ("top"/"middle"/"bottom"). | [`BaseShapeConfig`](#baseshapeconfig).[`verticalAlign`](#property-verticalalign-2) | [shapes/shapeConfig.ts:151](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L151) |
|
|
22634
|
+
| <a id="property-x-7"></a> `x?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | X position. | [`BaseShapeConfig`](#baseshapeconfig).[`x`](#property-x-2) | [shapes/shapeConfig.ts:154](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L154) |
|
|
22635
|
+
| <a id="property-y-7"></a> `y?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Y position. | [`BaseShapeConfig`](#baseshapeconfig).[`y`](#property-y-2) | [shapes/shapeConfig.ts:156](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L156) |
|
|
22545
22636
|
|
|
22546
22637
|
***
|
|
22547
22638
|
|
|
@@ -22587,7 +22678,7 @@ Padding object with all four sides.
|
|
|
22587
22678
|
|
|
22588
22679
|
### PathConfig
|
|
22589
22680
|
|
|
22590
|
-
Defined in: [shapes/shapeConfig.ts:
|
|
22681
|
+
Defined in: [shapes/shapeConfig.ts:201](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L201)
|
|
22591
22682
|
|
|
22592
22683
|
Path-specific config (raw SVG path d string or generator).
|
|
22593
22684
|
|
|
@@ -22608,44 +22699,45 @@ Path-specific config (raw SVG path d string or generator).
|
|
|
22608
22699
|
| <a id="property-activestyle-5"></a> `activeStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for active data points. | [`BaseShapeConfig`](#baseshapeconfig).[`activeStyle`](#property-activestyle-2) | [shapes/shapeConfig.ts:56](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L56) |
|
|
22609
22700
|
| <a id="property-arialabel-5"></a> `ariaLabel?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA label per datum (accessibility). | [`BaseShapeConfig`](#baseshapeconfig).[`ariaLabel`](#property-arialabel-2) | [shapes/shapeConfig.ts:59](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L59) |
|
|
22610
22701
|
| <a id="property-backgroundimage-5"></a> `backgroundImage?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Optional background image per datum (url or accessor returning a url). | [`BaseShapeConfig`](#baseshapeconfig).[`backgroundImage`](#property-backgroundimage-2) | [shapes/shapeConfig.ts:61](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L61) |
|
|
22611
|
-
| <a id="property-
|
|
22702
|
+
| <a id="property-backgroundimagefit-5"></a> `backgroundImageFit?` | [`ConstOrAccessor`](#constoraccessor)\<`"cover"` \| `"contain"`\> | How a `backgroundImage` fits its shape: `"cover"` (default) fills the shape's bounding box, cropping the overflow and clipping to the outline; `"contain"` fits the whole image, centered and fully visible, inside the shape's largest inscribed rectangle. | [`BaseShapeConfig`](#baseshapeconfig).[`backgroundImageFit`](#property-backgroundimagefit-2) | [shapes/shapeConfig.ts:68](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L68) |
|
|
22703
|
+
| <a id="property-d"></a> `d?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | - | - | [shapes/shapeConfig.ts:202](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L202) |
|
|
22612
22704
|
| <a id="property-data-8"></a> `data?` | `DataPoint`[] | Data array driving the shape. | [`BaseShapeConfig`](#baseshapeconfig).[`data`](#property-data-2) | [shapes/shapeConfig.ts:49](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L49) |
|
|
22613
|
-
| <a id="property-discrete-6"></a> `discrete?` | `"x"` \| `"y"` | Discrete-axis key ("x" | "y") for charts that flip layout per axis. | [`BaseShapeConfig`](#baseshapeconfig).[`discrete`](#property-discrete-2) | [shapes/shapeConfig.ts:
|
|
22614
|
-
| <a id="property-duration-7"></a> `duration?` | `number` | Animation duration in ms. | [`BaseShapeConfig`](#baseshapeconfig).[`duration`](#property-duration-2) | [shapes/shapeConfig.ts:
|
|
22615
|
-
| <a id="property-fill-5"></a> `fill?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Fill color or accessor returning one. | [`BaseShapeConfig`](#baseshapeconfig).[`fill`](#property-fill-2) | [shapes/shapeConfig.ts:
|
|
22616
|
-
| <a id="property-fillopacity-5"></a> `fillOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Fill opacity (0..1). | [`BaseShapeConfig`](#baseshapeconfig).[`fillOpacity`](#property-fillopacity-2) | [shapes/shapeConfig.ts:
|
|
22617
|
-
| <a id="property-hitarea-5"></a> `hitArea?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\>) | Hit-area shape: function returning bounds or static bounds. | [`BaseShapeConfig`](#baseshapeconfig).[`hitArea`](#property-hitarea-2) | [shapes/shapeConfig.ts:
|
|
22618
|
-
| <a id="property-hover-7"></a> `hover?` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | Predicate or null marking which data points are currently hovered. | [`BaseShapeConfig`](#baseshapeconfig).[`hover`](#property-hover-2) | [shapes/shapeConfig.ts:
|
|
22619
|
-
| <a id="property-hoveropacity-5"></a> `hoverOpacity?` | `number` | Opacity applied to non-hovered data points. | [`BaseShapeConfig`](#baseshapeconfig).[`hoverOpacity`](#property-hoveropacity-2) | [shapes/shapeConfig.ts:
|
|
22620
|
-
| <a id="property-hoverstyle-5"></a> `hoverStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for hovered data points. | [`BaseShapeConfig`](#baseshapeconfig).[`hoverStyle`](#property-hoverstyle-2) | [shapes/shapeConfig.ts:
|
|
22621
|
-
| <a id="property-id-6"></a> `id?` | `AccessorFn` | Unique-id accessor per datum (used for keyed enter/update/exit). | [`BaseShapeConfig`](#baseshapeconfig).[`id`](#property-id-2) | [shapes/shapeConfig.ts:
|
|
22622
|
-
| <a id="property-label-7"></a> `label?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `false` \| `string`[]\> | Label text(s) per datum. False/undefined skips. | [`BaseShapeConfig`](#baseshapeconfig).[`label`](#property-label-3) | [shapes/shapeConfig.ts:
|
|
22623
|
-
| <a id="property-labelbounds-5"></a> `labelBounds?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\> \| `Record`\<`string`, `unknown`\>[]) | Label-bounds accessor (where to mount the label). | [`BaseShapeConfig`](#baseshapeconfig).[`labelBounds`](#property-labelbounds-2) | [shapes/shapeConfig.ts:
|
|
22624
|
-
| <a id="property-labelconfig-5"></a> `labelConfig?` | `Record`\<`string`, `unknown`\> | Label TextBox config (font, padding, etc.). | [`BaseShapeConfig`](#baseshapeconfig).[`labelConfig`](#property-labelconfig-2) | [shapes/shapeConfig.ts:
|
|
22625
|
-
| <a id="property-on-6"></a> `on?` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | Event handlers (Object.<event, handler>). | [`BaseShapeConfig`](#baseshapeconfig).[`on`](#property-on-2) | [shapes/shapeConfig.ts:
|
|
22626
|
-
| <a id="property-opacity-6"></a> `opacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Overall opacity (0..1). | [`BaseShapeConfig`](#baseshapeconfig).[`opacity`](#property-opacity-2) | [shapes/shapeConfig.ts:
|
|
22627
|
-
| <a id="property-pointerevents-6"></a> `pointerEvents?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `pointer-events` attribute per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`pointerEvents`](#property-pointerevents-2) | [shapes/shapeConfig.ts:
|
|
22628
|
-
| <a id="property-rendermode-5"></a> `renderMode?` | `"full"` \| `"compute"` | "full" runs the DOM enter/update/exit; "compute" skips DOM. | [`BaseShapeConfig`](#baseshapeconfig).[`renderMode`](#property-rendermode-2) | [shapes/shapeConfig.ts:
|
|
22629
|
-
| <a id="property-role-5"></a> `role?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA role per datum (accessibility). | [`BaseShapeConfig`](#baseshapeconfig).[`role`](#property-role-2) | [shapes/shapeConfig.ts:
|
|
22630
|
-
| <a id="property-rotate-5"></a> `rotate?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Rotation in degrees per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`rotate`](#property-rotate-2) | [shapes/shapeConfig.ts:
|
|
22631
|
-
| <a id="property-rx-5"></a> `rx?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `rx` (rect rounded-corner x) — applies to Rect/Bar. | [`BaseShapeConfig`](#baseshapeconfig).[`rx`](#property-rx-2) | [shapes/shapeConfig.ts:
|
|
22632
|
-
| <a id="property-ry-5"></a> `ry?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `ry` (rect rounded-corner y) — applies to Rect/Bar. | [`BaseShapeConfig`](#baseshapeconfig).[`ry`](#property-ry-2) | [shapes/shapeConfig.ts:
|
|
22633
|
-
| <a id="property-scale-6"></a> `scale?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Scale factor (1 = identity). | [`BaseShapeConfig`](#baseshapeconfig).[`scale`](#property-scale-3) | [shapes/shapeConfig.ts:
|
|
22634
|
-
| <a id="property-select-7"></a> `select?` | `string` \| `HTMLElement` \| `SVGElement` \| `null` | Where to mount the shape's DOM (CSS selector, element, or null). | [`BaseShapeConfig`](#baseshapeconfig).[`select`](#property-select-2) | [shapes/shapeConfig.ts:
|
|
22635
|
-
| <a id="property-shaperendering-5"></a> `shapeRendering?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `shape-rendering` attribute per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`shapeRendering`](#property-shaperendering-2) | [shapes/shapeConfig.ts:
|
|
22636
|
-
| <a id="property-sort-5"></a> `sort?` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | d3-style sort comparator. | [`BaseShapeConfig`](#baseshapeconfig).[`sort`](#property-sort-2) | [shapes/shapeConfig.ts:
|
|
22637
|
-
| <a id="property-stroke-5"></a> `stroke?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Stroke color. | [`BaseShapeConfig`](#baseshapeconfig).[`stroke`](#property-stroke-2) | [shapes/shapeConfig.ts:
|
|
22638
|
-
| <a id="property-strokedasharray-5"></a> `strokeDasharray?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-dasharray`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeDasharray`](#property-strokedasharray-2) | [shapes/shapeConfig.ts:
|
|
22639
|
-
| <a id="property-strokelinecap-5"></a> `strokeLinecap?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-linecap`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeLinecap`](#property-strokelinecap-2) | [shapes/shapeConfig.ts:
|
|
22640
|
-
| <a id="property-strokeopacity-5"></a> `strokeOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `stroke-opacity`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeOpacity`](#property-strokeopacity-2) | [shapes/shapeConfig.ts:
|
|
22641
|
-
| <a id="property-strokewidth-5"></a> `strokeWidth?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Stroke width in pixels. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeWidth`](#property-strokewidth-2) | [shapes/shapeConfig.ts:
|
|
22642
|
-
| <a id="property-textanchor-5"></a> `textAnchor?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `text-anchor` for labels. | [`BaseShapeConfig`](#baseshapeconfig).[`textAnchor`](#property-textanchor-2) | [shapes/shapeConfig.ts:
|
|
22643
|
-
| <a id="property-texture-5"></a> `texture?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `Record`\<`string`, `unknown`\>\> | Texture (per textures.js) — name string or full config. | [`BaseShapeConfig`](#baseshapeconfig).[`texture`](#property-texture-2) | [shapes/shapeConfig.ts:
|
|
22644
|
-
| <a id="property-texturedefault-5"></a> `textureDefault?` | `Record`\<`string`, `unknown`\> | Default texture config merged into the per-datum texture. | [`BaseShapeConfig`](#baseshapeconfig).[`textureDefault`](#property-texturedefault-2) | [shapes/shapeConfig.ts:
|
|
22645
|
-
| <a id="property-vectoreffect-5"></a> `vectorEffect?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `vector-effect` (e.g. "non-scaling-stroke"). | [`BaseShapeConfig`](#baseshapeconfig).[`vectorEffect`](#property-vectoreffect-2) | [shapes/shapeConfig.ts:
|
|
22646
|
-
| <a id="property-verticalalign-5"></a> `verticalAlign?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Label vertical-align ("top"/"middle"/"bottom"). | [`BaseShapeConfig`](#baseshapeconfig).[`verticalAlign`](#property-verticalalign-2) | [shapes/shapeConfig.ts:
|
|
22647
|
-
| <a id="property-x-8"></a> `x?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | X position. | [`BaseShapeConfig`](#baseshapeconfig).[`x`](#property-x-2) | [shapes/shapeConfig.ts:
|
|
22648
|
-
| <a id="property-y-8"></a> `y?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Y position. | [`BaseShapeConfig`](#baseshapeconfig).[`y`](#property-y-2) | [shapes/shapeConfig.ts:
|
|
22705
|
+
| <a id="property-discrete-6"></a> `discrete?` | `"x"` \| `"y"` | Discrete-axis key ("x" | "y") for charts that flip layout per axis. | [`BaseShapeConfig`](#baseshapeconfig).[`discrete`](#property-discrete-2) | [shapes/shapeConfig.ts:71](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L71) |
|
|
22706
|
+
| <a id="property-duration-7"></a> `duration?` | `number` | Animation duration in ms. | [`BaseShapeConfig`](#baseshapeconfig).[`duration`](#property-duration-2) | [shapes/shapeConfig.ts:73](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L73) |
|
|
22707
|
+
| <a id="property-fill-5"></a> `fill?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Fill color or accessor returning one. | [`BaseShapeConfig`](#baseshapeconfig).[`fill`](#property-fill-2) | [shapes/shapeConfig.ts:76](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L76) |
|
|
22708
|
+
| <a id="property-fillopacity-5"></a> `fillOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Fill opacity (0..1). | [`BaseShapeConfig`](#baseshapeconfig).[`fillOpacity`](#property-fillopacity-2) | [shapes/shapeConfig.ts:78](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L78) |
|
|
22709
|
+
| <a id="property-hitarea-5"></a> `hitArea?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\>) | Hit-area shape: function returning bounds or static bounds. | [`BaseShapeConfig`](#baseshapeconfig).[`hitArea`](#property-hitarea-2) | [shapes/shapeConfig.ts:88](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L88) |
|
|
22710
|
+
| <a id="property-hover-7"></a> `hover?` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | Predicate or null marking which data points are currently hovered. | [`BaseShapeConfig`](#baseshapeconfig).[`hover`](#property-hover-2) | [shapes/shapeConfig.ts:81](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L81) |
|
|
22711
|
+
| <a id="property-hoveropacity-5"></a> `hoverOpacity?` | `number` | Opacity applied to non-hovered data points. | [`BaseShapeConfig`](#baseshapeconfig).[`hoverOpacity`](#property-hoveropacity-2) | [shapes/shapeConfig.ts:83](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L83) |
|
|
22712
|
+
| <a id="property-hoverstyle-5"></a> `hoverStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for hovered data points. | [`BaseShapeConfig`](#baseshapeconfig).[`hoverStyle`](#property-hoverstyle-2) | [shapes/shapeConfig.ts:85](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L85) |
|
|
22713
|
+
| <a id="property-id-6"></a> `id?` | `AccessorFn` | Unique-id accessor per datum (used for keyed enter/update/exit). | [`BaseShapeConfig`](#baseshapeconfig).[`id`](#property-id-2) | [shapes/shapeConfig.ts:93](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L93) |
|
|
22714
|
+
| <a id="property-label-7"></a> `label?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `false` \| `string`[]\> | Label text(s) per datum. False/undefined skips. | [`BaseShapeConfig`](#baseshapeconfig).[`label`](#property-label-3) | [shapes/shapeConfig.ts:95](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L95) |
|
|
22715
|
+
| <a id="property-labelbounds-5"></a> `labelBounds?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\> \| `Record`\<`string`, `unknown`\>[]) | Label-bounds accessor (where to mount the label). | [`BaseShapeConfig`](#baseshapeconfig).[`labelBounds`](#property-labelbounds-2) | [shapes/shapeConfig.ts:97](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L97) |
|
|
22716
|
+
| <a id="property-labelconfig-5"></a> `labelConfig?` | `Record`\<`string`, `unknown`\> | Label TextBox config (font, padding, etc.). | [`BaseShapeConfig`](#baseshapeconfig).[`labelConfig`](#property-labelconfig-2) | [shapes/shapeConfig.ts:101](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L101) |
|
|
22717
|
+
| <a id="property-on-6"></a> `on?` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | Event handlers (Object.<event, handler>). | [`BaseShapeConfig`](#baseshapeconfig).[`on`](#property-on-2) | [shapes/shapeConfig.ts:159](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L159) |
|
|
22718
|
+
| <a id="property-opacity-6"></a> `opacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Overall opacity (0..1). | [`BaseShapeConfig`](#baseshapeconfig).[`opacity`](#property-opacity-2) | [shapes/shapeConfig.ts:104](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L104) |
|
|
22719
|
+
| <a id="property-pointerevents-6"></a> `pointerEvents?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `pointer-events` attribute per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`pointerEvents`](#property-pointerevents-2) | [shapes/shapeConfig.ts:106](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L106) |
|
|
22720
|
+
| <a id="property-rendermode-5"></a> `renderMode?` | `"full"` \| `"compute"` | "full" runs the DOM enter/update/exit; "compute" skips DOM. | [`BaseShapeConfig`](#baseshapeconfig).[`renderMode`](#property-rendermode-2) | [shapes/shapeConfig.ts:120](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L120) |
|
|
22721
|
+
| <a id="property-role-5"></a> `role?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA role per datum (accessibility). | [`BaseShapeConfig`](#baseshapeconfig).[`role`](#property-role-2) | [shapes/shapeConfig.ts:108](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L108) |
|
|
22722
|
+
| <a id="property-rotate-5"></a> `rotate?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Rotation in degrees per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`rotate`](#property-rotate-2) | [shapes/shapeConfig.ts:111](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L111) |
|
|
22723
|
+
| <a id="property-rx-5"></a> `rx?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `rx` (rect rounded-corner x) — applies to Rect/Bar. | [`BaseShapeConfig`](#baseshapeconfig).[`rx`](#property-rx-2) | [shapes/shapeConfig.ts:113](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L113) |
|
|
22724
|
+
| <a id="property-ry-5"></a> `ry?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `ry` (rect rounded-corner y) — applies to Rect/Bar. | [`BaseShapeConfig`](#baseshapeconfig).[`ry`](#property-ry-2) | [shapes/shapeConfig.ts:115](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L115) |
|
|
22725
|
+
| <a id="property-scale-6"></a> `scale?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Scale factor (1 = identity). | [`BaseShapeConfig`](#baseshapeconfig).[`scale`](#property-scale-3) | [shapes/shapeConfig.ts:117](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L117) |
|
|
22726
|
+
| <a id="property-select-7"></a> `select?` | `string` \| `HTMLElement` \| `SVGElement` \| `null` | Where to mount the shape's DOM (CSS selector, element, or null). | [`BaseShapeConfig`](#baseshapeconfig).[`select`](#property-select-2) | [shapes/shapeConfig.ts:122](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L122) |
|
|
22727
|
+
| <a id="property-shaperendering-5"></a> `shapeRendering?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `shape-rendering` attribute per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`shapeRendering`](#property-shaperendering-2) | [shapes/shapeConfig.ts:125](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L125) |
|
|
22728
|
+
| <a id="property-sort-5"></a> `sort?` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | d3-style sort comparator. | [`BaseShapeConfig`](#baseshapeconfig).[`sort`](#property-sort-2) | [shapes/shapeConfig.ts:128](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L128) |
|
|
22729
|
+
| <a id="property-stroke-5"></a> `stroke?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Stroke color. | [`BaseShapeConfig`](#baseshapeconfig).[`stroke`](#property-stroke-2) | [shapes/shapeConfig.ts:131](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L131) |
|
|
22730
|
+
| <a id="property-strokedasharray-5"></a> `strokeDasharray?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-dasharray`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeDasharray`](#property-strokedasharray-2) | [shapes/shapeConfig.ts:133](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L133) |
|
|
22731
|
+
| <a id="property-strokelinecap-5"></a> `strokeLinecap?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-linecap`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeLinecap`](#property-strokelinecap-2) | [shapes/shapeConfig.ts:135](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L135) |
|
|
22732
|
+
| <a id="property-strokeopacity-5"></a> `strokeOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `stroke-opacity`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeOpacity`](#property-strokeopacity-2) | [shapes/shapeConfig.ts:137](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L137) |
|
|
22733
|
+
| <a id="property-strokewidth-5"></a> `strokeWidth?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Stroke width in pixels. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeWidth`](#property-strokewidth-2) | [shapes/shapeConfig.ts:139](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L139) |
|
|
22734
|
+
| <a id="property-textanchor-5"></a> `textAnchor?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `text-anchor` for labels. | [`BaseShapeConfig`](#baseshapeconfig).[`textAnchor`](#property-textanchor-2) | [shapes/shapeConfig.ts:142](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L142) |
|
|
22735
|
+
| <a id="property-texture-5"></a> `texture?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `Record`\<`string`, `unknown`\>\> | Texture (per textures.js) — name string or full config. | [`BaseShapeConfig`](#baseshapeconfig).[`texture`](#property-texture-2) | [shapes/shapeConfig.ts:144](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L144) |
|
|
22736
|
+
| <a id="property-texturedefault-5"></a> `textureDefault?` | `Record`\<`string`, `unknown`\> | Default texture config merged into the per-datum texture. | [`BaseShapeConfig`](#baseshapeconfig).[`textureDefault`](#property-texturedefault-2) | [shapes/shapeConfig.ts:146](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L146) |
|
|
22737
|
+
| <a id="property-vectoreffect-5"></a> `vectorEffect?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `vector-effect` (e.g. "non-scaling-stroke"). | [`BaseShapeConfig`](#baseshapeconfig).[`vectorEffect`](#property-vectoreffect-2) | [shapes/shapeConfig.ts:149](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L149) |
|
|
22738
|
+
| <a id="property-verticalalign-5"></a> `verticalAlign?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Label vertical-align ("top"/"middle"/"bottom"). | [`BaseShapeConfig`](#baseshapeconfig).[`verticalAlign`](#property-verticalalign-2) | [shapes/shapeConfig.ts:151](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L151) |
|
|
22739
|
+
| <a id="property-x-8"></a> `x?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | X position. | [`BaseShapeConfig`](#baseshapeconfig).[`x`](#property-x-2) | [shapes/shapeConfig.ts:154](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L154) |
|
|
22740
|
+
| <a id="property-y-8"></a> `y?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Y position. | [`BaseShapeConfig`](#baseshapeconfig).[`y`](#property-y-2) | [shapes/shapeConfig.ts:156](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L156) |
|
|
22649
22741
|
|
|
22650
22742
|
***
|
|
22651
22743
|
|
|
@@ -22653,7 +22745,7 @@ Path-specific config (raw SVG path d string or generator).
|
|
|
22653
22745
|
|
|
22654
22746
|
### RectConfig
|
|
22655
22747
|
|
|
22656
|
-
Defined in: [shapes/shapeConfig.ts:
|
|
22748
|
+
Defined in: [shapes/shapeConfig.ts:165](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L165)
|
|
22657
22749
|
|
|
22658
22750
|
Rect-specific config (width + height on top of base).
|
|
22659
22751
|
|
|
@@ -22678,47 +22770,48 @@ Rect-specific config (width + height on top of base).
|
|
|
22678
22770
|
| <a id="property-activestyle-6"></a> `activeStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for active data points. | [`BaseShapeConfig`](#baseshapeconfig).[`activeStyle`](#property-activestyle-2) | [shapes/shapeConfig.ts:56](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L56) |
|
|
22679
22771
|
| <a id="property-arialabel-6"></a> `ariaLabel?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA label per datum (accessibility). | [`BaseShapeConfig`](#baseshapeconfig).[`ariaLabel`](#property-arialabel-2) | [shapes/shapeConfig.ts:59](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L59) |
|
|
22680
22772
|
| <a id="property-backgroundimage-6"></a> `backgroundImage?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Optional background image per datum (url or accessor returning a url). | [`BaseShapeConfig`](#baseshapeconfig).[`backgroundImage`](#property-backgroundimage-2) | [shapes/shapeConfig.ts:61](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L61) |
|
|
22773
|
+
| <a id="property-backgroundimagefit-6"></a> `backgroundImageFit?` | [`ConstOrAccessor`](#constoraccessor)\<`"cover"` \| `"contain"`\> | How a `backgroundImage` fits its shape: `"cover"` (default) fills the shape's bounding box, cropping the overflow and clipping to the outline; `"contain"` fits the whole image, centered and fully visible, inside the shape's largest inscribed rectangle. | [`BaseShapeConfig`](#baseshapeconfig).[`backgroundImageFit`](#property-backgroundimagefit-2) | [shapes/shapeConfig.ts:68](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L68) |
|
|
22681
22774
|
| <a id="property-data-9"></a> `data?` | `DataPoint`[] | Data array driving the shape. | [`BaseShapeConfig`](#baseshapeconfig).[`data`](#property-data-2) | [shapes/shapeConfig.ts:49](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L49) |
|
|
22682
|
-
| <a id="property-discrete-7"></a> `discrete?` | `"x"` \| `"y"` | Discrete-axis key ("x" | "y") for charts that flip layout per axis. | [`BaseShapeConfig`](#baseshapeconfig).[`discrete`](#property-discrete-2) | [shapes/shapeConfig.ts:
|
|
22683
|
-
| <a id="property-duration-8"></a> `duration?` | `number` | Animation duration in ms. | [`BaseShapeConfig`](#baseshapeconfig).[`duration`](#property-duration-2) | [shapes/shapeConfig.ts:
|
|
22684
|
-
| <a id="property-fill-6"></a> `fill?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Fill color or accessor returning one. | [`BaseShapeConfig`](#baseshapeconfig).[`fill`](#property-fill-2) | [shapes/shapeConfig.ts:
|
|
22685
|
-
| <a id="property-fillopacity-6"></a> `fillOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Fill opacity (0..1). | [`BaseShapeConfig`](#baseshapeconfig).[`fillOpacity`](#property-fillopacity-2) | [shapes/shapeConfig.ts:
|
|
22686
|
-
| <a id="property-height-3"></a> `height?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | - | [shapes/shapeConfig.ts:
|
|
22687
|
-
| <a id="property-hitarea-6"></a> `hitArea?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\>) | Hit-area shape: function returning bounds or static bounds. | [`BaseShapeConfig`](#baseshapeconfig).[`hitArea`](#property-hitarea-2) | [shapes/shapeConfig.ts:
|
|
22688
|
-
| <a id="property-hover-8"></a> `hover?` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | Predicate or null marking which data points are currently hovered. | [`BaseShapeConfig`](#baseshapeconfig).[`hover`](#property-hover-2) | [shapes/shapeConfig.ts:
|
|
22689
|
-
| <a id="property-hoveropacity-6"></a> `hoverOpacity?` | `number` | Opacity applied to non-hovered data points. | [`BaseShapeConfig`](#baseshapeconfig).[`hoverOpacity`](#property-hoveropacity-2) | [shapes/shapeConfig.ts:
|
|
22690
|
-
| <a id="property-hoverstyle-6"></a> `hoverStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for hovered data points. | [`BaseShapeConfig`](#baseshapeconfig).[`hoverStyle`](#property-hoverstyle-2) | [shapes/shapeConfig.ts:
|
|
22691
|
-
| <a id="property-id-7"></a> `id?` | `AccessorFn` | Unique-id accessor per datum (used for keyed enter/update/exit). | [`BaseShapeConfig`](#baseshapeconfig).[`id`](#property-id-2) | [shapes/shapeConfig.ts:
|
|
22692
|
-
| <a id="property-label-8"></a> `label?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `false` \| `string`[]\> | Label text(s) per datum. False/undefined skips. | [`BaseShapeConfig`](#baseshapeconfig).[`label`](#property-label-3) | [shapes/shapeConfig.ts:
|
|
22693
|
-
| <a id="property-labelbounds-6"></a> `labelBounds?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\> \| `Record`\<`string`, `unknown`\>[]) | Label-bounds accessor (where to mount the label). | [`BaseShapeConfig`](#baseshapeconfig).[`labelBounds`](#property-labelbounds-2) | [shapes/shapeConfig.ts:
|
|
22694
|
-
| <a id="property-labelconfig-6"></a> `labelConfig?` | `Record`\<`string`, `unknown`\> | Label TextBox config (font, padding, etc.). | [`BaseShapeConfig`](#baseshapeconfig).[`labelConfig`](#property-labelconfig-2) | [shapes/shapeConfig.ts:
|
|
22695
|
-
| <a id="property-on-7"></a> `on?` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | Event handlers (Object.<event, handler>). | [`BaseShapeConfig`](#baseshapeconfig).[`on`](#property-on-2) | [shapes/shapeConfig.ts:
|
|
22696
|
-
| <a id="property-opacity-7"></a> `opacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Overall opacity (0..1). | [`BaseShapeConfig`](#baseshapeconfig).[`opacity`](#property-opacity-2) | [shapes/shapeConfig.ts:
|
|
22697
|
-
| <a id="property-pointerevents-7"></a> `pointerEvents?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `pointer-events` attribute per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`pointerEvents`](#property-pointerevents-2) | [shapes/shapeConfig.ts:
|
|
22698
|
-
| <a id="property-rendermode-6"></a> `renderMode?` | `"full"` \| `"compute"` | "full" runs the DOM enter/update/exit; "compute" skips DOM. | [`BaseShapeConfig`](#baseshapeconfig).[`renderMode`](#property-rendermode-2) | [shapes/shapeConfig.ts:
|
|
22699
|
-
| <a id="property-role-6"></a> `role?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA role per datum (accessibility). | [`BaseShapeConfig`](#baseshapeconfig).[`role`](#property-role-2) | [shapes/shapeConfig.ts:
|
|
22700
|
-
| <a id="property-rotate-6"></a> `rotate?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Rotation in degrees per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`rotate`](#property-rotate-2) | [shapes/shapeConfig.ts:
|
|
22701
|
-
| <a id="property-rx-6"></a> `rx?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `rx` (rect rounded-corner x) — applies to Rect/Bar. | [`BaseShapeConfig`](#baseshapeconfig).[`rx`](#property-rx-2) | [shapes/shapeConfig.ts:
|
|
22702
|
-
| <a id="property-ry-6"></a> `ry?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `ry` (rect rounded-corner y) — applies to Rect/Bar. | [`BaseShapeConfig`](#baseshapeconfig).[`ry`](#property-ry-2) | [shapes/shapeConfig.ts:
|
|
22703
|
-
| <a id="property-scale-7"></a> `scale?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Scale factor (1 = identity). | [`BaseShapeConfig`](#baseshapeconfig).[`scale`](#property-scale-3) | [shapes/shapeConfig.ts:
|
|
22704
|
-
| <a id="property-select-8"></a> `select?` | `string` \| `HTMLElement` \| `SVGElement` \| `null` | Where to mount the shape's DOM (CSS selector, element, or null). | [`BaseShapeConfig`](#baseshapeconfig).[`select`](#property-select-2) | [shapes/shapeConfig.ts:
|
|
22705
|
-
| <a id="property-shaperendering-6"></a> `shapeRendering?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `shape-rendering` attribute per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`shapeRendering`](#property-shaperendering-2) | [shapes/shapeConfig.ts:
|
|
22706
|
-
| <a id="property-sort-6"></a> `sort?` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | d3-style sort comparator. | [`BaseShapeConfig`](#baseshapeconfig).[`sort`](#property-sort-2) | [shapes/shapeConfig.ts:
|
|
22707
|
-
| <a id="property-stroke-6"></a> `stroke?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Stroke color. | [`BaseShapeConfig`](#baseshapeconfig).[`stroke`](#property-stroke-2) | [shapes/shapeConfig.ts:
|
|
22708
|
-
| <a id="property-strokedasharray-6"></a> `strokeDasharray?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-dasharray`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeDasharray`](#property-strokedasharray-2) | [shapes/shapeConfig.ts:
|
|
22709
|
-
| <a id="property-strokelinecap-6"></a> `strokeLinecap?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-linecap`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeLinecap`](#property-strokelinecap-2) | [shapes/shapeConfig.ts:
|
|
22710
|
-
| <a id="property-strokeopacity-6"></a> `strokeOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `stroke-opacity`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeOpacity`](#property-strokeopacity-2) | [shapes/shapeConfig.ts:
|
|
22711
|
-
| <a id="property-strokewidth-6"></a> `strokeWidth?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Stroke width in pixels. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeWidth`](#property-strokewidth-2) | [shapes/shapeConfig.ts:
|
|
22712
|
-
| <a id="property-textanchor-6"></a> `textAnchor?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `text-anchor` for labels. | [`BaseShapeConfig`](#baseshapeconfig).[`textAnchor`](#property-textanchor-2) | [shapes/shapeConfig.ts:
|
|
22713
|
-
| <a id="property-texture-6"></a> `texture?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `Record`\<`string`, `unknown`\>\> | Texture (per textures.js) — name string or full config. | [`BaseShapeConfig`](#baseshapeconfig).[`texture`](#property-texture-2) | [shapes/shapeConfig.ts:
|
|
22714
|
-
| <a id="property-texturedefault-6"></a> `textureDefault?` | `Record`\<`string`, `unknown`\> | Default texture config merged into the per-datum texture. | [`BaseShapeConfig`](#baseshapeconfig).[`textureDefault`](#property-texturedefault-2) | [shapes/shapeConfig.ts:
|
|
22715
|
-
| <a id="property-trail-2"></a> `trail?` | `boolean` | Sweep a tapering motion trail behind the rect as it moves between frames. | - | [shapes/shapeConfig.ts:
|
|
22716
|
-
| <a id="property-trailpersist-2"></a> `trailPersist?` | `number` \| `boolean` | Steps of trail history to keep (number), or `true` for a long fading tail. | - | [shapes/shapeConfig.ts:
|
|
22717
|
-
| <a id="property-vectoreffect-6"></a> `vectorEffect?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `vector-effect` (e.g. "non-scaling-stroke"). | [`BaseShapeConfig`](#baseshapeconfig).[`vectorEffect`](#property-vectoreffect-2) | [shapes/shapeConfig.ts:
|
|
22718
|
-
| <a id="property-verticalalign-6"></a> `verticalAlign?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Label vertical-align ("top"/"middle"/"bottom"). | [`BaseShapeConfig`](#baseshapeconfig).[`verticalAlign`](#property-verticalalign-2) | [shapes/shapeConfig.ts:
|
|
22719
|
-
| <a id="property-width-3"></a> `width?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | - | [shapes/shapeConfig.ts:
|
|
22720
|
-
| <a id="property-x-9"></a> `x?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | X position. | [`BaseShapeConfig`](#baseshapeconfig).[`x`](#property-x-2) | [shapes/shapeConfig.ts:
|
|
22721
|
-
| <a id="property-y-9"></a> `y?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Y position. | [`BaseShapeConfig`](#baseshapeconfig).[`y`](#property-y-2) | [shapes/shapeConfig.ts:
|
|
22775
|
+
| <a id="property-discrete-7"></a> `discrete?` | `"x"` \| `"y"` | Discrete-axis key ("x" | "y") for charts that flip layout per axis. | [`BaseShapeConfig`](#baseshapeconfig).[`discrete`](#property-discrete-2) | [shapes/shapeConfig.ts:71](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L71) |
|
|
22776
|
+
| <a id="property-duration-8"></a> `duration?` | `number` | Animation duration in ms. | [`BaseShapeConfig`](#baseshapeconfig).[`duration`](#property-duration-2) | [shapes/shapeConfig.ts:73](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L73) |
|
|
22777
|
+
| <a id="property-fill-6"></a> `fill?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Fill color or accessor returning one. | [`BaseShapeConfig`](#baseshapeconfig).[`fill`](#property-fill-2) | [shapes/shapeConfig.ts:76](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L76) |
|
|
22778
|
+
| <a id="property-fillopacity-6"></a> `fillOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Fill opacity (0..1). | [`BaseShapeConfig`](#baseshapeconfig).[`fillOpacity`](#property-fillopacity-2) | [shapes/shapeConfig.ts:78](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L78) |
|
|
22779
|
+
| <a id="property-height-3"></a> `height?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | - | [shapes/shapeConfig.ts:167](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L167) |
|
|
22780
|
+
| <a id="property-hitarea-6"></a> `hitArea?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\>) | Hit-area shape: function returning bounds or static bounds. | [`BaseShapeConfig`](#baseshapeconfig).[`hitArea`](#property-hitarea-2) | [shapes/shapeConfig.ts:88](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L88) |
|
|
22781
|
+
| <a id="property-hover-8"></a> `hover?` | ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null` | Predicate or null marking which data points are currently hovered. | [`BaseShapeConfig`](#baseshapeconfig).[`hover`](#property-hover-2) | [shapes/shapeConfig.ts:81](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L81) |
|
|
22782
|
+
| <a id="property-hoveropacity-6"></a> `hoverOpacity?` | `number` | Opacity applied to non-hovered data points. | [`BaseShapeConfig`](#baseshapeconfig).[`hoverOpacity`](#property-hoveropacity-2) | [shapes/shapeConfig.ts:83](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L83) |
|
|
22783
|
+
| <a id="property-hoverstyle-6"></a> `hoverStyle?` | `Record`\<`string`, `unknown`\> | Style overrides for hovered data points. | [`BaseShapeConfig`](#baseshapeconfig).[`hoverStyle`](#property-hoverstyle-2) | [shapes/shapeConfig.ts:85](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L85) |
|
|
22784
|
+
| <a id="property-id-7"></a> `id?` | `AccessorFn` | Unique-id accessor per datum (used for keyed enter/update/exit). | [`BaseShapeConfig`](#baseshapeconfig).[`id`](#property-id-2) | [shapes/shapeConfig.ts:93](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L93) |
|
|
22785
|
+
| <a id="property-label-8"></a> `label?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `false` \| `string`[]\> | Label text(s) per datum. False/undefined skips. | [`BaseShapeConfig`](#baseshapeconfig).[`label`](#property-label-3) | [shapes/shapeConfig.ts:95](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L95) |
|
|
22786
|
+
| <a id="property-labelbounds-6"></a> `labelBounds?` | `Record`\<`string`, `unknown`\> \| ((`d`: `DataPoint`, `i`: `number`, `aes`: `unknown`) => `Record`\<`string`, `unknown`\> \| `Record`\<`string`, `unknown`\>[]) | Label-bounds accessor (where to mount the label). | [`BaseShapeConfig`](#baseshapeconfig).[`labelBounds`](#property-labelbounds-2) | [shapes/shapeConfig.ts:97](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L97) |
|
|
22787
|
+
| <a id="property-labelconfig-6"></a> `labelConfig?` | `Record`\<`string`, `unknown`\> | Label TextBox config (font, padding, etc.). | [`BaseShapeConfig`](#baseshapeconfig).[`labelConfig`](#property-labelconfig-2) | [shapes/shapeConfig.ts:101](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L101) |
|
|
22788
|
+
| <a id="property-on-7"></a> `on?` | `Record`\<`string`, (...`args`: `unknown`[]) => `unknown`\> | Event handlers (Object.<event, handler>). | [`BaseShapeConfig`](#baseshapeconfig).[`on`](#property-on-2) | [shapes/shapeConfig.ts:159](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L159) |
|
|
22789
|
+
| <a id="property-opacity-7"></a> `opacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Overall opacity (0..1). | [`BaseShapeConfig`](#baseshapeconfig).[`opacity`](#property-opacity-2) | [shapes/shapeConfig.ts:104](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L104) |
|
|
22790
|
+
| <a id="property-pointerevents-7"></a> `pointerEvents?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `pointer-events` attribute per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`pointerEvents`](#property-pointerevents-2) | [shapes/shapeConfig.ts:106](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L106) |
|
|
22791
|
+
| <a id="property-rendermode-6"></a> `renderMode?` | `"full"` \| `"compute"` | "full" runs the DOM enter/update/exit; "compute" skips DOM. | [`BaseShapeConfig`](#baseshapeconfig).[`renderMode`](#property-rendermode-2) | [shapes/shapeConfig.ts:120](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L120) |
|
|
22792
|
+
| <a id="property-role-6"></a> `role?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | ARIA role per datum (accessibility). | [`BaseShapeConfig`](#baseshapeconfig).[`role`](#property-role-2) | [shapes/shapeConfig.ts:108](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L108) |
|
|
22793
|
+
| <a id="property-rotate-6"></a> `rotate?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Rotation in degrees per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`rotate`](#property-rotate-2) | [shapes/shapeConfig.ts:111](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L111) |
|
|
22794
|
+
| <a id="property-rx-6"></a> `rx?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `rx` (rect rounded-corner x) — applies to Rect/Bar. | [`BaseShapeConfig`](#baseshapeconfig).[`rx`](#property-rx-2) | [shapes/shapeConfig.ts:113](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L113) |
|
|
22795
|
+
| <a id="property-ry-6"></a> `ry?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `ry` (rect rounded-corner y) — applies to Rect/Bar. | [`BaseShapeConfig`](#baseshapeconfig).[`ry`](#property-ry-2) | [shapes/shapeConfig.ts:115](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L115) |
|
|
22796
|
+
| <a id="property-scale-7"></a> `scale?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Scale factor (1 = identity). | [`BaseShapeConfig`](#baseshapeconfig).[`scale`](#property-scale-3) | [shapes/shapeConfig.ts:117](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L117) |
|
|
22797
|
+
| <a id="property-select-8"></a> `select?` | `string` \| `HTMLElement` \| `SVGElement` \| `null` | Where to mount the shape's DOM (CSS selector, element, or null). | [`BaseShapeConfig`](#baseshapeconfig).[`select`](#property-select-2) | [shapes/shapeConfig.ts:122](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L122) |
|
|
22798
|
+
| <a id="property-shaperendering-6"></a> `shapeRendering?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `shape-rendering` attribute per datum. | [`BaseShapeConfig`](#baseshapeconfig).[`shapeRendering`](#property-shaperendering-2) | [shapes/shapeConfig.ts:125](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L125) |
|
|
22799
|
+
| <a id="property-sort-6"></a> `sort?` | ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null` | d3-style sort comparator. | [`BaseShapeConfig`](#baseshapeconfig).[`sort`](#property-sort-2) | [shapes/shapeConfig.ts:128](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L128) |
|
|
22800
|
+
| <a id="property-stroke-6"></a> `stroke?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Stroke color. | [`BaseShapeConfig`](#baseshapeconfig).[`stroke`](#property-stroke-2) | [shapes/shapeConfig.ts:131](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L131) |
|
|
22801
|
+
| <a id="property-strokedasharray-6"></a> `strokeDasharray?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-dasharray`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeDasharray`](#property-strokedasharray-2) | [shapes/shapeConfig.ts:133](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L133) |
|
|
22802
|
+
| <a id="property-strokelinecap-6"></a> `strokeLinecap?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `stroke-linecap`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeLinecap`](#property-strokelinecap-2) | [shapes/shapeConfig.ts:135](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L135) |
|
|
22803
|
+
| <a id="property-strokeopacity-6"></a> `strokeOpacity?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | SVG `stroke-opacity`. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeOpacity`](#property-strokeopacity-2) | [shapes/shapeConfig.ts:137](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L137) |
|
|
22804
|
+
| <a id="property-strokewidth-6"></a> `strokeWidth?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Stroke width in pixels. | [`BaseShapeConfig`](#baseshapeconfig).[`strokeWidth`](#property-strokewidth-2) | [shapes/shapeConfig.ts:139](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L139) |
|
|
22805
|
+
| <a id="property-textanchor-6"></a> `textAnchor?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `text-anchor` for labels. | [`BaseShapeConfig`](#baseshapeconfig).[`textAnchor`](#property-textanchor-2) | [shapes/shapeConfig.ts:142](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L142) |
|
|
22806
|
+
| <a id="property-texture-6"></a> `texture?` | [`ConstOrAccessor`](#constoraccessor)\<`string` \| `Record`\<`string`, `unknown`\>\> | Texture (per textures.js) — name string or full config. | [`BaseShapeConfig`](#baseshapeconfig).[`texture`](#property-texture-2) | [shapes/shapeConfig.ts:144](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L144) |
|
|
22807
|
+
| <a id="property-texturedefault-6"></a> `textureDefault?` | `Record`\<`string`, `unknown`\> | Default texture config merged into the per-datum texture. | [`BaseShapeConfig`](#baseshapeconfig).[`textureDefault`](#property-texturedefault-2) | [shapes/shapeConfig.ts:146](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L146) |
|
|
22808
|
+
| <a id="property-trail-2"></a> `trail?` | `boolean` | Sweep a tapering motion trail behind the rect as it moves between frames. | - | [shapes/shapeConfig.ts:169](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L169) |
|
|
22809
|
+
| <a id="property-trailpersist-2"></a> `trailPersist?` | `number` \| `boolean` | Steps of trail history to keep (number), or `true` for a long fading tail. | - | [shapes/shapeConfig.ts:171](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L171) |
|
|
22810
|
+
| <a id="property-vectoreffect-6"></a> `vectorEffect?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | SVG `vector-effect` (e.g. "non-scaling-stroke"). | [`BaseShapeConfig`](#baseshapeconfig).[`vectorEffect`](#property-vectoreffect-2) | [shapes/shapeConfig.ts:149](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L149) |
|
|
22811
|
+
| <a id="property-verticalalign-6"></a> `verticalAlign?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | Label vertical-align ("top"/"middle"/"bottom"). | [`BaseShapeConfig`](#baseshapeconfig).[`verticalAlign`](#property-verticalalign-2) | [shapes/shapeConfig.ts:151](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L151) |
|
|
22812
|
+
| <a id="property-width-3"></a> `width?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | - | [shapes/shapeConfig.ts:166](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L166) |
|
|
22813
|
+
| <a id="property-x-9"></a> `x?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | X position. | [`BaseShapeConfig`](#baseshapeconfig).[`x`](#property-x-2) | [shapes/shapeConfig.ts:154](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L154) |
|
|
22814
|
+
| <a id="property-y-9"></a> `y?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Y position. | [`BaseShapeConfig`](#baseshapeconfig).[`y`](#property-y-2) | [shapes/shapeConfig.ts:156](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L156) |
|
|
22722
22815
|
|
|
22723
22816
|
***
|
|
22724
22817
|
|
|
@@ -22812,7 +22905,7 @@ Defined in: [utils/D3plusConfig.ts:82](https://github.com/d3plus/d3plus/blob/mai
|
|
|
22812
22905
|
|
|
22813
22906
|
### WhiskerConfig
|
|
22814
22907
|
|
|
22815
|
-
Defined in: [shapes/shapeConfig.ts:
|
|
22908
|
+
Defined in: [shapes/shapeConfig.ts:251](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L251)
|
|
22816
22909
|
|
|
22817
22910
|
Whisker-specific config.
|
|
22818
22911
|
|
|
@@ -22824,15 +22917,15 @@ Whisker-specific config.
|
|
|
22824
22917
|
|
|
22825
22918
|
| Property | Type | Description | Defined in |
|
|
22826
22919
|
| ------ | ------ | ------ | ------ |
|
|
22827
|
-
| <a id="property-data-10"></a> `data?` | `DataPoint`[] | - | [shapes/shapeConfig.ts:
|
|
22828
|
-
| <a id="property-endpoint"></a> `endpoint?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | End-cap shape name (e.g. "Rect"). | [shapes/shapeConfig.ts:
|
|
22829
|
-
| <a id="property-endpointconfig"></a> `endpointConfig?` | `Record`\<`string`, `unknown`\> | - | [shapes/shapeConfig.ts:
|
|
22830
|
-
| <a id="property-length"></a> `length?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Whisker length in pixels. | [shapes/shapeConfig.ts:
|
|
22831
|
-
| <a id="property-lineconfig"></a> `lineConfig?` | `Record`\<`string`, `unknown`\> | - | [shapes/shapeConfig.ts:
|
|
22832
|
-
| <a id="property-orient-1"></a> `orient?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | - | [shapes/shapeConfig.ts:
|
|
22833
|
-
| <a id="property-select-9"></a> `select?` | `string` \| `HTMLElement` \| `SVGElement` \| `null` | - | [shapes/shapeConfig.ts:
|
|
22834
|
-
| <a id="property-x-11"></a> `x?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [shapes/shapeConfig.ts:
|
|
22835
|
-
| <a id="property-y-11"></a> `y?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [shapes/shapeConfig.ts:
|
|
22920
|
+
| <a id="property-data-10"></a> `data?` | `DataPoint`[] | - | [shapes/shapeConfig.ts:252](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L252) |
|
|
22921
|
+
| <a id="property-endpoint"></a> `endpoint?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | End-cap shape name (e.g. "Rect"). | [shapes/shapeConfig.ts:254](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L254) |
|
|
22922
|
+
| <a id="property-endpointconfig"></a> `endpointConfig?` | `Record`\<`string`, `unknown`\> | - | [shapes/shapeConfig.ts:255](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L255) |
|
|
22923
|
+
| <a id="property-length"></a> `length?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | Whisker length in pixels. | [shapes/shapeConfig.ts:257](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L257) |
|
|
22924
|
+
| <a id="property-lineconfig"></a> `lineConfig?` | `Record`\<`string`, `unknown`\> | - | [shapes/shapeConfig.ts:258](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L258) |
|
|
22925
|
+
| <a id="property-orient-1"></a> `orient?` | [`ConstOrAccessor`](#constoraccessor)\<`string`\> | - | [shapes/shapeConfig.ts:259](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L259) |
|
|
22926
|
+
| <a id="property-select-9"></a> `select?` | `string` \| `HTMLElement` \| `SVGElement` \| `null` | - | [shapes/shapeConfig.ts:260](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L260) |
|
|
22927
|
+
| <a id="property-x-11"></a> `x?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [shapes/shapeConfig.ts:261](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L261) |
|
|
22928
|
+
| <a id="property-y-11"></a> `y?` | [`ConstOrAccessor`](#constoraccessor)\<`number`\> | - | [shapes/shapeConfig.ts:262](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L262) |
|
|
22836
22929
|
|
|
22837
22930
|
## Type Aliases
|
|
22838
22931
|
|
|
@@ -22842,7 +22935,7 @@ Whisker-specific config.
|
|
|
22842
22935
|
|
|
22843
22936
|
> **AnyShapeConfig** = [`BaseShapeConfig`](#baseshapeconfig) \| [`RectConfig`](#rectconfig-3) \| [`CircleConfig`](#circleconfig-1) \| [`LineConfig`](#lineconfig-2) \| [`AreaConfig`](#areaconfig-1) \| [`PathConfig`](#pathconfig-1) \| [`BarConfig`](#barconfig-7) \| [`ImageConfig`](#imageconfig-1) \| [`BoxConfig`](#boxconfig-1) \| [`WhiskerConfig`](#whiskerconfig-2)
|
|
22844
22937
|
|
|
22845
|
-
Defined in: [shapes/shapeConfig.ts:
|
|
22938
|
+
Defined in: [shapes/shapeConfig.ts:272](https://github.com/d3plus/d3plus/blob/main/packages/core/src/shapes/shapeConfig.ts#L272)
|
|
22846
22939
|
|
|
22847
22940
|
Union of every shape config — useful for code that composes
|
|
22848
22941
|
transient configs at runtime without knowing the shape ahead of
|