@d3plus/core 4.2.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 +374 -296
- 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 +30 -1
- package/es/src/charts/Geomap/index.js.map +1 -1
- package/es/src/charts/Plot/index.js +77 -2
- 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/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/Shape.js +12 -10
- 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/package.json +9 -9
- package/types/src/charts/Plot/index.d.ts +22 -1
- package/types/src/charts/Plot/pipeline.d.ts +2 -1
- package/types/src/charts/viz/Viz.d.ts +31 -1
- package/types/src/charts/viz/vizTypes.d.ts +18 -0
- package/types/src/shapes/Shape.d.ts +2 -2
- package/types/src/shapes/hitAreaNode.d.ts +5 -4
- package/types/src/shapes/interactionPoints.d.ts +15 -0
- package/umd/d3plus-core.full.js +954 -275
- package/umd/d3plus-core.full.js.map +1 -1
- package/umd/d3plus-core.full.min.js +1285 -1099
- package/umd/d3plus-core.js +267 -39
- package/umd/d3plus-core.js.map +1 -1
- package/umd/d3plus-core.min.js +266 -170
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:522](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,22 +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:
|
|
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) |
|
|
1162
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) |
|
|
1163
|
-
| <a id="property-_data"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-1).[`_data`](#property-_data-15) | [shapes/Shape.ts:
|
|
1164
|
-
| <a id="property-_enter"></a> `_enter` | `Selection` | - | [`Shape`](#shape-1).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:
|
|
1165
|
-
| <a id="property-_exit"></a> `_exit` | `Selection` | - | [`Shape`](#shape-1).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:
|
|
1166
|
-
| <a id="property-_group"></a> `_group` | `Selection` | - | [`Shape`](#shape-1).[`_group`](#property-_group-13) | [shapes/Shape.ts:
|
|
1167
|
-
| <a id="property-_hovergroup"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-1).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:
|
|
1168
|
-
| <a id="property-_labelclass"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-1).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:
|
|
1169
|
-
| <a id="property-_name"></a> `_name` | `string` | - | [`Shape`](#shape-1).[`_name`](#property-_name-6) | [shapes/Shape.ts:
|
|
1170
|
-
| <a id="property-_path"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-1).[`_path`](#property-_path-6) | [shapes/Shape.ts:
|
|
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:
|
|
1172
|
-
| <a id="property-_select"></a> `_select` | `Selection` | - | [`Shape`](#shape-1).[`_select`](#property-_select-15) | [shapes/Shape.ts:
|
|
1173
|
-
| <a id="property-_tagname"></a> `_tagName` | `string` | - | [`Shape`](#shape-1).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:
|
|
1174
|
-
| <a id="property-_texturedefs"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-1).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:
|
|
1175
|
-
| <a id="property-_transition"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Bar`](#bar).[`_transition`](#property-_transition-6) | [shapes/Shape.ts:
|
|
1176
|
-
| <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) |
|
|
1177
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) |
|
|
1178
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) |
|
|
1179
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) |
|
|
@@ -5365,7 +5365,7 @@ Creates SVG areas based on an array of data.
|
|
|
5365
5365
|
|
|
5366
5366
|
> `optional` **\_dataFilter**(`data`: `DataPoint`[]): `DataPoint`[]
|
|
5367
5367
|
|
|
5368
|
-
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)
|
|
5369
5369
|
|
|
5370
5370
|
###### Parameters
|
|
5371
5371
|
|
|
@@ -5389,7 +5389,7 @@ Defined in: [shapes/Shape.ts:123](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
5389
5389
|
|
|
5390
5390
|
> **active**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
5391
5391
|
|
|
5392
|
-
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)
|
|
5393
5393
|
|
|
5394
5394
|
The active callback function for highlighting shapes.
|
|
5395
5395
|
|
|
@@ -5405,7 +5405,7 @@ The active callback function for highlighting shapes.
|
|
|
5405
5405
|
|
|
5406
5406
|
> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
5407
5407
|
|
|
5408
|
-
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)
|
|
5409
5409
|
|
|
5410
5410
|
The active callback function for highlighting shapes.
|
|
5411
5411
|
|
|
@@ -5431,7 +5431,7 @@ The active callback function for highlighting shapes.
|
|
|
5431
5431
|
|
|
5432
5432
|
> **activeStyle**(): `Record`\<`string`, `unknown`\>
|
|
5433
5433
|
|
|
5434
|
-
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)
|
|
5435
5435
|
|
|
5436
5436
|
The style to apply to active shapes.
|
|
5437
5437
|
|
|
@@ -5447,7 +5447,7 @@ The style to apply to active shapes.
|
|
|
5447
5447
|
|
|
5448
5448
|
> **activeStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
5449
5449
|
|
|
5450
|
-
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)
|
|
5451
5451
|
|
|
5452
5452
|
The style to apply to active shapes.
|
|
5453
5453
|
|
|
@@ -5519,7 +5519,7 @@ keys (e.g. `width`/`height` for Rect) in autocomplete + type checks.
|
|
|
5519
5519
|
|
|
5520
5520
|
> **data**(): `DataPoint`[]
|
|
5521
5521
|
|
|
5522
|
-
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)
|
|
5523
5523
|
|
|
5524
5524
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
5525
5525
|
|
|
@@ -5535,7 +5535,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
5535
5535
|
|
|
5536
5536
|
> **data**(`_`: `DataPoint`[]): `this`
|
|
5537
5537
|
|
|
5538
|
-
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)
|
|
5539
5539
|
|
|
5540
5540
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
5541
5541
|
|
|
@@ -5561,7 +5561,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
5561
5561
|
|
|
5562
5562
|
> **hover**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
5563
5563
|
|
|
5564
|
-
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)
|
|
5565
5565
|
|
|
5566
5566
|
The hover callback function for highlighting shapes on mouseover.
|
|
5567
5567
|
|
|
@@ -5577,7 +5577,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
5577
5577
|
|
|
5578
5578
|
> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
5579
5579
|
|
|
5580
|
-
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)
|
|
5581
5581
|
|
|
5582
5582
|
The hover callback function for highlighting shapes on mouseover.
|
|
5583
5583
|
|
|
@@ -5603,7 +5603,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
5603
5603
|
|
|
5604
5604
|
> **hoverStyle**(): `Record`\<`string`, `unknown`\>
|
|
5605
5605
|
|
|
5606
|
-
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)
|
|
5607
5607
|
|
|
5608
5608
|
The style to apply to hovered shapes.
|
|
5609
5609
|
|
|
@@ -5619,7 +5619,7 @@ The style to apply to hovered shapes.
|
|
|
5619
5619
|
|
|
5620
5620
|
> **hoverStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
5621
5621
|
|
|
5622
|
-
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)
|
|
5623
5623
|
|
|
5624
5624
|
The style to apply to hovered shapes.
|
|
5625
5625
|
|
|
@@ -5645,7 +5645,7 @@ The style to apply to hovered shapes.
|
|
|
5645
5645
|
|
|
5646
5646
|
> **labelConfig**(): `Record`\<`string`, `unknown`\>
|
|
5647
5647
|
|
|
5648
|
-
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)
|
|
5649
5649
|
|
|
5650
5650
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
5651
5651
|
|
|
@@ -5661,7 +5661,7 @@ A pass-through to the config method of the TextBox class used to create a shape'
|
|
|
5661
5661
|
|
|
5662
5662
|
> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
5663
5663
|
|
|
5664
|
-
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)
|
|
5665
5665
|
|
|
5666
5666
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
5667
5667
|
|
|
@@ -5934,7 +5934,7 @@ Parent config used by the wrapper.
|
|
|
5934
5934
|
|
|
5935
5935
|
> **render**(`callback?`: () => `void`): `this`
|
|
5936
5936
|
|
|
5937
|
-
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)
|
|
5938
5938
|
|
|
5939
5939
|
###### Parameters
|
|
5940
5940
|
|
|
@@ -5958,7 +5958,7 @@ Defined in: [shapes/Shape.ts:522](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
5958
5958
|
|
|
5959
5959
|
> **select**(): `Selection`
|
|
5960
5960
|
|
|
5961
|
-
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)
|
|
5962
5962
|
|
|
5963
5963
|
The SVG container element as a d3 selector or DOM element.
|
|
5964
5964
|
|
|
@@ -5974,7 +5974,7 @@ The SVG container element as a d3 selector or DOM element.
|
|
|
5974
5974
|
|
|
5975
5975
|
> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`
|
|
5976
5976
|
|
|
5977
|
-
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)
|
|
5978
5978
|
|
|
5979
5979
|
The SVG container element as a d3 selector or DOM element.
|
|
5980
5980
|
|
|
@@ -6042,7 +6042,7 @@ Configuration object with key/value pairs applied as method calls on each shape.
|
|
|
6042
6042
|
|
|
6043
6043
|
> **sort**(): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`
|
|
6044
6044
|
|
|
6045
|
-
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)
|
|
6046
6046
|
|
|
6047
6047
|
A comparator function used to sort shapes for layering order.
|
|
6048
6048
|
|
|
@@ -6058,7 +6058,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
6058
6058
|
|
|
6059
6059
|
> **sort**(`_`: ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`): `this`
|
|
6060
6060
|
|
|
6061
|
-
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)
|
|
6062
6062
|
|
|
6063
6063
|
A comparator function used to sort shapes for layering order.
|
|
6064
6064
|
|
|
@@ -6084,7 +6084,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
6084
6084
|
|
|
6085
6085
|
> **textureDefault**(): `Record`\<`string`, `unknown`\>
|
|
6086
6086
|
|
|
6087
|
-
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)
|
|
6088
6088
|
|
|
6089
6089
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
6090
6090
|
|
|
@@ -6100,7 +6100,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
6100
6100
|
|
|
6101
6101
|
> **textureDefault**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
6102
6102
|
|
|
6103
|
-
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)
|
|
6104
6104
|
|
|
6105
6105
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
6106
6106
|
|
|
@@ -6124,7 +6124,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
6124
6124
|
|
|
6125
6125
|
> **toScene**(): `GroupNode`
|
|
6126
6126
|
|
|
6127
|
-
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)
|
|
6128
6128
|
|
|
6129
6129
|
Produces a backend-agnostic scene graph for this shape's data, reusing the
|
|
6130
6130
|
same accessors render() applies to the DOM. This is the migration seam toward
|
|
@@ -6336,22 +6336,22 @@ The y1 (bottom edge) position accessor for each bar.
|
|
|
6336
6336
|
|
|
6337
6337
|
| Property | Type | Description | Inherited from | Defined in |
|
|
6338
6338
|
| ------ | ------ | ------ | ------ | ------ |
|
|
6339
|
-
| <a id="property-_activegroup-1"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-1).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:
|
|
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) |
|
|
6340
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) |
|
|
6341
|
-
| <a id="property-_data-6"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-1).[`_data`](#property-_data-15) | [shapes/Shape.ts:
|
|
6342
|
-
| <a id="property-_enter-1"></a> `_enter` | `Selection` | - | [`Shape`](#shape-1).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:
|
|
6343
|
-
| <a id="property-_exit-1"></a> `_exit` | `Selection` | - | [`Shape`](#shape-1).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:
|
|
6344
|
-
| <a id="property-_group-6"></a> `_group` | `Selection` | - | [`Shape`](#shape-1).[`_group`](#property-_group-13) | [shapes/Shape.ts:
|
|
6345
|
-
| <a id="property-_hovergroup-1"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-1).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:
|
|
6346
|
-
| <a id="property-_labelclass-1"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-1).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:
|
|
6347
|
-
| <a id="property-_name-1"></a> `_name` | `string` | - | [`Shape`](#shape-1).[`_name`](#property-_name-6) | [shapes/Shape.ts:
|
|
6348
|
-
| <a id="property-_path-1"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-1).[`_path`](#property-_path-6) | [shapes/Shape.ts:
|
|
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:
|
|
6350
|
-
| <a id="property-_select-6"></a> `_select` | `Selection` | - | [`Shape`](#shape-1).[`_select`](#property-_select-15) | [shapes/Shape.ts:
|
|
6351
|
-
| <a id="property-_tagname-1"></a> `_tagName` | `string` | - | [`Shape`](#shape-1).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:
|
|
6352
|
-
| <a id="property-_texturedefs-1"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-1).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:
|
|
6353
|
-
| <a id="property-_transition-6"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-1).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:
|
|
6354
|
-
| <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) |
|
|
6355
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) |
|
|
6356
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) |
|
|
6357
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) |
|
|
@@ -7455,7 +7455,7 @@ Creates SVG circles based on an array of data.
|
|
|
7455
7455
|
|
|
7456
7456
|
> `optional` **\_dataFilter**(`data`: `DataPoint`[]): `DataPoint`[]
|
|
7457
7457
|
|
|
7458
|
-
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)
|
|
7459
7459
|
|
|
7460
7460
|
###### Parameters
|
|
7461
7461
|
|
|
@@ -7479,7 +7479,7 @@ Defined in: [shapes/Shape.ts:123](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
7479
7479
|
|
|
7480
7480
|
> **active**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
7481
7481
|
|
|
7482
|
-
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)
|
|
7483
7483
|
|
|
7484
7484
|
The active callback function for highlighting shapes.
|
|
7485
7485
|
|
|
@@ -7495,7 +7495,7 @@ The active callback function for highlighting shapes.
|
|
|
7495
7495
|
|
|
7496
7496
|
> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
7497
7497
|
|
|
7498
|
-
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)
|
|
7499
7499
|
|
|
7500
7500
|
The active callback function for highlighting shapes.
|
|
7501
7501
|
|
|
@@ -7521,7 +7521,7 @@ The active callback function for highlighting shapes.
|
|
|
7521
7521
|
|
|
7522
7522
|
> **activeStyle**(): `Record`\<`string`, `unknown`\>
|
|
7523
7523
|
|
|
7524
|
-
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)
|
|
7525
7525
|
|
|
7526
7526
|
The style to apply to active shapes.
|
|
7527
7527
|
|
|
@@ -7537,7 +7537,7 @@ The style to apply to active shapes.
|
|
|
7537
7537
|
|
|
7538
7538
|
> **activeStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
7539
7539
|
|
|
7540
|
-
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)
|
|
7541
7541
|
|
|
7542
7542
|
The style to apply to active shapes.
|
|
7543
7543
|
|
|
@@ -7609,7 +7609,7 @@ keys (e.g. `width`/`height` for Rect) in autocomplete + type checks.
|
|
|
7609
7609
|
|
|
7610
7610
|
> **data**(): `DataPoint`[]
|
|
7611
7611
|
|
|
7612
|
-
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)
|
|
7613
7613
|
|
|
7614
7614
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
7615
7615
|
|
|
@@ -7625,7 +7625,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
7625
7625
|
|
|
7626
7626
|
> **data**(`_`: `DataPoint`[]): `this`
|
|
7627
7627
|
|
|
7628
|
-
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)
|
|
7629
7629
|
|
|
7630
7630
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
7631
7631
|
|
|
@@ -7651,7 +7651,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
7651
7651
|
|
|
7652
7652
|
> **hover**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
7653
7653
|
|
|
7654
|
-
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)
|
|
7655
7655
|
|
|
7656
7656
|
The hover callback function for highlighting shapes on mouseover.
|
|
7657
7657
|
|
|
@@ -7667,7 +7667,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
7667
7667
|
|
|
7668
7668
|
> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
7669
7669
|
|
|
7670
|
-
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)
|
|
7671
7671
|
|
|
7672
7672
|
The hover callback function for highlighting shapes on mouseover.
|
|
7673
7673
|
|
|
@@ -7693,7 +7693,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
7693
7693
|
|
|
7694
7694
|
> **hoverStyle**(): `Record`\<`string`, `unknown`\>
|
|
7695
7695
|
|
|
7696
|
-
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)
|
|
7697
7697
|
|
|
7698
7698
|
The style to apply to hovered shapes.
|
|
7699
7699
|
|
|
@@ -7709,7 +7709,7 @@ The style to apply to hovered shapes.
|
|
|
7709
7709
|
|
|
7710
7710
|
> **hoverStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
7711
7711
|
|
|
7712
|
-
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)
|
|
7713
7713
|
|
|
7714
7714
|
The style to apply to hovered shapes.
|
|
7715
7715
|
|
|
@@ -7735,7 +7735,7 @@ The style to apply to hovered shapes.
|
|
|
7735
7735
|
|
|
7736
7736
|
> **labelConfig**(): `Record`\<`string`, `unknown`\>
|
|
7737
7737
|
|
|
7738
|
-
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)
|
|
7739
7739
|
|
|
7740
7740
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
7741
7741
|
|
|
@@ -7751,7 +7751,7 @@ A pass-through to the config method of the TextBox class used to create a shape'
|
|
|
7751
7751
|
|
|
7752
7752
|
> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
7753
7753
|
|
|
7754
|
-
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)
|
|
7755
7755
|
|
|
7756
7756
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
7757
7757
|
|
|
@@ -8024,7 +8024,7 @@ Parent config used by the wrapper.
|
|
|
8024
8024
|
|
|
8025
8025
|
> **render**(`callback?`: () => `void`): `this`
|
|
8026
8026
|
|
|
8027
|
-
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)
|
|
8028
8028
|
|
|
8029
8029
|
###### Parameters
|
|
8030
8030
|
|
|
@@ -8048,7 +8048,7 @@ Defined in: [shapes/Shape.ts:522](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
8048
8048
|
|
|
8049
8049
|
> **select**(): `Selection`
|
|
8050
8050
|
|
|
8051
|
-
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)
|
|
8052
8052
|
|
|
8053
8053
|
The SVG container element as a d3 selector or DOM element.
|
|
8054
8054
|
|
|
@@ -8064,7 +8064,7 @@ The SVG container element as a d3 selector or DOM element.
|
|
|
8064
8064
|
|
|
8065
8065
|
> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`
|
|
8066
8066
|
|
|
8067
|
-
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)
|
|
8068
8068
|
|
|
8069
8069
|
The SVG container element as a d3 selector or DOM element.
|
|
8070
8070
|
|
|
@@ -8132,7 +8132,7 @@ Configuration object with key/value pairs applied as method calls on each shape.
|
|
|
8132
8132
|
|
|
8133
8133
|
> **sort**(): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`
|
|
8134
8134
|
|
|
8135
|
-
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)
|
|
8136
8136
|
|
|
8137
8137
|
A comparator function used to sort shapes for layering order.
|
|
8138
8138
|
|
|
@@ -8148,7 +8148,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
8148
8148
|
|
|
8149
8149
|
> **sort**(`_`: ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`): `this`
|
|
8150
8150
|
|
|
8151
|
-
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)
|
|
8152
8152
|
|
|
8153
8153
|
A comparator function used to sort shapes for layering order.
|
|
8154
8154
|
|
|
@@ -8174,7 +8174,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
8174
8174
|
|
|
8175
8175
|
> **textureDefault**(): `Record`\<`string`, `unknown`\>
|
|
8176
8176
|
|
|
8177
|
-
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)
|
|
8178
8178
|
|
|
8179
8179
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
8180
8180
|
|
|
@@ -8190,7 +8190,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
8190
8190
|
|
|
8191
8191
|
> **textureDefault**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
8192
8192
|
|
|
8193
|
-
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)
|
|
8194
8194
|
|
|
8195
8195
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
8196
8196
|
|
|
@@ -8214,7 +8214,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
8214
8214
|
|
|
8215
8215
|
> **toScene**(): `GroupNode`
|
|
8216
8216
|
|
|
8217
|
-
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)
|
|
8218
8218
|
|
|
8219
8219
|
Produces a backend-agnostic scene graph for this shape's data, reusing the
|
|
8220
8220
|
same accessors render() applies to the DOM. This is the migration seam toward
|
|
@@ -8290,22 +8290,22 @@ return d === "Back" ? "Get outta here" : d;
|
|
|
8290
8290
|
|
|
8291
8291
|
| Property | Type | Description | Inherited from | Defined in |
|
|
8292
8292
|
| ------ | ------ | ------ | ------ | ------ |
|
|
8293
|
-
| <a id="property-_activegroup-2"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-1).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:
|
|
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) |
|
|
8294
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) |
|
|
8295
|
-
| <a id="property-_data-8"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-1).[`_data`](#property-_data-15) | [shapes/Shape.ts:
|
|
8296
|
-
| <a id="property-_enter-2"></a> `_enter` | `Selection` | - | [`Shape`](#shape-1).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:
|
|
8297
|
-
| <a id="property-_exit-2"></a> `_exit` | `Selection` | - | [`Shape`](#shape-1).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:
|
|
8298
|
-
| <a id="property-_group-7"></a> `_group` | `Selection` | - | [`Shape`](#shape-1).[`_group`](#property-_group-13) | [shapes/Shape.ts:
|
|
8299
|
-
| <a id="property-_hovergroup-2"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-1).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:
|
|
8300
|
-
| <a id="property-_labelclass-2"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-1).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:
|
|
8301
|
-
| <a id="property-_name-2"></a> `_name` | `string` | - | [`Shape`](#shape-1).[`_name`](#property-_name-6) | [shapes/Shape.ts:
|
|
8302
|
-
| <a id="property-_path-2"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-1).[`_path`](#property-_path-6) | [shapes/Shape.ts:
|
|
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:
|
|
8304
|
-
| <a id="property-_select-8"></a> `_select` | `Selection` | - | [`Shape`](#shape-1).[`_select`](#property-_select-15) | [shapes/Shape.ts:
|
|
8305
|
-
| <a id="property-_tagname-2"></a> `_tagName` | `string` | - | [`Shape`](#shape-1).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:
|
|
8306
|
-
| <a id="property-_texturedefs-2"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-1).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:
|
|
8307
|
-
| <a id="property-_transition-7"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-1).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:
|
|
8308
|
-
| <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) |
|
|
8309
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) |
|
|
8310
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) |
|
|
8311
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) |
|
|
@@ -9933,7 +9933,7 @@ Creates SVG lines based on an array of data.
|
|
|
9933
9933
|
|
|
9934
9934
|
> **active**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
9935
9935
|
|
|
9936
|
-
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)
|
|
9937
9937
|
|
|
9938
9938
|
The active callback function for highlighting shapes.
|
|
9939
9939
|
|
|
@@ -9949,7 +9949,7 @@ The active callback function for highlighting shapes.
|
|
|
9949
9949
|
|
|
9950
9950
|
> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
9951
9951
|
|
|
9952
|
-
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)
|
|
9953
9953
|
|
|
9954
9954
|
The active callback function for highlighting shapes.
|
|
9955
9955
|
|
|
@@ -9975,7 +9975,7 @@ The active callback function for highlighting shapes.
|
|
|
9975
9975
|
|
|
9976
9976
|
> **activeStyle**(): `Record`\<`string`, `unknown`\>
|
|
9977
9977
|
|
|
9978
|
-
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)
|
|
9979
9979
|
|
|
9980
9980
|
The style to apply to active shapes.
|
|
9981
9981
|
|
|
@@ -9991,7 +9991,7 @@ The style to apply to active shapes.
|
|
|
9991
9991
|
|
|
9992
9992
|
> **activeStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
9993
9993
|
|
|
9994
|
-
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)
|
|
9995
9995
|
|
|
9996
9996
|
The style to apply to active shapes.
|
|
9997
9997
|
|
|
@@ -10063,7 +10063,7 @@ keys (e.g. `width`/`height` for Rect) in autocomplete + type checks.
|
|
|
10063
10063
|
|
|
10064
10064
|
> **data**(): `DataPoint`[]
|
|
10065
10065
|
|
|
10066
|
-
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)
|
|
10067
10067
|
|
|
10068
10068
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
10069
10069
|
|
|
@@ -10079,7 +10079,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
10079
10079
|
|
|
10080
10080
|
> **data**(`_`: `DataPoint`[]): `this`
|
|
10081
10081
|
|
|
10082
|
-
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)
|
|
10083
10083
|
|
|
10084
10084
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
10085
10085
|
|
|
@@ -10105,7 +10105,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
10105
10105
|
|
|
10106
10106
|
> **hover**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
10107
10107
|
|
|
10108
|
-
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)
|
|
10109
10109
|
|
|
10110
10110
|
The hover callback function for highlighting shapes on mouseover.
|
|
10111
10111
|
|
|
@@ -10121,7 +10121,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
10121
10121
|
|
|
10122
10122
|
> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
10123
10123
|
|
|
10124
|
-
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)
|
|
10125
10125
|
|
|
10126
10126
|
The hover callback function for highlighting shapes on mouseover.
|
|
10127
10127
|
|
|
@@ -10147,7 +10147,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
10147
10147
|
|
|
10148
10148
|
> **hoverStyle**(): `Record`\<`string`, `unknown`\>
|
|
10149
10149
|
|
|
10150
|
-
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)
|
|
10151
10151
|
|
|
10152
10152
|
The style to apply to hovered shapes.
|
|
10153
10153
|
|
|
@@ -10163,7 +10163,7 @@ The style to apply to hovered shapes.
|
|
|
10163
10163
|
|
|
10164
10164
|
> **hoverStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
10165
10165
|
|
|
10166
|
-
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)
|
|
10167
10167
|
|
|
10168
10168
|
The style to apply to hovered shapes.
|
|
10169
10169
|
|
|
@@ -10189,7 +10189,7 @@ The style to apply to hovered shapes.
|
|
|
10189
10189
|
|
|
10190
10190
|
> **labelConfig**(): `Record`\<`string`, `unknown`\>
|
|
10191
10191
|
|
|
10192
|
-
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)
|
|
10193
10193
|
|
|
10194
10194
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
10195
10195
|
|
|
@@ -10205,7 +10205,7 @@ A pass-through to the config method of the TextBox class used to create a shape'
|
|
|
10205
10205
|
|
|
10206
10206
|
> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
10207
10207
|
|
|
10208
|
-
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)
|
|
10209
10209
|
|
|
10210
10210
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
10211
10211
|
|
|
@@ -10478,7 +10478,7 @@ Parent config used by the wrapper.
|
|
|
10478
10478
|
|
|
10479
10479
|
> **render**(`callback?`: () => `void`): `this`
|
|
10480
10480
|
|
|
10481
|
-
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)
|
|
10482
10482
|
|
|
10483
10483
|
###### Parameters
|
|
10484
10484
|
|
|
@@ -10502,7 +10502,7 @@ Defined in: [shapes/Shape.ts:522](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
10502
10502
|
|
|
10503
10503
|
> **select**(): `Selection`
|
|
10504
10504
|
|
|
10505
|
-
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)
|
|
10506
10506
|
|
|
10507
10507
|
The SVG container element as a d3 selector or DOM element.
|
|
10508
10508
|
|
|
@@ -10518,7 +10518,7 @@ The SVG container element as a d3 selector or DOM element.
|
|
|
10518
10518
|
|
|
10519
10519
|
> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`
|
|
10520
10520
|
|
|
10521
|
-
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)
|
|
10522
10522
|
|
|
10523
10523
|
The SVG container element as a d3 selector or DOM element.
|
|
10524
10524
|
|
|
@@ -10586,7 +10586,7 @@ Configuration object with key/value pairs applied as method calls on each shape.
|
|
|
10586
10586
|
|
|
10587
10587
|
> **sort**(): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`
|
|
10588
10588
|
|
|
10589
|
-
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)
|
|
10590
10590
|
|
|
10591
10591
|
A comparator function used to sort shapes for layering order.
|
|
10592
10592
|
|
|
@@ -10602,7 +10602,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
10602
10602
|
|
|
10603
10603
|
> **sort**(`_`: ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`): `this`
|
|
10604
10604
|
|
|
10605
|
-
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)
|
|
10606
10606
|
|
|
10607
10607
|
A comparator function used to sort shapes for layering order.
|
|
10608
10608
|
|
|
@@ -10628,7 +10628,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
10628
10628
|
|
|
10629
10629
|
> **textureDefault**(): `Record`\<`string`, `unknown`\>
|
|
10630
10630
|
|
|
10631
|
-
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)
|
|
10632
10632
|
|
|
10633
10633
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
10634
10634
|
|
|
@@ -10644,7 +10644,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
10644
10644
|
|
|
10645
10645
|
> **textureDefault**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
10646
10646
|
|
|
10647
|
-
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)
|
|
10648
10648
|
|
|
10649
10649
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
10650
10650
|
|
|
@@ -10668,7 +10668,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
10668
10668
|
|
|
10669
10669
|
> **toScene**(): `GroupNode`
|
|
10670
10670
|
|
|
10671
|
-
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)
|
|
10672
10672
|
|
|
10673
10673
|
Produces a backend-agnostic scene graph for this shape's data, reusing the
|
|
10674
10674
|
same accessors render() applies to the DOM. This is the migration seam toward
|
|
@@ -10744,22 +10744,22 @@ return d === "Back" ? "Get outta here" : d;
|
|
|
10744
10744
|
|
|
10745
10745
|
| Property | Type | Description | Inherited from | Defined in |
|
|
10746
10746
|
| ------ | ------ | ------ | ------ | ------ |
|
|
10747
|
-
| <a id="property-_activegroup-3"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-1).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:
|
|
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) |
|
|
10748
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) |
|
|
10749
|
-
| <a id="property-_data-12"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-1).[`_data`](#property-_data-15) | [shapes/Shape.ts:
|
|
10750
|
-
| <a id="property-_enter-3"></a> `_enter` | `Selection` | - | [`Shape`](#shape-1).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:
|
|
10751
|
-
| <a id="property-_exit-3"></a> `_exit` | `Selection` | - | [`Shape`](#shape-1).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:
|
|
10752
|
-
| <a id="property-_group-10"></a> `_group` | `Selection` | - | [`Shape`](#shape-1).[`_group`](#property-_group-13) | [shapes/Shape.ts:
|
|
10753
|
-
| <a id="property-_hovergroup-3"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-1).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:
|
|
10754
|
-
| <a id="property-_labelclass-4"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-1).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:
|
|
10755
|
-
| <a id="property-_name-3"></a> `_name` | `string` | - | [`Shape`](#shape-1).[`_name`](#property-_name-6) | [shapes/Shape.ts:
|
|
10756
|
-
| <a id="property-_path-3"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-1).[`_path`](#property-_path-6) | [shapes/Shape.ts:
|
|
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:
|
|
10758
|
-
| <a id="property-_select-12"></a> `_select` | `Selection` | - | [`Shape`](#shape-1).[`_select`](#property-_select-15) | [shapes/Shape.ts:
|
|
10759
|
-
| <a id="property-_tagname-3"></a> `_tagName` | `string` | - | [`Shape`](#shape-1).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:
|
|
10760
|
-
| <a id="property-_texturedefs-3"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-1).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:
|
|
10761
|
-
| <a id="property-_transition-8"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-1).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:
|
|
10762
|
-
| <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) |
|
|
10763
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) |
|
|
10764
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) |
|
|
10765
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) |
|
|
@@ -10790,7 +10790,7 @@ Creates SVG Paths based on an array of data.
|
|
|
10790
10790
|
|
|
10791
10791
|
> `optional` **\_dataFilter**(`data`: `DataPoint`[]): `DataPoint`[]
|
|
10792
10792
|
|
|
10793
|
-
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)
|
|
10794
10794
|
|
|
10795
10795
|
###### Parameters
|
|
10796
10796
|
|
|
@@ -10814,7 +10814,7 @@ Defined in: [shapes/Shape.ts:123](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
10814
10814
|
|
|
10815
10815
|
> **active**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
10816
10816
|
|
|
10817
|
-
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)
|
|
10818
10818
|
|
|
10819
10819
|
The active callback function for highlighting shapes.
|
|
10820
10820
|
|
|
@@ -10830,7 +10830,7 @@ The active callback function for highlighting shapes.
|
|
|
10830
10830
|
|
|
10831
10831
|
> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
10832
10832
|
|
|
10833
|
-
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)
|
|
10834
10834
|
|
|
10835
10835
|
The active callback function for highlighting shapes.
|
|
10836
10836
|
|
|
@@ -10856,7 +10856,7 @@ The active callback function for highlighting shapes.
|
|
|
10856
10856
|
|
|
10857
10857
|
> **activeStyle**(): `Record`\<`string`, `unknown`\>
|
|
10858
10858
|
|
|
10859
|
-
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)
|
|
10860
10860
|
|
|
10861
10861
|
The style to apply to active shapes.
|
|
10862
10862
|
|
|
@@ -10872,7 +10872,7 @@ The style to apply to active shapes.
|
|
|
10872
10872
|
|
|
10873
10873
|
> **activeStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
10874
10874
|
|
|
10875
|
-
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)
|
|
10876
10876
|
|
|
10877
10877
|
The style to apply to active shapes.
|
|
10878
10878
|
|
|
@@ -10944,7 +10944,7 @@ keys (e.g. `width`/`height` for Rect) in autocomplete + type checks.
|
|
|
10944
10944
|
|
|
10945
10945
|
> **data**(): `DataPoint`[]
|
|
10946
10946
|
|
|
10947
|
-
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)
|
|
10948
10948
|
|
|
10949
10949
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
10950
10950
|
|
|
@@ -10960,7 +10960,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
10960
10960
|
|
|
10961
10961
|
> **data**(`_`: `DataPoint`[]): `this`
|
|
10962
10962
|
|
|
10963
|
-
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)
|
|
10964
10964
|
|
|
10965
10965
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
10966
10966
|
|
|
@@ -10986,7 +10986,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
10986
10986
|
|
|
10987
10987
|
> **hover**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
10988
10988
|
|
|
10989
|
-
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)
|
|
10990
10990
|
|
|
10991
10991
|
The hover callback function for highlighting shapes on mouseover.
|
|
10992
10992
|
|
|
@@ -11002,7 +11002,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
11002
11002
|
|
|
11003
11003
|
> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
11004
11004
|
|
|
11005
|
-
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)
|
|
11006
11006
|
|
|
11007
11007
|
The hover callback function for highlighting shapes on mouseover.
|
|
11008
11008
|
|
|
@@ -11028,7 +11028,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
11028
11028
|
|
|
11029
11029
|
> **hoverStyle**(): `Record`\<`string`, `unknown`\>
|
|
11030
11030
|
|
|
11031
|
-
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)
|
|
11032
11032
|
|
|
11033
11033
|
The style to apply to hovered shapes.
|
|
11034
11034
|
|
|
@@ -11044,7 +11044,7 @@ The style to apply to hovered shapes.
|
|
|
11044
11044
|
|
|
11045
11045
|
> **hoverStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
11046
11046
|
|
|
11047
|
-
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)
|
|
11048
11048
|
|
|
11049
11049
|
The style to apply to hovered shapes.
|
|
11050
11050
|
|
|
@@ -11070,7 +11070,7 @@ The style to apply to hovered shapes.
|
|
|
11070
11070
|
|
|
11071
11071
|
> **labelConfig**(): `Record`\<`string`, `unknown`\>
|
|
11072
11072
|
|
|
11073
|
-
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)
|
|
11074
11074
|
|
|
11075
11075
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
11076
11076
|
|
|
@@ -11086,7 +11086,7 @@ A pass-through to the config method of the TextBox class used to create a shape'
|
|
|
11086
11086
|
|
|
11087
11087
|
> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
11088
11088
|
|
|
11089
|
-
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)
|
|
11090
11090
|
|
|
11091
11091
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
11092
11092
|
|
|
@@ -11359,7 +11359,7 @@ Parent config used by the wrapper.
|
|
|
11359
11359
|
|
|
11360
11360
|
> **render**(`callback?`: () => `void`): `this`
|
|
11361
11361
|
|
|
11362
|
-
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)
|
|
11363
11363
|
|
|
11364
11364
|
###### Parameters
|
|
11365
11365
|
|
|
@@ -11383,7 +11383,7 @@ Defined in: [shapes/Shape.ts:522](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
11383
11383
|
|
|
11384
11384
|
> **select**(): `Selection`
|
|
11385
11385
|
|
|
11386
|
-
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)
|
|
11387
11387
|
|
|
11388
11388
|
The SVG container element as a d3 selector or DOM element.
|
|
11389
11389
|
|
|
@@ -11399,7 +11399,7 @@ The SVG container element as a d3 selector or DOM element.
|
|
|
11399
11399
|
|
|
11400
11400
|
> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`
|
|
11401
11401
|
|
|
11402
|
-
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)
|
|
11403
11403
|
|
|
11404
11404
|
The SVG container element as a d3 selector or DOM element.
|
|
11405
11405
|
|
|
@@ -11467,7 +11467,7 @@ Configuration object with key/value pairs applied as method calls on each shape.
|
|
|
11467
11467
|
|
|
11468
11468
|
> **sort**(): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`
|
|
11469
11469
|
|
|
11470
|
-
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)
|
|
11471
11471
|
|
|
11472
11472
|
A comparator function used to sort shapes for layering order.
|
|
11473
11473
|
|
|
@@ -11483,7 +11483,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
11483
11483
|
|
|
11484
11484
|
> **sort**(`_`: ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`): `this`
|
|
11485
11485
|
|
|
11486
|
-
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)
|
|
11487
11487
|
|
|
11488
11488
|
A comparator function used to sort shapes for layering order.
|
|
11489
11489
|
|
|
@@ -11509,7 +11509,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
11509
11509
|
|
|
11510
11510
|
> **textureDefault**(): `Record`\<`string`, `unknown`\>
|
|
11511
11511
|
|
|
11512
|
-
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)
|
|
11513
11513
|
|
|
11514
11514
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
11515
11515
|
|
|
@@ -11525,7 +11525,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
11525
11525
|
|
|
11526
11526
|
> **textureDefault**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
11527
11527
|
|
|
11528
|
-
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)
|
|
11529
11529
|
|
|
11530
11530
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
11531
11531
|
|
|
@@ -11549,7 +11549,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
11549
11549
|
|
|
11550
11550
|
> **toScene**(): `GroupNode`
|
|
11551
11551
|
|
|
11552
|
-
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)
|
|
11553
11553
|
|
|
11554
11554
|
Produces a backend-agnostic scene graph for this shape's data, reusing the
|
|
11555
11555
|
same accessors render() applies to the DOM. This is the migration seam toward
|
|
@@ -11625,22 +11625,22 @@ return d === "Back" ? "Get outta here" : d;
|
|
|
11625
11625
|
|
|
11626
11626
|
| Property | Type | Description | Inherited from | Defined in |
|
|
11627
11627
|
| ------ | ------ | ------ | ------ | ------ |
|
|
11628
|
-
| <a id="property-_activegroup-4"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-1).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:
|
|
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) |
|
|
11629
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) |
|
|
11630
|
-
| <a id="property-_data-13"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-1).[`_data`](#property-_data-15) | [shapes/Shape.ts:
|
|
11631
|
-
| <a id="property-_enter-4"></a> `_enter` | `Selection` | - | [`Shape`](#shape-1).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:
|
|
11632
|
-
| <a id="property-_exit-4"></a> `_exit` | `Selection` | - | [`Shape`](#shape-1).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:
|
|
11633
|
-
| <a id="property-_group-11"></a> `_group` | `Selection` | - | [`Shape`](#shape-1).[`_group`](#property-_group-13) | [shapes/Shape.ts:
|
|
11634
|
-
| <a id="property-_hovergroup-4"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-1).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:
|
|
11635
|
-
| <a id="property-_labelclass-5"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-1).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:
|
|
11636
|
-
| <a id="property-_name-4"></a> `_name` | `string` | - | [`Shape`](#shape-1).[`_name`](#property-_name-6) | [shapes/Shape.ts:
|
|
11637
|
-
| <a id="property-_path-4"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-1).[`_path`](#property-_path-6) | [shapes/Shape.ts:
|
|
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:
|
|
11639
|
-
| <a id="property-_select-13"></a> `_select` | `Selection` | - | [`Shape`](#shape-1).[`_select`](#property-_select-15) | [shapes/Shape.ts:
|
|
11640
|
-
| <a id="property-_tagname-4"></a> `_tagName` | `string` | - | [`Shape`](#shape-1).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:
|
|
11641
|
-
| <a id="property-_texturedefs-4"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-1).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:
|
|
11642
|
-
| <a id="property-_transition-9"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-1).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:
|
|
11643
|
-
| <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) |
|
|
11644
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) |
|
|
11645
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) |
|
|
11646
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) |
|
|
@@ -11671,7 +11671,7 @@ Creates an x/y plot based on an array of data.
|
|
|
11671
11671
|
|
|
11672
11672
|
> **\_drawSceneToTarget**(`durationOverride?`: `number`): `void`
|
|
11673
11673
|
|
|
11674
|
-
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)
|
|
11675
11675
|
|
|
11676
11676
|
Renders this chart through the @d3plus/render pluggable backends. Called
|
|
11677
11677
|
automatically by `render()`. The compute pass draws into `this._select`
|
|
@@ -11700,7 +11700,7 @@ svg's children get cleared so only the scene output is visible.
|
|
|
11700
11700
|
|
|
11701
11701
|
> **\_paint**(`pCtx`: `PlotPaintContext`): [`Plot`](#plot)
|
|
11702
11702
|
|
|
11703
|
-
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)
|
|
11704
11704
|
|
|
11705
11705
|
Paint phase: production axis rendering, shape buffer setup, and shape
|
|
11706
11706
|
emission with event handlers. Receives all cross-phase locals from
|
|
@@ -11723,7 +11723,7 @@ scope beyond the explicit context).
|
|
|
11723
11723
|
|
|
11724
11724
|
> **\_scheduleSceneRepaint**(): `void`
|
|
11725
11725
|
|
|
11726
|
-
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)
|
|
11727
11727
|
|
|
11728
11728
|
Coalesces interaction-driven scene repaints (hover/active dimming) into a
|
|
11729
11729
|
single paint per animation frame. A fast pointer sweep across a dense
|
|
@@ -11747,7 +11747,7 @@ intermediate paints are wasted — collapse them to one rAF-scheduled draw.
|
|
|
11747
11747
|
|
|
11748
11748
|
> **\_wirePlotShapeEvents**(`shape`: `object`, `shapeKey`: `string`, `events`: `string`[]): `void`
|
|
11749
11749
|
|
|
11750
|
-
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)
|
|
11751
11751
|
|
|
11752
11752
|
Wires user-registered `on()` event handlers onto a freshly-configured
|
|
11753
11753
|
shape instance. Splits the registered events into three buckets:
|
|
@@ -11831,7 +11831,7 @@ Custom aggregation methods for each data key.
|
|
|
11831
11831
|
|
|
11832
11832
|
> **annotations**(`_?`: `unknown`): [`Plot`](#plot) \| `unknown`[]
|
|
11833
11833
|
|
|
11834
|
-
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)
|
|
11835
11835
|
|
|
11836
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).
|
|
11837
11837
|
|
|
@@ -11901,7 +11901,7 @@ Configuration object for the attribution style.
|
|
|
11901
11901
|
|
|
11902
11902
|
> **axisPersist**(`_?`: `boolean`): `boolean` \| [`Plot`](#plot)
|
|
11903
11903
|
|
|
11904
|
-
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)
|
|
11905
11905
|
|
|
11906
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).
|
|
11907
11907
|
|
|
@@ -11945,7 +11945,7 @@ Configuration object for the back button.
|
|
|
11945
11945
|
|
|
11946
11946
|
> **backgroundConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
11947
11947
|
|
|
11948
|
-
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)
|
|
11949
11949
|
|
|
11950
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).
|
|
11951
11951
|
|
|
@@ -11965,7 +11965,7 @@ A d3plus-shape configuration Object used for styling the background rectangle of
|
|
|
11965
11965
|
|
|
11966
11966
|
> **buffer**(`_?`: `boolean` \| `Record`\<`string`, `boolean`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
11967
11967
|
|
|
11968
|
-
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)
|
|
11969
11969
|
|
|
11970
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}`).
|
|
11971
11971
|
|
|
@@ -12129,7 +12129,7 @@ Defines which side of the visualization to anchor the color scale. Acceptable va
|
|
|
12129
12129
|
|
|
12130
12130
|
> **confidence**(`_?`: `unknown`): `false` \| [`Plot`](#plot) \| \[`number`, `number`\]
|
|
12131
12131
|
|
|
12132
|
-
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)
|
|
12133
12133
|
|
|
12134
12134
|
The confidence interval as an array of [lower, upper] bounds.
|
|
12135
12135
|
|
|
@@ -12161,7 +12161,7 @@ var data = {id: "alpha", value: 10, lci: 9, hci: 11};
|
|
|
12161
12161
|
|
|
12162
12162
|
> **confidenceConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
12163
12163
|
|
|
12164
|
-
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)
|
|
12165
12165
|
|
|
12166
12166
|
Configuration object for shapes rendered as confidence intervals.
|
|
12167
12167
|
|
|
@@ -12256,7 +12256,7 @@ Defaults to an empty array (`[]`).
|
|
|
12256
12256
|
|
|
12257
12257
|
> **destroy**(): `this`
|
|
12258
12258
|
|
|
12259
|
-
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)
|
|
12260
12260
|
|
|
12261
12261
|
Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.
|
|
12262
12262
|
|
|
@@ -12370,7 +12370,7 @@ The interval, in milliseconds, for checking if the visualization is visible on t
|
|
|
12370
12370
|
|
|
12371
12371
|
> **discreteCutoff**(`_?`: `number`): `number` \| [`Plot`](#plot)
|
|
12372
12372
|
|
|
12373
|
-
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)
|
|
12374
12374
|
|
|
12375
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.
|
|
12376
12376
|
|
|
@@ -12510,7 +12510,7 @@ Defines the mapping between data and shape. The value can be a String matching a
|
|
|
12510
12510
|
|
|
12511
12511
|
> **groupPadding**(`_?`: `number`): `number` \| [`Plot`](#plot)
|
|
12512
12512
|
|
|
12513
|
-
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)
|
|
12514
12514
|
|
|
12515
12515
|
The pixel space between groups of bars.
|
|
12516
12516
|
|
|
@@ -12654,7 +12654,7 @@ Accessor function or string key for the label of each data point.
|
|
|
12654
12654
|
|
|
12655
12655
|
> **labelConnectorConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
12656
12656
|
|
|
12657
|
-
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)
|
|
12658
12658
|
|
|
12659
12659
|
The d3plus-shape config used on the Line shapes created to connect lineLabels to the end of their associated Line path.
|
|
12660
12660
|
|
|
@@ -12674,7 +12674,7 @@ The d3plus-shape config used on the Line shapes created to connect lineLabels to
|
|
|
12674
12674
|
|
|
12675
12675
|
> **labelPosition**(`_?`: `string` \| ((`d`: `DataPoint`, `i`: `number`) => `string`)): [`Plot`](#plot) \| ((`d`: `DataPoint`, `i`: `number`) => `string`)
|
|
12676
12676
|
|
|
12677
|
-
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)
|
|
12678
12678
|
|
|
12679
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.
|
|
12680
12680
|
|
|
@@ -12838,7 +12838,7 @@ Configuration object for the legend tooltip.
|
|
|
12838
12838
|
|
|
12839
12839
|
> **lineMarkerConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
12840
12840
|
|
|
12841
|
-
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)
|
|
12842
12842
|
|
|
12843
12843
|
Shape config for the Circle shapes drawn by the lineMarkers method.
|
|
12844
12844
|
|
|
@@ -12858,7 +12858,7 @@ Shape config for the Circle shapes drawn by the lineMarkers method.
|
|
|
12858
12858
|
|
|
12859
12859
|
> **lineMarkers**(`_?`: `boolean`): `boolean` \| [`Plot`](#plot)
|
|
12860
12860
|
|
|
12861
|
-
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)
|
|
12862
12862
|
|
|
12863
12863
|
Draws circle markers on each vertex of a Line.
|
|
12864
12864
|
|
|
@@ -13297,7 +13297,7 @@ Draws the visualization given the specified configuration.
|
|
|
13297
13297
|
|
|
13298
13298
|
> **renderer**(): `"svg"` \| `"canvas"`
|
|
13299
13299
|
|
|
13300
|
-
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)
|
|
13301
13301
|
|
|
13302
13302
|
Selects which @d3plus/render backend paints the visible output.
|
|
13303
13303
|
`"svg"` = SvgRenderer (default), `"canvas"` = CanvasRenderer.
|
|
@@ -13315,7 +13315,7 @@ Boolean arguments both normalize to `"svg"`.
|
|
|
13315
13315
|
|
|
13316
13316
|
> **renderer**(`_`: `boolean` \| `"svg"` \| `"canvas"`): `this`
|
|
13317
13317
|
|
|
13318
|
-
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)
|
|
13319
13319
|
|
|
13320
13320
|
Selects which @d3plus/render backend paints the visible output.
|
|
13321
13321
|
`"svg"` = SvgRenderer (default), `"canvas"` = CanvasRenderer.
|
|
@@ -13343,7 +13343,7 @@ Boolean arguments both normalize to `"svg"`.
|
|
|
13343
13343
|
|
|
13344
13344
|
> **renderMode**(): `"full"` \| `"compute"`
|
|
13345
13345
|
|
|
13346
|
-
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)
|
|
13347
13347
|
|
|
13348
13348
|
"full" runs the DOM enter/update/exit for every shape; "compute"
|
|
13349
13349
|
skips DOM work and only populates the scene data (`_textData`,
|
|
@@ -13362,7 +13362,7 @@ skips DOM work and only populates the scene data (`_textData`,
|
|
|
13362
13362
|
|
|
13363
13363
|
> **renderMode**(`_`: `"full"` \| `"compute"`): `this`
|
|
13364
13364
|
|
|
13365
|
-
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)
|
|
13366
13366
|
|
|
13367
13367
|
"full" runs the DOM enter/update/exit for every shape; "compute"
|
|
13368
13368
|
skips DOM work and only populates the scene data (`_textData`,
|
|
@@ -13389,7 +13389,7 @@ skips DOM work and only populates the scene data (`_textData`,
|
|
|
13389
13389
|
|
|
13390
13390
|
> **renderScene**(`target`: `Element`, `opts?`: `object`): `Promise`\<\{ `renderer`: `Renderer`; `scene`: `Scene`; \}\>
|
|
13391
13391
|
|
|
13392
|
-
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)
|
|
13393
13393
|
|
|
13394
13394
|
Public entry point that renders this chart through the @d3plus/render
|
|
13395
13395
|
pluggable backends. The compute pass happens via render() (in an svg
|
|
@@ -13533,7 +13533,7 @@ Configuration object with key/value pairs applied as method calls on each shape.
|
|
|
13533
13533
|
|
|
13534
13534
|
> **size**(`_?`: `false` \| `PlotAccessorArg`): [`Plot`](#plot) \| `PlotAccessor`
|
|
13535
13535
|
|
|
13536
|
-
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)
|
|
13537
13537
|
|
|
13538
13538
|
Sets the size of bubbles to the given Number, data key, or function.
|
|
13539
13539
|
|
|
@@ -13553,7 +13553,7 @@ Sets the size of bubbles to the given Number, data key, or function.
|
|
|
13553
13553
|
|
|
13554
13554
|
> **stackOffset**(`_?`: `string` \| `StackOffsetFn`): [`Plot`](#plot) \| `StackOffsetFn`
|
|
13555
13555
|
|
|
13556
|
-
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)
|
|
13557
13557
|
|
|
13558
13558
|
Sets the vertical offset applied to stacked series. Accepts a named
|
|
13559
13559
|
offset — `"diverging"` (default), `"none"`, `"expand"`, `"silhouette"`,
|
|
@@ -13577,7 +13577,7 @@ stack offset function.
|
|
|
13577
13577
|
|
|
13578
13578
|
> **stackOrder**(`_?`: `StackOrderInput`): [`Plot`](#plot) \| `string`[] \| `StackOrderFn`
|
|
13579
13579
|
|
|
13580
|
-
Defined in: [charts/Plot/index.ts:
|
|
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
13583
|
Accepts:
|
|
@@ -13914,6 +13914,27 @@ Tells the title whether or not to use the internal padding defined by the visual
|
|
|
13914
13914
|
|
|
13915
13915
|
[`Viz`](#viz).[`titlePadding`](#titlepadding-1)
|
|
13916
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
|
+
|
|
13917
13938
|
<a id="tooltip"></a>
|
|
13918
13939
|
|
|
13919
13940
|
##### tooltip()
|
|
@@ -13968,7 +13989,7 @@ Configuration object for the tooltip.
|
|
|
13968
13989
|
|
|
13969
13990
|
> **toScene**(): `Scene`
|
|
13970
13991
|
|
|
13971
|
-
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)
|
|
13972
13993
|
|
|
13973
13994
|
Composes the chart's scene graph: the native shape scenes from Viz.toScene
|
|
13974
13995
|
(bars/lines/areas + labels) plus snapshots of the rendered axes, so a Plot
|
|
@@ -13982,6 +14003,28 @@ renders fully — geometry and axes — through the @d3plus/render backends.
|
|
|
13982
14003
|
|
|
13983
14004
|
[`Viz`](#viz).[`toScene`](#toscene-19)
|
|
13984
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
|
+
|
|
13985
14028
|
<a id="total"></a>
|
|
13986
14029
|
|
|
13987
14030
|
##### total()
|
|
@@ -14142,7 +14185,7 @@ return d === "Back" ? "Get outta here" : d;
|
|
|
14142
14185
|
|
|
14143
14186
|
> **x**(`_?`: `PlotAccessorArg`): [`Plot`](#plot) \| `PlotAccessor`
|
|
14144
14187
|
|
|
14145
|
-
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)
|
|
14146
14189
|
|
|
14147
14190
|
Accessor function or string key for the x-axis value of each data point.
|
|
14148
14191
|
|
|
@@ -14162,7 +14205,7 @@ Accessor function or string key for the x-axis value of each data point.
|
|
|
14162
14205
|
|
|
14163
14206
|
> **x2**(`_?`: `PlotAccessorArg`): [`Plot`](#plot) \| `PlotAccessor`
|
|
14164
14207
|
|
|
14165
|
-
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)
|
|
14166
14209
|
|
|
14167
14210
|
Accessor function or string key for the secondary x-axis value of each data point.
|
|
14168
14211
|
|
|
@@ -14182,7 +14225,7 @@ Accessor function or string key for the secondary x-axis value of each data poin
|
|
|
14182
14225
|
|
|
14183
14226
|
> **x2Config**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
14184
14227
|
|
|
14185
|
-
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)
|
|
14186
14229
|
|
|
14187
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.
|
|
14188
14231
|
|
|
@@ -14202,7 +14245,7 @@ A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config use
|
|
|
14202
14245
|
|
|
14203
14246
|
> **xConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
14204
14247
|
|
|
14205
|
-
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)
|
|
14206
14249
|
|
|
14207
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.
|
|
14208
14251
|
|
|
@@ -14222,7 +14265,7 @@ A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config use
|
|
|
14222
14265
|
|
|
14223
14266
|
> **y**(`_?`: `PlotAccessorArg`): [`Plot`](#plot) \| `PlotAccessor`
|
|
14224
14267
|
|
|
14225
|
-
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)
|
|
14226
14269
|
|
|
14227
14270
|
Accessor function or string key for the y-axis value of each data point.
|
|
14228
14271
|
|
|
@@ -14242,7 +14285,7 @@ Accessor function or string key for the y-axis value of each data point.
|
|
|
14242
14285
|
|
|
14243
14286
|
> **y2**(`_?`: `PlotAccessorArg`): [`Plot`](#plot) \| `PlotAccessor`
|
|
14244
14287
|
|
|
14245
|
-
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)
|
|
14246
14289
|
|
|
14247
14290
|
Accessor function or string key for the secondary y-axis value of each data point.
|
|
14248
14291
|
|
|
@@ -14262,7 +14305,7 @@ Accessor function or string key for the secondary y-axis value of each data poin
|
|
|
14262
14305
|
|
|
14263
14306
|
> **y2Config**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
14264
14307
|
|
|
14265
|
-
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)
|
|
14266
14309
|
|
|
14267
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.
|
|
14268
14311
|
|
|
@@ -14282,7 +14325,7 @@ A pass-through to the underlying [Axis](http://d3plus.org/docs/#Axis) config use
|
|
|
14282
14325
|
|
|
14283
14326
|
> **yConfig**(`_?`: `Record`\<`string`, `unknown`\>): `Record`\<`string`, `unknown`\> \| [`Plot`](#plot)
|
|
14284
14327
|
|
|
14285
|
-
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)
|
|
14286
14329
|
|
|
14287
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.
|
|
14288
14331
|
|
|
@@ -14501,7 +14544,7 @@ Creates SVG rectangles based on an array of data. See [this example](https://d3p
|
|
|
14501
14544
|
|
|
14502
14545
|
> `optional` **\_dataFilter**(`data`: `DataPoint`[]): `DataPoint`[]
|
|
14503
14546
|
|
|
14504
|
-
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)
|
|
14505
14548
|
|
|
14506
14549
|
###### Parameters
|
|
14507
14550
|
|
|
@@ -14525,7 +14568,7 @@ Defined in: [shapes/Shape.ts:123](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
14525
14568
|
|
|
14526
14569
|
> **active**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
14527
14570
|
|
|
14528
|
-
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)
|
|
14529
14572
|
|
|
14530
14573
|
The active callback function for highlighting shapes.
|
|
14531
14574
|
|
|
@@ -14541,7 +14584,7 @@ The active callback function for highlighting shapes.
|
|
|
14541
14584
|
|
|
14542
14585
|
> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
14543
14586
|
|
|
14544
|
-
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)
|
|
14545
14588
|
|
|
14546
14589
|
The active callback function for highlighting shapes.
|
|
14547
14590
|
|
|
@@ -14567,7 +14610,7 @@ The active callback function for highlighting shapes.
|
|
|
14567
14610
|
|
|
14568
14611
|
> **activeStyle**(): `Record`\<`string`, `unknown`\>
|
|
14569
14612
|
|
|
14570
|
-
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)
|
|
14571
14614
|
|
|
14572
14615
|
The style to apply to active shapes.
|
|
14573
14616
|
|
|
@@ -14583,7 +14626,7 @@ The style to apply to active shapes.
|
|
|
14583
14626
|
|
|
14584
14627
|
> **activeStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
14585
14628
|
|
|
14586
|
-
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)
|
|
14587
14630
|
|
|
14588
14631
|
The style to apply to active shapes.
|
|
14589
14632
|
|
|
@@ -14655,7 +14698,7 @@ keys (e.g. `width`/`height` for Rect) in autocomplete + type checks.
|
|
|
14655
14698
|
|
|
14656
14699
|
> **data**(): `DataPoint`[]
|
|
14657
14700
|
|
|
14658
|
-
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)
|
|
14659
14702
|
|
|
14660
14703
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
14661
14704
|
|
|
@@ -14671,7 +14714,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
14671
14714
|
|
|
14672
14715
|
> **data**(`_`: `DataPoint`[]): `this`
|
|
14673
14716
|
|
|
14674
|
-
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)
|
|
14675
14718
|
|
|
14676
14719
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
14677
14720
|
|
|
@@ -14697,7 +14740,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
14697
14740
|
|
|
14698
14741
|
> **hover**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
14699
14742
|
|
|
14700
|
-
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)
|
|
14701
14744
|
|
|
14702
14745
|
The hover callback function for highlighting shapes on mouseover.
|
|
14703
14746
|
|
|
@@ -14713,7 +14756,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
14713
14756
|
|
|
14714
14757
|
> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
14715
14758
|
|
|
14716
|
-
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)
|
|
14717
14760
|
|
|
14718
14761
|
The hover callback function for highlighting shapes on mouseover.
|
|
14719
14762
|
|
|
@@ -14739,7 +14782,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
14739
14782
|
|
|
14740
14783
|
> **hoverStyle**(): `Record`\<`string`, `unknown`\>
|
|
14741
14784
|
|
|
14742
|
-
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)
|
|
14743
14786
|
|
|
14744
14787
|
The style to apply to hovered shapes.
|
|
14745
14788
|
|
|
@@ -14755,7 +14798,7 @@ The style to apply to hovered shapes.
|
|
|
14755
14798
|
|
|
14756
14799
|
> **hoverStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
14757
14800
|
|
|
14758
|
-
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)
|
|
14759
14802
|
|
|
14760
14803
|
The style to apply to hovered shapes.
|
|
14761
14804
|
|
|
@@ -14781,7 +14824,7 @@ The style to apply to hovered shapes.
|
|
|
14781
14824
|
|
|
14782
14825
|
> **labelConfig**(): `Record`\<`string`, `unknown`\>
|
|
14783
14826
|
|
|
14784
|
-
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)
|
|
14785
14828
|
|
|
14786
14829
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
14787
14830
|
|
|
@@ -14797,7 +14840,7 @@ A pass-through to the config method of the TextBox class used to create a shape'
|
|
|
14797
14840
|
|
|
14798
14841
|
> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
14799
14842
|
|
|
14800
|
-
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)
|
|
14801
14844
|
|
|
14802
14845
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
14803
14846
|
|
|
@@ -15070,7 +15113,7 @@ Parent config used by the wrapper.
|
|
|
15070
15113
|
|
|
15071
15114
|
> **render**(`callback?`: () => `void`): `this`
|
|
15072
15115
|
|
|
15073
|
-
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)
|
|
15074
15117
|
|
|
15075
15118
|
###### Parameters
|
|
15076
15119
|
|
|
@@ -15094,7 +15137,7 @@ Defined in: [shapes/Shape.ts:522](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
15094
15137
|
|
|
15095
15138
|
> **select**(): `Selection`
|
|
15096
15139
|
|
|
15097
|
-
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)
|
|
15098
15141
|
|
|
15099
15142
|
The SVG container element as a d3 selector or DOM element.
|
|
15100
15143
|
|
|
@@ -15110,7 +15153,7 @@ The SVG container element as a d3 selector or DOM element.
|
|
|
15110
15153
|
|
|
15111
15154
|
> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`
|
|
15112
15155
|
|
|
15113
|
-
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)
|
|
15114
15157
|
|
|
15115
15158
|
The SVG container element as a d3 selector or DOM element.
|
|
15116
15159
|
|
|
@@ -15178,7 +15221,7 @@ Configuration object with key/value pairs applied as method calls on each shape.
|
|
|
15178
15221
|
|
|
15179
15222
|
> **sort**(): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`
|
|
15180
15223
|
|
|
15181
|
-
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)
|
|
15182
15225
|
|
|
15183
15226
|
A comparator function used to sort shapes for layering order.
|
|
15184
15227
|
|
|
@@ -15194,7 +15237,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
15194
15237
|
|
|
15195
15238
|
> **sort**(`_`: ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`): `this`
|
|
15196
15239
|
|
|
15197
|
-
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)
|
|
15198
15241
|
|
|
15199
15242
|
A comparator function used to sort shapes for layering order.
|
|
15200
15243
|
|
|
@@ -15220,7 +15263,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
15220
15263
|
|
|
15221
15264
|
> **textureDefault**(): `Record`\<`string`, `unknown`\>
|
|
15222
15265
|
|
|
15223
|
-
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)
|
|
15224
15267
|
|
|
15225
15268
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
15226
15269
|
|
|
@@ -15236,7 +15279,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
15236
15279
|
|
|
15237
15280
|
> **textureDefault**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
15238
15281
|
|
|
15239
|
-
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)
|
|
15240
15283
|
|
|
15241
15284
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
15242
15285
|
|
|
@@ -15260,7 +15303,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
15260
15303
|
|
|
15261
15304
|
> **toScene**(): `GroupNode`
|
|
15262
15305
|
|
|
15263
|
-
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)
|
|
15264
15307
|
|
|
15265
15308
|
Produces a backend-agnostic scene graph for this shape's data, reusing the
|
|
15266
15309
|
same accessors render() applies to the DOM. This is the migration seam toward
|
|
@@ -15336,22 +15379,22 @@ return d === "Back" ? "Get outta here" : d;
|
|
|
15336
15379
|
|
|
15337
15380
|
| Property | Type | Description | Inherited from | Defined in |
|
|
15338
15381
|
| ------ | ------ | ------ | ------ | ------ |
|
|
15339
|
-
| <a id="property-_activegroup-5"></a> `_activeGroup` | `Selection` | - | [`Shape`](#shape-1).[`_activeGroup`](#property-_activegroup-6) | [shapes/Shape.ts:
|
|
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) |
|
|
15340
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) |
|
|
15341
|
-
| <a id="property-_data-14"></a> `_data` | `DataPoint`[] | - | [`Shape`](#shape-1).[`_data`](#property-_data-15) | [shapes/Shape.ts:
|
|
15342
|
-
| <a id="property-_enter-5"></a> `_enter` | `Selection` | - | [`Shape`](#shape-1).[`_enter`](#property-_enter-6) | [shapes/Shape.ts:
|
|
15343
|
-
| <a id="property-_exit-5"></a> `_exit` | `Selection` | - | [`Shape`](#shape-1).[`_exit`](#property-_exit-6) | [shapes/Shape.ts:
|
|
15344
|
-
| <a id="property-_group-12"></a> `_group` | `Selection` | - | [`Shape`](#shape-1).[`_group`](#property-_group-13) | [shapes/Shape.ts:
|
|
15345
|
-
| <a id="property-_hovergroup-5"></a> `_hoverGroup` | `Selection` | - | [`Shape`](#shape-1).[`_hoverGroup`](#property-_hovergroup-6) | [shapes/Shape.ts:
|
|
15346
|
-
| <a id="property-_labelclass-6"></a> `_labelClass` | [`TextBox`](#textbox) | - | [`Shape`](#shape-1).[`_labelClass`](#property-_labelclass-7) | [shapes/Shape.ts:
|
|
15347
|
-
| <a id="property-_name-5"></a> `_name` | `string` | - | [`Shape`](#shape-1).[`_name`](#property-_name-6) | [shapes/Shape.ts:
|
|
15348
|
-
| <a id="property-_path-5"></a> `_path` | `Record`\<`string`, `unknown`\> | - | [`Shape`](#shape-1).[`_path`](#property-_path-6) | [shapes/Shape.ts:
|
|
15349
|
-
| <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:
|
|
15350
|
-
| <a id="property-_select-14"></a> `_select` | `Selection` | - | [`Shape`](#shape-1).[`_select`](#property-_select-15) | [shapes/Shape.ts:
|
|
15351
|
-
| <a id="property-_tagname-5"></a> `_tagName` | `string` | - | [`Shape`](#shape-1).[`_tagName`](#property-_tagname-6) | [shapes/Shape.ts:
|
|
15352
|
-
| <a id="property-_texturedefs-5"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | [`Shape`](#shape-1).[`_textureDefs`](#property-_texturedefs-6) | [shapes/Shape.ts:
|
|
15353
|
-
| <a id="property-_transition-10"></a> `_transition` | `Transition`\<`BaseType`\> | - | [`Shape`](#shape-1).[`_transition`](#property-_transition-11) | [shapes/Shape.ts:
|
|
15354
|
-
| <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) |
|
|
15355
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) |
|
|
15356
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) |
|
|
15357
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) |
|
|
@@ -15362,7 +15405,7 @@ return d === "Back" ? "Get outta here" : d;
|
|
|
15362
15405
|
|
|
15363
15406
|
### Shape
|
|
15364
15407
|
|
|
15365
|
-
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)
|
|
15366
15409
|
|
|
15367
15410
|
An abstracted class for generating shapes.
|
|
15368
15411
|
|
|
@@ -15391,7 +15434,7 @@ An abstracted class for generating shapes.
|
|
|
15391
15434
|
|
|
15392
15435
|
> `optional` **\_dataFilter**(`data`: `DataPoint`[]): `DataPoint`[]
|
|
15393
15436
|
|
|
15394
|
-
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)
|
|
15395
15438
|
|
|
15396
15439
|
###### Parameters
|
|
15397
15440
|
|
|
@@ -15411,7 +15454,7 @@ Defined in: [shapes/Shape.ts:123](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
15411
15454
|
|
|
15412
15455
|
> **active**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
15413
15456
|
|
|
15414
|
-
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)
|
|
15415
15458
|
|
|
15416
15459
|
The active callback function for highlighting shapes.
|
|
15417
15460
|
|
|
@@ -15423,7 +15466,7 @@ The active callback function for highlighting shapes.
|
|
|
15423
15466
|
|
|
15424
15467
|
> **active**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
15425
15468
|
|
|
15426
|
-
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)
|
|
15427
15470
|
|
|
15428
15471
|
The active callback function for highlighting shapes.
|
|
15429
15472
|
|
|
@@ -15445,7 +15488,7 @@ The active callback function for highlighting shapes.
|
|
|
15445
15488
|
|
|
15446
15489
|
> **activeStyle**(): `Record`\<`string`, `unknown`\>
|
|
15447
15490
|
|
|
15448
|
-
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)
|
|
15449
15492
|
|
|
15450
15493
|
The style to apply to active shapes.
|
|
15451
15494
|
|
|
@@ -15457,7 +15500,7 @@ The style to apply to active shapes.
|
|
|
15457
15500
|
|
|
15458
15501
|
> **activeStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
15459
15502
|
|
|
15460
|
-
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)
|
|
15461
15504
|
|
|
15462
15505
|
The style to apply to active shapes.
|
|
15463
15506
|
|
|
@@ -15479,7 +15522,7 @@ The style to apply to active shapes.
|
|
|
15479
15522
|
|
|
15480
15523
|
> **config**(): [`BaseShapeConfig`](#baseshapeconfig)
|
|
15481
15524
|
|
|
15482
|
-
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)
|
|
15483
15526
|
|
|
15484
15527
|
Narrowed `.config()` for Shape. Inherited surface from
|
|
15485
15528
|
`BaseClass.config()`; the override exists only to surface per-shape
|
|
@@ -15497,7 +15540,7 @@ keys (e.g. `width`/`height` for Rect) in autocomplete + type checks.
|
|
|
15497
15540
|
|
|
15498
15541
|
> **config**(`_`: `Partial`\<[`BaseShapeConfig`](#baseshapeconfig)\>): `this`
|
|
15499
15542
|
|
|
15500
|
-
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)
|
|
15501
15544
|
|
|
15502
15545
|
Narrowed `.config()` for Shape. Inherited surface from
|
|
15503
15546
|
`BaseClass.config()`; the override exists only to surface per-shape
|
|
@@ -15525,7 +15568,7 @@ keys (e.g. `width`/`height` for Rect) in autocomplete + type checks.
|
|
|
15525
15568
|
|
|
15526
15569
|
> **data**(): `DataPoint`[]
|
|
15527
15570
|
|
|
15528
|
-
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)
|
|
15529
15572
|
|
|
15530
15573
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
15531
15574
|
|
|
@@ -15537,7 +15580,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
15537
15580
|
|
|
15538
15581
|
> **data**(`_`: `DataPoint`[]): `this`
|
|
15539
15582
|
|
|
15540
|
-
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)
|
|
15541
15584
|
|
|
15542
15585
|
The data array used to create shapes. A shape will be drawn for each object in the array.
|
|
15543
15586
|
|
|
@@ -15559,7 +15602,7 @@ The data array used to create shapes. A shape will be drawn for each object in t
|
|
|
15559
15602
|
|
|
15560
15603
|
> **hover**(): ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`
|
|
15561
15604
|
|
|
15562
|
-
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)
|
|
15563
15606
|
|
|
15564
15607
|
The hover callback function for highlighting shapes on mouseover.
|
|
15565
15608
|
|
|
@@ -15571,7 +15614,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
15571
15614
|
|
|
15572
15615
|
> **hover**(`_`: ((`d`: `DataPoint`, `i`: `number`) => `boolean`) \| `null`): `this`
|
|
15573
15616
|
|
|
15574
|
-
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)
|
|
15575
15618
|
|
|
15576
15619
|
The hover callback function for highlighting shapes on mouseover.
|
|
15577
15620
|
|
|
@@ -15593,7 +15636,7 @@ The hover callback function for highlighting shapes on mouseover.
|
|
|
15593
15636
|
|
|
15594
15637
|
> **hoverStyle**(): `Record`\<`string`, `unknown`\>
|
|
15595
15638
|
|
|
15596
|
-
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)
|
|
15597
15640
|
|
|
15598
15641
|
The style to apply to hovered shapes.
|
|
15599
15642
|
|
|
@@ -15605,7 +15648,7 @@ The style to apply to hovered shapes.
|
|
|
15605
15648
|
|
|
15606
15649
|
> **hoverStyle**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
15607
15650
|
|
|
15608
|
-
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)
|
|
15609
15652
|
|
|
15610
15653
|
The style to apply to hovered shapes.
|
|
15611
15654
|
|
|
@@ -15627,7 +15670,7 @@ The style to apply to hovered shapes.
|
|
|
15627
15670
|
|
|
15628
15671
|
> **labelConfig**(): `Record`\<`string`, `unknown`\>
|
|
15629
15672
|
|
|
15630
|
-
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)
|
|
15631
15674
|
|
|
15632
15675
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
15633
15676
|
|
|
@@ -15639,7 +15682,7 @@ A pass-through to the config method of the TextBox class used to create a shape'
|
|
|
15639
15682
|
|
|
15640
15683
|
> **labelConfig**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
15641
15684
|
|
|
15642
|
-
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)
|
|
15643
15686
|
|
|
15644
15687
|
A pass-through to the config method of the TextBox class used to create a shape's labels.
|
|
15645
15688
|
|
|
@@ -15908,7 +15951,7 @@ Parent config used by the wrapper.
|
|
|
15908
15951
|
|
|
15909
15952
|
> **render**(`callback?`: () => `void`): `this`
|
|
15910
15953
|
|
|
15911
|
-
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)
|
|
15912
15955
|
|
|
15913
15956
|
###### Parameters
|
|
15914
15957
|
|
|
@@ -15928,7 +15971,7 @@ Defined in: [shapes/Shape.ts:522](https://github.com/d3plus/d3plus/blob/main/pac
|
|
|
15928
15971
|
|
|
15929
15972
|
> **select**(): `Selection`
|
|
15930
15973
|
|
|
15931
|
-
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)
|
|
15932
15975
|
|
|
15933
15976
|
The SVG container element as a d3 selector or DOM element.
|
|
15934
15977
|
|
|
@@ -15940,7 +15983,7 @@ The SVG container element as a d3 selector or DOM element.
|
|
|
15940
15983
|
|
|
15941
15984
|
> **select**(`_`: `string` \| `HTMLElement` \| `SVGElement` \| `null`): `this`
|
|
15942
15985
|
|
|
15943
|
-
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)
|
|
15944
15987
|
|
|
15945
15988
|
The SVG container element as a d3 selector or DOM element.
|
|
15946
15989
|
|
|
@@ -16004,7 +16047,7 @@ Configuration object with key/value pairs applied as method calls on each shape.
|
|
|
16004
16047
|
|
|
16005
16048
|
> **sort**(): ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`
|
|
16006
16049
|
|
|
16007
|
-
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)
|
|
16008
16051
|
|
|
16009
16052
|
A comparator function used to sort shapes for layering order.
|
|
16010
16053
|
|
|
@@ -16016,7 +16059,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
16016
16059
|
|
|
16017
16060
|
> **sort**(`_`: ((`a`: `DataPoint`, `b`: `DataPoint`) => `number`) \| `null`): `this`
|
|
16018
16061
|
|
|
16019
|
-
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)
|
|
16020
16063
|
|
|
16021
16064
|
A comparator function used to sort shapes for layering order.
|
|
16022
16065
|
|
|
@@ -16038,7 +16081,7 @@ A comparator function used to sort shapes for layering order.
|
|
|
16038
16081
|
|
|
16039
16082
|
> **textureDefault**(): `Record`\<`string`, `unknown`\>
|
|
16040
16083
|
|
|
16041
|
-
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)
|
|
16042
16085
|
|
|
16043
16086
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
16044
16087
|
|
|
@@ -16050,7 +16093,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
16050
16093
|
|
|
16051
16094
|
> **textureDefault**(`_`: `Record`\<`string`, `unknown`\>): `this`
|
|
16052
16095
|
|
|
16053
|
-
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)
|
|
16054
16097
|
|
|
16055
16098
|
A series of global texture methods to be used for all textures (ie. `{stroke: "darkorange", strokeWidth: 2}`).
|
|
16056
16099
|
|
|
@@ -16070,7 +16113,7 @@ A series of global texture methods to be used for all textures (ie. `{stroke: "d
|
|
|
16070
16113
|
|
|
16071
16114
|
> **toScene**(): `GroupNode`
|
|
16072
16115
|
|
|
16073
|
-
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)
|
|
16074
16117
|
|
|
16075
16118
|
Produces a backend-agnostic scene graph for this shape's data, reusing the
|
|
16076
16119
|
same accessors render() applies to the DOM. This is the migration seam toward
|
|
@@ -16142,22 +16185,22 @@ return d === "Back" ? "Get outta here" : d;
|
|
|
16142
16185
|
|
|
16143
16186
|
| Property | Type | Description | Inherited from | Defined in |
|
|
16144
16187
|
| ------ | ------ | ------ | ------ | ------ |
|
|
16145
|
-
| <a id="property-_activegroup-6"></a> `_activeGroup` | `Selection` | - | - | [shapes/Shape.ts:
|
|
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) |
|
|
16146
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) |
|
|
16147
|
-
| <a id="property-_data-15"></a> `_data` | `DataPoint`[] | - | - | [shapes/Shape.ts:
|
|
16148
|
-
| <a id="property-_enter-6"></a> `_enter` | `Selection` | - | - | [shapes/Shape.ts:
|
|
16149
|
-
| <a id="property-_exit-6"></a> `_exit` | `Selection` | - | - | [shapes/Shape.ts:
|
|
16150
|
-
| <a id="property-_group-13"></a> `_group` | `Selection` | - | - | [shapes/Shape.ts:
|
|
16151
|
-
| <a id="property-_hovergroup-6"></a> `_hoverGroup` | `Selection` | - | - | [shapes/Shape.ts:
|
|
16152
|
-
| <a id="property-_labelclass-7"></a> `_labelClass` | [`TextBox`](#textbox) | - | - | [shapes/Shape.ts:
|
|
16153
|
-
| <a id="property-_name-6"></a> `_name` | `string` | - | - | [shapes/Shape.ts:
|
|
16154
|
-
| <a id="property-_path-6"></a> `_path` | `Record`\<`string`, `unknown`\> | - | - | [shapes/Shape.ts:
|
|
16155
|
-
| <a id="property-_scenerenderer-13"></a> `_sceneRenderer?` | `SvgRenderer` | SvgRenderer mounted by the standalone `render()` path; reused across redraws. | - | [shapes/Shape.ts:
|
|
16156
|
-
| <a id="property-_select-15"></a> `_select` | `Selection` | - | - | [shapes/Shape.ts:
|
|
16157
|
-
| <a id="property-_tagname-6"></a> `_tagName` | `string` | - | - | [shapes/Shape.ts:
|
|
16158
|
-
| <a id="property-_texturedefs-6"></a> `_textureDefs` | `Record`\<`string`, `Record`\<`string`, `unknown`\>\> | - | - | [shapes/Shape.ts:
|
|
16159
|
-
| <a id="property-_transition-11"></a> `_transition` | `Transition`\<`BaseType`\> | - | - | [shapes/Shape.ts:
|
|
16160
|
-
| <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) |
|
|
16161
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) |
|
|
16162
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) |
|
|
16163
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) |
|
|
@@ -18542,7 +18585,7 @@ Creates an x/y plot based on an array of data. See [this example](https://d3plus
|
|
|
18542
18585
|
|
|
18543
18586
|
> **\_drawSceneToTarget**(`durationOverride?`: `number`): `void`
|
|
18544
18587
|
|
|
18545
|
-
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)
|
|
18546
18589
|
|
|
18547
18590
|
Renders this chart through the @d3plus/render pluggable backends. Called
|
|
18548
18591
|
automatically by `render()`. The compute pass draws into `this._select`
|
|
@@ -18567,7 +18610,7 @@ svg's children get cleared so only the scene output is visible.
|
|
|
18567
18610
|
|
|
18568
18611
|
> **\_scheduleSceneRepaint**(): `void`
|
|
18569
18612
|
|
|
18570
|
-
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)
|
|
18571
18614
|
|
|
18572
18615
|
Coalesces interaction-driven scene repaints (hover/active dimming) into a
|
|
18573
18616
|
single paint per animation frame. A fast pointer sweep across a dense
|
|
@@ -18926,7 +18969,7 @@ Defaults to an empty array (`[]`).
|
|
|
18926
18969
|
|
|
18927
18970
|
> **destroy**(): `this`
|
|
18928
18971
|
|
|
18929
|
-
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)
|
|
18930
18973
|
|
|
18931
18974
|
Tears down the visualization: disconnects the ResizeObserver and removes DOM event listeners. Call this when unmounting to avoid memory leaks.
|
|
18932
18975
|
|
|
@@ -19839,7 +19882,7 @@ Draws the visualization given the specified configuration.
|
|
|
19839
19882
|
|
|
19840
19883
|
> **renderer**(): `"svg"` \| `"canvas"`
|
|
19841
19884
|
|
|
19842
|
-
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)
|
|
19843
19886
|
|
|
19844
19887
|
Selects which @d3plus/render backend paints the visible output.
|
|
19845
19888
|
`"svg"` = SvgRenderer (default), `"canvas"` = CanvasRenderer.
|
|
@@ -19853,7 +19896,7 @@ Boolean arguments both normalize to `"svg"`.
|
|
|
19853
19896
|
|
|
19854
19897
|
> **renderer**(`_`: `boolean` \| `"svg"` \| `"canvas"`): `this`
|
|
19855
19898
|
|
|
19856
|
-
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)
|
|
19857
19900
|
|
|
19858
19901
|
Selects which @d3plus/render backend paints the visible output.
|
|
19859
19902
|
`"svg"` = SvgRenderer (default), `"canvas"` = CanvasRenderer.
|
|
@@ -19877,7 +19920,7 @@ Boolean arguments both normalize to `"svg"`.
|
|
|
19877
19920
|
|
|
19878
19921
|
> **renderMode**(): `"full"` \| `"compute"`
|
|
19879
19922
|
|
|
19880
|
-
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)
|
|
19881
19924
|
|
|
19882
19925
|
"full" runs the DOM enter/update/exit for every shape; "compute"
|
|
19883
19926
|
skips DOM work and only populates the scene data (`_textData`,
|
|
@@ -19892,7 +19935,7 @@ skips DOM work and only populates the scene data (`_textData`,
|
|
|
19892
19935
|
|
|
19893
19936
|
> **renderMode**(`_`: `"full"` \| `"compute"`): `this`
|
|
19894
19937
|
|
|
19895
|
-
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)
|
|
19896
19939
|
|
|
19897
19940
|
"full" runs the DOM enter/update/exit for every shape; "compute"
|
|
19898
19941
|
skips DOM work and only populates the scene data (`_textData`,
|
|
@@ -19915,7 +19958,7 @@ skips DOM work and only populates the scene data (`_textData`,
|
|
|
19915
19958
|
|
|
19916
19959
|
> **renderScene**(`target`: `Element`, `opts?`: `object`): `Promise`\<\{ `renderer`: `Renderer`; `scene`: `Scene`; \}\>
|
|
19917
19960
|
|
|
19918
|
-
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)
|
|
19919
19962
|
|
|
19920
19963
|
Public entry point that renders this chart through the @d3plus/render
|
|
19921
19964
|
pluggable backends. The compute pass happens via render() (in an svg
|
|
@@ -20361,6 +20404,23 @@ Tells the title whether or not to use the internal padding defined by the visual
|
|
|
20361
20404
|
|
|
20362
20405
|
`VizBase.titlePadding`
|
|
20363
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
|
+
|
|
20364
20424
|
<a id="tooltip-2"></a>
|
|
20365
20425
|
|
|
20366
20426
|
##### tooltip()
|
|
@@ -20429,6 +20489,24 @@ by the most recent render. Combines:
|
|
|
20429
20489
|
|
|
20430
20490
|
`Scene`
|
|
20431
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
|
+
|
|
20432
20510
|
<a id="total-1"></a>
|
|
20433
20511
|
|
|
20434
20512
|
##### total()
|
|
@@ -21622,7 +21700,7 @@ Extends [`Viz`](#viz) — accepts all of its configuration. Adds or overrides th
|
|
|
21622
21700
|
| `shapeConfig` | — |
|
|
21623
21701
|
|
|
21624
21702
|
|
|
21625
|
-
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)
|
|
21626
21704
|
|
|
21627
21705
|
Creates a geographical map with zooming, panning, image tiles, and the ability to layer choropleth paths and coordinate points.
|
|
21628
21706
|
|