@d3plus/core 4.7.0 → 4.9.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 +1 -26117
- package/es/index.js +1 -3
- package/es/internal.js +148 -7
- package/es/src/charts/AreaPlot/index.js +7 -10
- package/es/src/charts/BarChart/index.js +50 -17
- package/es/src/charts/Beeswarm/index.js +39 -0
- package/es/src/charts/BoxWhisker/index.js +6 -16
- package/es/src/charts/Bullet/applyLayout.js +157 -0
- package/es/src/charts/Bullet/bulletGeometry.js +215 -0
- package/es/src/charts/Bullet/bulletLayout.js +111 -0
- package/es/src/charts/Bullet/bulletStyle.js +44 -0
- package/es/src/charts/Bullet/emit.js +258 -0
- package/es/src/charts/Bullet/index.js +268 -0
- package/es/src/charts/BumpChart/index.js +21 -49
- package/es/src/charts/Calendar/applyLayout.js +120 -0
- package/es/src/charts/Calendar/calendarDates.js +151 -0
- package/es/src/charts/Calendar/calendarFormat.js +40 -0
- package/es/src/charts/Calendar/calendarGrid.js +138 -0
- package/es/src/charts/Calendar/calendarInset.js +22 -0
- package/es/src/charts/Calendar/calendarLayout.js +242 -0
- package/es/src/charts/Calendar/emit.js +179 -0
- package/es/src/charts/Calendar/index.js +206 -0
- package/es/src/charts/Candlestick/aggregate.js +154 -0
- package/es/src/charts/Candlestick/buffer.js +83 -0
- package/es/src/charts/Candlestick/emit.js +198 -0
- package/es/src/charts/Candlestick/index.js +257 -0
- package/es/src/charts/Candlestick/ohlc.js +114 -0
- package/es/src/charts/Candlestick/periods.js +191 -0
- package/es/src/charts/Candlestick/tooltip.js +116 -0
- package/es/src/charts/Candlestick/volume.js +278 -0
- package/es/src/charts/Chord/applyLayout.js +75 -111
- package/es/src/charts/Chord/emit.js +82 -173
- package/es/src/charts/Chord/index.js +92 -106
- package/es/src/charts/Donut/index.js +6 -12
- package/es/src/charts/Dumbbell/emit.js +106 -0
- package/es/src/charts/Dumbbell/gapSort.js +79 -0
- package/es/src/charts/Dumbbell/index.js +84 -0
- package/es/src/charts/FanChart/index.js +28 -0
- package/es/src/charts/Funnel/applyLayout.js +103 -0
- package/es/src/charts/Funnel/emit.js +99 -0
- package/es/src/charts/Funnel/funnelFacet.js +53 -0
- package/es/src/charts/Funnel/funnelGeometry.js +171 -0
- package/es/src/charts/Funnel/funnelLabels.js +118 -0
- package/es/src/charts/Funnel/index.js +180 -0
- package/es/src/charts/Funnel/labelNodes.js +202 -0
- package/es/src/charts/Gauge/applyLayout.js +70 -0
- package/es/src/charts/Gauge/dialLayout.js +106 -0
- package/es/src/charts/Gauge/emit.js +214 -0
- package/es/src/charts/Gauge/emitDial.js +167 -0
- package/es/src/charts/Gauge/gaugeGeometry.js +157 -0
- package/es/src/charts/Gauge/index.js +148 -0
- package/es/src/charts/Geomap/applyLayout.js +42 -73
- package/es/src/charts/Geomap/basemapTheme.js +16 -31
- package/es/src/charts/Geomap/emit.js +94 -162
- package/es/src/charts/Geomap/index.js +186 -193
- package/es/src/charts/Geomap/projections.js +37 -0
- package/es/src/charts/Histogram/binData.js +60 -209
- package/es/src/charts/Histogram/index.js +104 -137
- package/es/src/charts/Icicle/applyLayout.js +124 -0
- package/es/src/charts/Icicle/emit.js +162 -0
- package/es/src/charts/Icicle/enterStagger.js +55 -0
- package/es/src/charts/Icicle/geometry.js +101 -0
- package/es/src/charts/Icicle/index.js +130 -0
- package/es/src/charts/Icicle/interaction.js +20 -0
- package/es/src/charts/Icicle/labelFit.js +55 -0
- package/es/src/charts/Icicle/layout.js +20 -0
- package/es/src/charts/LinePlot/index.js +1 -9
- package/es/src/charts/Lollipop/emit.js +85 -0
- package/es/src/charts/Lollipop/index.js +97 -0
- package/es/src/charts/Lollipop/stemLayout.js +97 -0
- package/es/src/charts/Marimekko/axis.js +46 -0
- package/es/src/charts/Marimekko/index.js +77 -0
- package/es/src/charts/Matrix/applyLayout.js +22 -27
- package/es/src/charts/Matrix/emit.js +33 -34
- package/es/src/charts/Matrix/index.js +56 -80
- package/es/src/charts/Network/applyLayout.js +95 -172
- package/es/src/charts/Network/emit.js +132 -266
- package/es/src/charts/Network/index.js +148 -132
- package/es/src/charts/Pack/applyLayout.js +12 -17
- package/es/src/charts/Pack/emit.js +44 -106
- package/es/src/charts/Pack/index.js +63 -107
- package/es/src/charts/Pack/recursionCircles.js +2 -5
- package/es/src/charts/ParallelCoordinates/applyLayout.js +99 -0
- package/es/src/charts/ParallelCoordinates/axes.js +213 -0
- package/es/src/charts/ParallelCoordinates/brushDom.js +187 -0
- package/es/src/charts/ParallelCoordinates/brushFilter.js +79 -0
- package/es/src/charts/ParallelCoordinates/dimensions.js +102 -0
- package/es/src/charts/ParallelCoordinates/emit.js +72 -0
- package/es/src/charts/ParallelCoordinates/format.js +23 -0
- package/es/src/charts/ParallelCoordinates/index.js +190 -0
- package/es/src/charts/ParallelCoordinates/lineStates.js +62 -0
- package/es/src/charts/ParallelCoordinates/paths.js +31 -0
- package/es/src/charts/ParallelCoordinates/titles.js +56 -0
- package/es/src/charts/Pie/applyLayout.js +20 -28
- package/es/src/charts/Pie/emit.js +109 -219
- package/es/src/charts/Pie/index.js +49 -78
- package/es/src/charts/Plot/axisInk.js +31 -0
- package/es/src/charts/Plot/barConfidence.js +273 -0
- package/es/src/charts/Plot/barWidth.js +255 -0
- package/es/src/charts/Plot/baselineBreak.js +139 -0
- package/es/src/charts/Plot/baselineDomain.js +120 -0
- package/es/src/charts/Plot/columnHighlight.js +39 -0
- package/es/src/charts/Plot/confidenceBands.js +143 -0
- package/es/src/charts/Plot/confidenceConfig.js +50 -0
- package/es/src/charts/Plot/confidenceTooltip.js +102 -0
- package/es/src/charts/Plot/curveLength.js +97 -0
- package/es/src/charts/Plot/discreteDomain.js +19 -0
- package/es/src/charts/Plot/discreteSpan.js +6 -24
- package/es/src/charts/Plot/domainClip.js +190 -0
- package/es/src/charts/Plot/draw.js +164 -295
- package/es/src/charts/Plot/facetScales.js +27 -0
- package/es/src/charts/Plot/fillBetween.js +233 -0
- package/es/src/charts/Plot/forecast.js +211 -0
- package/es/src/charts/Plot/forecastScene.js +316 -0
- package/es/src/charts/Plot/index.js +355 -930
- package/es/src/charts/Plot/insetRegion.js +5 -10
- package/es/src/charts/Plot/labelPlacement.js +12 -14
- package/es/src/charts/Plot/lineBands.js +48 -0
- package/es/src/charts/Plot/lineCurve.js +25 -0
- package/es/src/charts/Plot/openDomainEnds.js +92 -0
- package/es/src/charts/Plot/pipeline.js +143 -480
- package/es/src/charts/Plot/pipelineAxisLayout.js +132 -0
- package/es/src/charts/Plot/pipelineDomains.js +121 -239
- package/es/src/charts/Plot/pipelineLineLabels.js +81 -147
- package/es/src/charts/Plot/pipelineScales.js +177 -0
- package/es/src/charts/Plot/plotBreaks.js +223 -0
- package/es/src/charts/Plot/plotFacet.js +172 -0
- package/es/src/charts/Plot/plotInit.js +252 -0
- package/es/src/charts/Plot/plotZoom.js +105 -206
- package/es/src/charts/Plot/shapeDefaults.js +66 -81
- package/es/src/charts/Plot/sharedHover.js +185 -308
- package/es/src/charts/Plot/sharedHoverScene.js +115 -157
- package/es/src/charts/Plot/sharedTooltip.js +96 -104
- package/es/src/charts/Plot/stackEnter.js +87 -0
- package/es/src/charts/Plot/stackHelpers.js +36 -69
- package/es/src/charts/Plot/stackShareLabels.js +34 -88
- package/es/src/charts/Plot/stackShareTooltip.js +10 -15
- package/es/src/charts/Plot/swarm.js +96 -0
- package/es/src/charts/Plot/swarmLayout.js +102 -0
- package/es/src/charts/Plot/trendLines.js +105 -321
- package/es/src/charts/Plot/trendProjection.js +27 -69
- package/es/src/charts/Plot/trendScene.js +27 -171
- package/es/src/charts/Plot/trendTooltip.js +50 -132
- package/es/src/charts/PolarArea/applyLayout.js +26 -0
- package/es/src/charts/PolarArea/emit.js +12 -0
- package/es/src/charts/PolarArea/index.js +183 -0
- package/es/src/charts/Priestley/applyLayout.js +33 -53
- package/es/src/charts/Priestley/emit.js +50 -111
- package/es/src/charts/Priestley/index.js +35 -35
- package/es/src/charts/Pyramid/gutter.js +208 -0
- package/es/src/charts/Pyramid/index.js +373 -0
- package/es/src/charts/Pyramid/pyramidData.js +65 -0
- package/es/src/charts/Pyramid/scene.js +224 -0
- package/es/src/charts/Pyramid/stackOrder.js +39 -0
- package/es/src/charts/Radar/applyLayout.js +52 -291
- package/es/src/charts/Radar/axisDecorations.js +200 -0
- package/es/src/charts/Radar/axisLabels.js +109 -0
- package/es/src/charts/Radar/emit.js +23 -19
- package/es/src/charts/Radar/index.js +64 -45
- package/es/src/charts/Radar/levels.js +136 -0
- package/es/src/charts/Radar/rings.js +72 -0
- package/es/src/charts/RadialBar/applyLayout.js +47 -0
- package/es/src/charts/RadialBar/emit.js +38 -0
- package/es/src/charts/RadialBar/index.js +221 -0
- package/es/src/charts/RadialBar/trackLayout.js +330 -0
- package/es/src/charts/RadialBar/tracks.js +53 -0
- package/es/src/charts/RadialMatrix/applyLayout.js +42 -80
- package/es/src/charts/RadialMatrix/emit.js +23 -23
- package/es/src/charts/RadialMatrix/index.js +65 -67
- package/es/src/charts/Ridgeline/emit.js +75 -0
- package/es/src/charts/Ridgeline/index.js +55 -0
- package/es/src/charts/Rings/applyLayout.js +124 -266
- package/es/src/charts/Rings/emit.js +127 -236
- package/es/src/charts/Rings/index.js +118 -98
- package/es/src/charts/Rings/ringsGraph.js +88 -0
- package/es/src/charts/Rings/ringsSizing.js +41 -89
- package/es/src/charts/Sankey/applyLayout.js +32 -60
- package/es/src/charts/Sankey/emit.js +94 -150
- package/es/src/charts/Sankey/index.js +130 -104
- package/es/src/charts/Sankey/sankeyLayout.js +283 -0
- package/es/src/charts/StackedArea/index.js +3 -10
- package/es/src/charts/Sunburst/applyLayout.js +116 -0
- package/es/src/charts/Sunburst/emit.js +181 -0
- package/es/src/charts/Sunburst/geometry.js +98 -0
- package/es/src/charts/Sunburst/index.js +168 -0
- package/es/src/charts/Sunburst/interaction.js +23 -0
- package/es/src/charts/Sunburst/labelFit.js +159 -0
- package/es/src/charts/Sunburst/partition.js +32 -0
- package/es/src/charts/Tree/applyLayout.js +78 -130
- package/es/src/charts/Tree/emit.js +76 -184
- package/es/src/charts/Tree/index.js +26 -37
- package/es/src/charts/Treemap/applyLayout.js +34 -57
- package/es/src/charts/Treemap/emit.js +57 -136
- package/es/src/charts/Treemap/index.js +57 -95
- package/es/src/charts/Treemap/thresholdFunction.js +14 -75
- package/es/src/charts/Violin/emit.js +80 -0
- package/es/src/charts/Violin/index.js +88 -0
- package/es/src/charts/Violin/inner.js +196 -0
- package/es/src/charts/Violin/violinLayout.js +80 -0
- package/es/src/charts/Waffle/applyLayout.js +90 -0
- package/es/src/charts/Waffle/emit.js +89 -0
- package/es/src/charts/Waffle/index.js +170 -0
- package/es/src/charts/Waffle/tooltip.js +37 -0
- package/es/src/charts/Waffle/waffleLayout.js +104 -0
- package/es/src/charts/Waterfall/buffer.js +65 -0
- package/es/src/charts/Waterfall/connectors.js +103 -0
- package/es/src/charts/Waterfall/index.js +211 -0
- package/es/src/charts/Waterfall/labels.js +82 -0
- package/es/src/charts/Waterfall/state.js +147 -0
- package/es/src/charts/Waterfall/steps.js +138 -0
- package/es/src/charts/definition/ChartDefinition.js +2 -4
- package/es/src/charts/definition/applyDefinition.js +4 -88
- package/es/src/charts/definition/makeChart.js +35 -141
- package/es/src/charts/drawSteps/backControl.js +15 -14
- package/es/src/charts/drawSteps/bottomRightControls.js +39 -115
- package/es/src/charts/drawSteps/bottomRightControlsMarkup.js +60 -174
- package/es/src/charts/drawSteps/controlButtonStyle.js +39 -63
- package/es/src/charts/drawSteps/minimap.js +82 -139
- package/es/src/charts/drawSteps/minimapMarkup.js +13 -93
- package/es/src/charts/drawSteps/searchControls.js +48 -105
- package/es/src/charts/drawSteps/searchControlsMarkup.js +62 -176
- package/es/src/charts/drawSteps/tableView.js +23 -40
- package/es/src/charts/drawSteps/tableViewControl.js +2 -8
- package/es/src/charts/drawSteps/tableViewMarkup.js +152 -233
- package/es/src/charts/drawSteps/topLeftControls.js +8 -28
- package/es/src/charts/drawSteps/topLeftControlsMarkup.js +49 -119
- package/es/src/charts/drawSteps/zoomControls.js +72 -145
- package/es/src/charts/drawSteps/zoomControlsMarkup.js +59 -124
- package/es/src/charts/drawSteps/zoomGesture.js +17 -0
- package/es/src/charts/drawSteps/zoomShown.js +40 -0
- package/es/src/charts/events/click.legend.js +12 -23
- package/es/src/charts/events/click.shape.js +6 -11
- package/es/src/charts/events/mouseenter.js +14 -24
- package/es/src/charts/events/mouseleave.js +29 -14
- package/es/src/charts/events/mousemove.legend.js +20 -30
- package/es/src/charts/events/mousemove.shape.js +12 -21
- package/es/src/charts/events/touchstart.body.js +0 -2
- package/es/src/charts/facet/drawFacets.js +332 -0
- package/es/src/charts/facet/facetConfig.js +72 -0
- package/es/src/charts/facet/facetData.js +97 -0
- package/es/src/charts/facet/facetGrid.js +107 -0
- package/es/src/charts/facet/facetGutter.js +131 -0
- package/es/src/charts/facet/facetPanel.js +56 -0
- package/es/src/charts/facet/facetScene.js +111 -0
- package/es/src/charts/features/attributionFeature.js +38 -38
- package/es/src/charts/features/axes.js +105 -304
- package/es/src/charts/features/axesFinal.js +134 -0
- package/es/src/charts/features/axesMeasure.js +138 -0
- package/es/src/charts/features/backgroundImageEmit.js +61 -0
- package/es/src/charts/features/chartGeometry.js +3 -5
- package/es/src/charts/features/colorScaleBucket.js +17 -21
- package/es/src/charts/features/edgeArrows.js +36 -70
- package/es/src/charts/features/emitHelpers.js +42 -137
- package/es/src/charts/features/ensureZoomDom.js +27 -40
- package/es/src/charts/features/features.js +216 -256
- package/es/src/charts/features/featuresColorScale.js +40 -39
- package/es/src/charts/features/featuresLegend.js +152 -188
- package/es/src/charts/features/frozenAxis.js +14 -0
- package/es/src/charts/features/insetState.js +25 -90
- package/es/src/charts/features/legendCategory.js +61 -0
- package/es/src/charts/features/legendLabel.js +5 -9
- package/es/src/charts/features/lineLabels.js +20 -87
- package/es/src/charts/features/plotAnnotations.js +105 -0
- package/es/src/charts/features/plotEndLabels.js +209 -0
- package/es/src/charts/features/plotPaint.js +192 -404
- package/es/src/charts/features/sceneBounds.js +57 -164
- package/es/src/charts/features/shapeEmit.js +183 -184
- package/es/src/charts/features/shareKey.js +32 -0
- package/es/src/charts/features/sharedFields.js +38 -0
- package/es/src/charts/features/tooltipSwatch.js +99 -42
- package/es/src/charts/features/xAxisConfig.js +19 -0
- package/es/src/charts/features/zoomExtent.js +23 -108
- package/es/src/charts/helpers/densityChart.js +267 -0
- package/es/src/charts/helpers/densityData.js +116 -0
- package/es/src/charts/helpers/densityEnter.js +64 -0
- package/es/src/charts/helpers/matrixData.js +11 -82
- package/es/src/charts/helpers/tileAttributions.js +1 -3
- package/es/src/charts/helpers/valueTitle.js +29 -0
- package/es/src/charts/index.js +20 -2
- package/es/src/charts/partition/chartFields.js +43 -0
- package/es/src/charts/partition/hierarchy.js +174 -0
- package/es/src/charts/partition/interaction.js +158 -0
- package/es/src/charts/partition/labelWords.js +95 -0
- package/es/src/charts/partition/shade.js +56 -0
- package/es/src/charts/partition/zoom.js +80 -0
- package/es/src/charts/pipeline/drillMorph.js +16 -37
- package/es/src/charts/pipeline/insetPlacement.js +95 -188
- package/es/src/charts/pipeline/preDrawData.js +74 -0
- package/es/src/charts/pipeline/resolveSpec.js +1 -3
- package/es/src/charts/pipeline/runChartDraw.js +14 -69
- package/es/src/charts/pipeline/runVizPipeline.js +13 -35
- package/es/src/charts/pipeline/stages.js +24 -61
- package/es/src/charts/pipeline/vizDraw.js +165 -30
- package/es/src/charts/pipeline/vizPreDraw.js +145 -106
- package/es/src/charts/plotBuffers/Bar.js +7 -108
- package/es/src/charts/plotBuffers/Box.js +6 -102
- package/es/src/charts/plotBuffers/Circle.js +11 -14
- package/es/src/charts/plotBuffers/Line.js +7 -13
- package/es/src/charts/plotBuffers/Rect.js +11 -15
- package/es/src/charts/plotBuffers/defaultBuffers.js +12 -0
- package/es/src/charts/plotBuffers/discreteBuffer.js +5 -9
- package/es/src/charts/plotBuffers/numericBuffer.js +24 -33
- package/es/src/charts/plotBuffers/rectLikeBuffer.js +39 -0
- package/es/src/charts/polar/chrome.js +170 -0
- package/es/src/charts/polar/config.js +82 -0
- package/es/src/charts/polar/geometry.js +92 -0
- package/es/src/charts/polar/labels.js +124 -0
- package/es/src/charts/polar/polarFacet.js +43 -0
- package/es/src/charts/polar/wedgeLayout.js +140 -0
- package/es/src/charts/viz/Viz.js +503 -991
- package/es/src/charts/viz/VizBase.js +260 -613
- package/es/src/charts/viz/backgroundInk.js +17 -0
- package/es/src/charts/viz/interactionOpacity.js +92 -135
- package/es/src/charts/viz/labelDefaults.js +61 -0
- package/es/src/charts/viz/linkGroup.js +63 -237
- package/es/src/charts/viz/ordinalColor.js +12 -44
- package/es/src/charts/viz/reserveContainerSize.js +49 -0
- package/es/src/charts/viz/resetChromeBoxes.js +41 -0
- package/es/src/charts/viz/sceneRows.js +7 -9
- package/es/src/charts/viz/shapeClassTargets.js +33 -0
- package/es/src/charts/viz/shapeHover.js +9 -0
- package/es/src/charts/viz/simpleHover.js +14 -0
- package/es/src/charts/viz/trailCatchup.js +28 -87
- package/es/src/charts/viz/vizDefaults.js +113 -385
- package/es/src/charts/viz/vizFields.js +197 -0
- package/es/src/charts/viz/vizRender.js +84 -78
- package/es/src/charts/viz/vizTypes.js +1 -3
- package/es/src/charts/viz/vizVisibility.js +32 -51
- package/es/src/components/Axis/Axis.js +304 -469
- package/es/src/components/Axis/AxisBottom.js +9 -74
- package/es/src/components/Axis/AxisLeft.js +9 -74
- package/es/src/components/Axis/AxisRight.js +9 -74
- package/es/src/components/Axis/AxisTop.js +9 -74
- package/es/src/components/Axis/axisBreak.js +243 -0
- package/es/src/components/Axis/axisDefaults.js +65 -0
- package/es/src/components/Axis/axisEndLabels.js +60 -0
- package/es/src/components/Axis/axisLabelThinning.js +123 -0
- package/es/src/components/Axis/axisLayout.js +211 -160
- package/es/src/components/Axis/axisLayoutLabels.js +187 -108
- package/es/src/components/Axis/axisLayoutScale.js +130 -247
- package/es/src/components/Axis/axisRender.js +82 -411
- package/es/src/components/Axis/axisRounding.js +68 -0
- package/es/src/components/Axis/axisScene.js +184 -0
- package/es/src/components/Axis/brokenScale.js +183 -0
- package/es/src/components/Axis/gridStroke.js +10 -0
- package/es/src/components/Axis/timeValues.js +155 -0
- package/es/src/components/Axis/yearValues.js +32 -0
- package/es/src/components/ColorScale/ColorScale.js +187 -345
- package/es/src/components/ColorScale/colorScaleRender.js +72 -108
- package/es/src/components/ColorScale/colorScaleScale.js +101 -164
- package/es/src/components/Legend/Legend.js +164 -352
- package/es/src/components/Legend/legendConfig.js +43 -55
- package/es/src/components/Legend/legendRender.js +61 -109
- package/es/src/components/Message.js +50 -98
- package/es/src/components/SizeLegend/SizeLegend.js +188 -330
- package/es/src/components/SizeLegend/sizeLegendLayout.js +65 -161
- package/es/src/components/TextBox.js +156 -615
- package/es/src/components/Timeline/Timeline.js +345 -554
- package/es/src/components/Timeline/timelineConfig.js +23 -56
- package/es/src/components/Timeline/timelineRender.js +58 -112
- package/es/src/components/Tooltip.js +128 -607
- package/es/src/components/index.js +0 -2
- package/es/src/components/textBoxLayout.js +230 -0
- package/es/src/components/tooltipDom.js +218 -0
- package/es/src/fluent.js +177 -203
- package/es/src/shapes/Area.js +128 -329
- package/es/src/shapes/Bar.js +92 -245
- package/es/src/shapes/Box.js +231 -405
- package/es/src/shapes/Circle.js +46 -199
- package/es/src/shapes/Image.js +98 -210
- package/es/src/shapes/Line.js +73 -251
- package/es/src/shapes/Path.js +34 -149
- package/es/src/shapes/Rect.js +57 -210
- package/es/src/shapes/Shape.js +328 -655
- package/es/src/shapes/Whisker.js +166 -371
- package/es/src/shapes/buildLabelData.js +31 -80
- package/es/src/shapes/emitLabels.js +17 -49
- package/es/src/shapes/hitAreaNode.js +8 -10
- package/es/src/shapes/index.js +0 -2
- package/es/src/shapes/interactionPoints.js +5 -7
- package/es/src/shapes/sceneSort.js +61 -161
- package/es/src/shapes/shapeConfig.js +0 -2
- package/es/src/shapes/shapeOwners.js +37 -0
- package/es/src/shapes/shapeStandalone.js +71 -0
- package/es/src/shapes/textureKey.js +11 -61
- package/es/src/shapes/uniqueIds.js +19 -0
- package/es/src/shapes/validateShapeConfig.js +23 -119
- package/es/src/utils/AccessorFn.js +0 -2
- package/es/src/utils/BaseClass.js +114 -262
- package/es/src/utils/D3Scale.js +0 -2
- package/es/src/utils/D3plusConfig.js +0 -2
- package/es/src/utils/RESET.js +1 -3
- package/es/src/utils/accessor.js +2 -8
- package/es/src/utils/configDefault.js +1 -3
- package/es/src/utils/configPrep.js +15 -35
- package/es/src/utils/configWarnings.js +11 -13
- package/es/src/utils/constant.js +0 -2
- package/es/src/utils/getProp.js +0 -2
- package/es/src/utils/index.js +0 -2
- package/es/src/utils/paintComponentScene.js +12 -23
- package/es/src/utils/wholeWords.js +44 -0
- package/package.json +16 -25
- package/types/index.d.ts +12 -4
- package/types/internal.d.ts +210 -12
- package/types/src/charts/AreaPlot/index.d.ts +2 -1
- package/types/src/charts/BarChart/index.d.ts +4 -2
- package/types/src/charts/Beeswarm/index.d.ts +15 -0
- package/types/src/charts/Bullet/applyLayout.d.ts +65 -0
- package/types/src/charts/Bullet/bulletGeometry.d.ts +91 -0
- package/types/src/charts/Bullet/bulletLayout.d.ts +54 -0
- package/types/src/charts/Bullet/bulletStyle.d.ts +33 -0
- package/types/src/charts/Bullet/emit.d.ts +25 -0
- package/types/src/charts/Bullet/index.d.ts +40 -0
- package/types/src/charts/Calendar/applyLayout.d.ts +37 -0
- package/types/src/charts/Calendar/calendarDates.d.ts +68 -0
- package/types/src/charts/Calendar/calendarFormat.d.ts +24 -0
- package/types/src/charts/Calendar/calendarGrid.d.ts +84 -0
- package/types/src/charts/Calendar/calendarInset.d.ts +13 -0
- package/types/src/charts/Calendar/calendarLayout.d.ts +84 -0
- package/types/src/charts/Calendar/emit.d.ts +31 -0
- package/types/src/charts/Calendar/index.d.ts +26 -0
- package/types/src/charts/Candlestick/aggregate.d.ts +91 -0
- package/types/src/charts/Candlestick/buffer.d.ts +37 -0
- package/types/src/charts/Candlestick/emit.d.ts +54 -0
- package/types/src/charts/Candlestick/index.d.ts +16 -0
- package/types/src/charts/Candlestick/ohlc.d.ts +94 -0
- package/types/src/charts/Candlestick/periods.d.ts +84 -0
- package/types/src/charts/Candlestick/tooltip.d.ts +50 -0
- package/types/src/charts/Candlestick/volume.d.ts +129 -0
- package/types/src/charts/Chord/emit.d.ts +2 -2
- package/types/src/charts/Dumbbell/emit.d.ts +34 -0
- package/types/src/charts/Dumbbell/gapSort.d.ts +47 -0
- package/types/src/charts/Dumbbell/index.d.ts +21 -0
- package/types/src/charts/FanChart/index.d.ts +17 -0
- package/types/src/charts/Funnel/applyLayout.d.ts +89 -0
- package/types/src/charts/Funnel/emit.d.ts +29 -0
- package/types/src/charts/Funnel/funnelFacet.d.ts +33 -0
- package/types/src/charts/Funnel/funnelGeometry.d.ts +78 -0
- package/types/src/charts/Funnel/funnelLabels.d.ts +101 -0
- package/types/src/charts/Funnel/index.d.ts +30 -0
- package/types/src/charts/Funnel/labelNodes.d.ts +57 -0
- package/types/src/charts/Gauge/applyLayout.d.ts +41 -0
- package/types/src/charts/Gauge/dialLayout.d.ts +78 -0
- package/types/src/charts/Gauge/emit.d.ts +22 -0
- package/types/src/charts/Gauge/emitDial.d.ts +41 -0
- package/types/src/charts/Gauge/gaugeGeometry.d.ts +89 -0
- package/types/src/charts/Gauge/index.d.ts +21 -0
- package/types/src/charts/Geomap/projections.d.ts +8 -0
- package/types/src/charts/Histogram/binData.d.ts +9 -1
- package/types/src/charts/Icicle/applyLayout.d.ts +54 -0
- package/types/src/charts/Icicle/emit.d.ts +20 -0
- package/types/src/charts/Icicle/enterStagger.d.ts +30 -0
- package/types/src/charts/Icicle/geometry.d.ts +72 -0
- package/types/src/charts/Icicle/index.d.ts +25 -0
- package/types/src/charts/Icicle/interaction.d.ts +16 -0
- package/types/src/charts/Icicle/labelFit.d.ts +37 -0
- package/types/src/charts/Icicle/layout.d.ts +21 -0
- package/types/src/charts/Lollipop/emit.d.ts +19 -0
- package/types/src/charts/Lollipop/index.d.ts +17 -0
- package/types/src/charts/Lollipop/stemLayout.d.ts +82 -0
- package/types/src/charts/Marimekko/axis.d.ts +27 -0
- package/types/src/charts/Marimekko/index.d.ts +19 -0
- package/types/src/charts/ParallelCoordinates/applyLayout.d.ts +27 -0
- package/types/src/charts/ParallelCoordinates/axes.d.ts +40 -0
- package/types/src/charts/ParallelCoordinates/brushDom.d.ts +47 -0
- package/types/src/charts/ParallelCoordinates/brushFilter.d.ts +39 -0
- package/types/src/charts/ParallelCoordinates/dimensions.d.ts +63 -0
- package/types/src/charts/ParallelCoordinates/emit.d.ts +27 -0
- package/types/src/charts/ParallelCoordinates/format.d.ts +13 -0
- package/types/src/charts/ParallelCoordinates/index.d.ts +27 -0
- package/types/src/charts/ParallelCoordinates/lineStates.d.ts +21 -0
- package/types/src/charts/ParallelCoordinates/paths.d.ts +27 -0
- package/types/src/charts/ParallelCoordinates/titles.d.ts +21 -0
- package/types/src/charts/Plot/axisInk.d.ts +8 -0
- package/types/src/charts/Plot/barConfidence.d.ts +120 -0
- package/types/src/charts/Plot/barWidth.d.ts +119 -0
- package/types/src/charts/Plot/baselineBreak.d.ts +52 -0
- package/types/src/charts/Plot/baselineDomain.d.ts +67 -0
- package/types/src/charts/Plot/columnHighlight.d.ts +23 -0
- package/types/src/charts/Plot/confidenceBands.d.ts +72 -0
- package/types/src/charts/Plot/confidenceConfig.d.ts +16 -0
- package/types/src/charts/Plot/confidenceTooltip.d.ts +70 -0
- package/types/src/charts/Plot/curveLength.d.ts +27 -0
- package/types/src/charts/Plot/discreteDomain.d.ts +14 -0
- package/types/src/charts/Plot/domainClip.d.ts +21 -0
- package/types/src/charts/Plot/facetScales.d.ts +27 -0
- package/types/src/charts/Plot/fillBetween.d.ts +69 -0
- package/types/src/charts/Plot/forecast.d.ts +102 -0
- package/types/src/charts/Plot/forecastScene.d.ts +88 -0
- package/types/src/charts/Plot/index.d.ts +24 -5
- package/types/src/charts/Plot/lineBands.d.ts +7 -0
- package/types/src/charts/Plot/lineCurve.d.ts +15 -0
- package/types/src/charts/Plot/openDomainEnds.d.ts +25 -0
- package/types/src/charts/Plot/pipeline.d.ts +5 -30
- package/types/src/charts/Plot/pipelineAxisLayout.d.ts +2 -0
- package/types/src/charts/Plot/pipelineScales.d.ts +20 -0
- package/types/src/charts/Plot/plotBreaks.d.ts +61 -0
- package/types/src/charts/Plot/plotFacet.d.ts +36 -0
- package/types/src/charts/Plot/plotInit.d.ts +44 -0
- package/types/src/charts/Plot/plotZoom.d.ts +14 -8
- package/types/src/charts/Plot/sharedHover.d.ts +5 -0
- package/types/src/charts/Plot/sharedHoverScene.d.ts +3 -6
- package/types/src/charts/Plot/sharedTooltip.d.ts +13 -8
- package/types/src/charts/Plot/stackEnter.d.ts +42 -0
- package/types/src/charts/Plot/swarm.d.ts +66 -0
- package/types/src/charts/Plot/swarmLayout.d.ts +59 -0
- package/types/src/charts/PolarArea/applyLayout.d.ts +17 -0
- package/types/src/charts/PolarArea/emit.d.ts +3 -0
- package/types/src/charts/PolarArea/index.d.ts +19 -0
- package/types/src/charts/Pyramid/gutter.d.ts +76 -0
- package/types/src/charts/Pyramid/index.d.ts +19 -0
- package/types/src/charts/Pyramid/pyramidData.d.ts +48 -0
- package/types/src/charts/Pyramid/scene.d.ts +106 -0
- package/types/src/charts/Pyramid/stackOrder.d.ts +9 -0
- package/types/src/charts/Radar/applyLayout.d.ts +7 -5
- package/types/src/charts/Radar/axisDecorations.d.ts +67 -0
- package/types/src/charts/Radar/axisLabels.d.ts +79 -0
- package/types/src/charts/Radar/emit.d.ts +2 -2
- package/types/src/charts/Radar/index.d.ts +5 -1
- package/types/src/charts/Radar/levels.d.ts +68 -0
- package/types/src/charts/Radar/rings.d.ts +30 -0
- package/types/src/charts/RadialBar/applyLayout.d.ts +19 -0
- package/types/src/charts/RadialBar/emit.d.ts +6 -0
- package/types/src/charts/RadialBar/index.d.ts +21 -0
- package/types/src/charts/RadialBar/trackLayout.d.ts +46 -0
- package/types/src/charts/RadialBar/tracks.d.ts +32 -0
- package/types/src/charts/Ridgeline/emit.d.ts +11 -0
- package/types/src/charts/Ridgeline/index.d.ts +16 -0
- package/types/src/charts/Rings/index.d.ts +2 -0
- package/types/src/charts/Rings/ringsGraph.d.ts +72 -0
- package/types/src/charts/Sankey/applyLayout.d.ts +1 -1
- package/types/src/charts/Sankey/sankeyLayout.d.ts +57 -0
- package/types/src/charts/StackedArea/index.d.ts +2 -1
- package/types/src/charts/Sunburst/applyLayout.d.ts +67 -0
- package/types/src/charts/Sunburst/emit.d.ts +29 -0
- package/types/src/charts/Sunburst/geometry.d.ts +65 -0
- package/types/src/charts/Sunburst/index.d.ts +21 -0
- package/types/src/charts/Sunburst/interaction.d.ts +20 -0
- package/types/src/charts/Sunburst/labelFit.d.ts +73 -0
- package/types/src/charts/Sunburst/partition.d.ts +34 -0
- package/types/src/charts/Violin/emit.d.ts +4 -0
- package/types/src/charts/Violin/index.d.ts +16 -0
- package/types/src/charts/Violin/inner.d.ts +31 -0
- package/types/src/charts/Violin/violinLayout.d.ts +64 -0
- package/types/src/charts/Waffle/applyLayout.d.ts +36 -0
- package/types/src/charts/Waffle/emit.d.ts +29 -0
- package/types/src/charts/Waffle/index.d.ts +21 -0
- package/types/src/charts/Waffle/tooltip.d.ts +20 -0
- package/types/src/charts/Waffle/waffleLayout.d.ts +81 -0
- package/types/src/charts/Waterfall/buffer.d.ts +31 -0
- package/types/src/charts/Waterfall/connectors.d.ts +40 -0
- package/types/src/charts/Waterfall/index.d.ts +24 -0
- package/types/src/charts/Waterfall/labels.d.ts +59 -0
- package/types/src/charts/Waterfall/state.d.ts +62 -0
- package/types/src/charts/Waterfall/steps.d.ts +84 -0
- package/types/src/charts/definition/ChartDefinition.d.ts +28 -7
- package/types/src/charts/definition/makeChart.d.ts +3 -1
- package/types/src/charts/drawSteps/bottomRightControls.d.ts +19 -0
- package/types/src/charts/drawSteps/bottomRightControlsMarkup.d.ts +1 -1
- package/types/src/charts/drawSteps/controlButtonStyle.d.ts +21 -0
- package/types/src/charts/drawSteps/searchControlsMarkup.d.ts +2 -6
- package/types/src/charts/drawSteps/topLeftControlsMarkup.d.ts +10 -2
- package/types/src/charts/drawSteps/zoomControlsMarkup.d.ts +9 -0
- package/types/src/charts/drawSteps/zoomGesture.d.ts +17 -0
- package/types/src/charts/drawSteps/zoomShown.d.ts +32 -0
- package/types/src/charts/facet/drawFacets.d.ts +52 -0
- package/types/src/charts/facet/facetConfig.d.ts +178 -0
- package/types/src/charts/facet/facetData.d.ts +47 -0
- package/types/src/charts/facet/facetGrid.d.ts +62 -0
- package/types/src/charts/facet/facetGutter.d.ts +68 -0
- package/types/src/charts/facet/facetPanel.d.ts +24 -0
- package/types/src/charts/facet/facetScene.d.ts +39 -0
- package/types/src/charts/features/axes.d.ts +4 -89
- package/types/src/charts/features/axesFinal.d.ts +66 -0
- package/types/src/charts/features/axesMeasure.d.ts +88 -0
- package/types/src/charts/features/backgroundImageEmit.d.ts +32 -0
- package/types/src/charts/features/features.d.ts +40 -12
- package/types/src/charts/features/featuresLegend.d.ts +10 -2
- package/types/src/charts/features/frozenAxis.d.ts +8 -0
- package/types/src/charts/features/insetState.d.ts +3 -4
- package/types/src/charts/features/legendCategory.d.ts +36 -0
- package/types/src/charts/features/legendLabel.d.ts +3 -6
- package/types/src/charts/features/plotAnnotations.d.ts +38 -0
- package/types/src/charts/features/plotEndLabels.d.ts +108 -0
- package/types/src/charts/features/plotPaint.d.ts +10 -25
- package/types/src/charts/features/sceneBounds.d.ts +8 -2
- package/types/src/charts/features/shapeEmit.d.ts +14 -1
- package/types/src/charts/features/shareKey.d.ts +24 -0
- package/types/src/charts/features/sharedFields.d.ts +22 -0
- package/types/src/charts/features/tooltipSwatch.d.ts +36 -4
- package/types/src/charts/features/xAxisConfig.d.ts +6 -0
- package/types/src/charts/helpers/densityChart.d.ts +62 -0
- package/types/src/charts/helpers/densityData.d.ts +88 -0
- package/types/src/charts/helpers/densityEnter.d.ts +23 -0
- package/types/src/charts/helpers/valueTitle.d.ts +23 -0
- package/types/src/charts/index.d.ts +20 -0
- package/types/src/charts/partition/chartFields.d.ts +29 -0
- package/types/src/charts/partition/hierarchy.d.ts +109 -0
- package/types/src/charts/partition/interaction.d.ts +57 -0
- package/types/src/charts/partition/labelWords.d.ts +50 -0
- package/types/src/charts/partition/shade.d.ts +61 -0
- package/types/src/charts/partition/zoom.d.ts +51 -0
- package/types/src/charts/pipeline/preDrawData.d.ts +34 -0
- package/types/src/charts/pipeline/stages.d.ts +11 -3
- package/types/src/charts/pipeline/vizDraw.d.ts +25 -20
- package/types/src/charts/pipeline/vizPreDraw.d.ts +23 -17
- package/types/src/charts/plotBuffers/Bar.d.ts +9 -12
- package/types/src/charts/plotBuffers/Box.d.ts +8 -11
- package/types/src/charts/plotBuffers/defaultBuffers.d.ts +25 -0
- package/types/src/charts/plotBuffers/numericBuffer.d.ts +1 -1
- package/types/src/charts/plotBuffers/rectLikeBuffer.d.ts +25 -0
- package/types/src/charts/polar/chrome.d.ts +62 -0
- package/types/src/charts/polar/config.d.ts +21 -0
- package/types/src/charts/polar/geometry.d.ts +68 -0
- package/types/src/charts/polar/labels.d.ts +87 -0
- package/types/src/charts/polar/polarFacet.d.ts +33 -0
- package/types/src/charts/polar/wedgeLayout.d.ts +81 -0
- package/types/src/charts/viz/Viz.d.ts +24 -24
- package/types/src/charts/viz/VizBase.d.ts +59 -204
- package/types/src/charts/viz/backgroundInk.d.ts +15 -0
- package/types/src/charts/viz/labelDefaults.d.ts +11 -0
- package/types/src/charts/viz/reserveContainerSize.d.ts +15 -0
- package/types/src/charts/viz/resetChromeBoxes.d.ts +4 -0
- package/types/src/charts/viz/shapeClassTargets.d.ts +25 -0
- package/types/src/charts/viz/shapeHover.d.ts +10 -0
- package/types/src/charts/viz/simpleHover.d.ts +9 -0
- package/types/src/charts/viz/vizDefaults.d.ts +10 -0
- package/types/src/charts/viz/vizFields.d.ts +199 -0
- package/types/src/charts/viz/vizTypes.d.ts +107 -39
- package/types/src/components/Axis/Axis.d.ts +59 -4
- package/types/src/components/Axis/axisBreak.d.ts +86 -0
- package/types/src/components/Axis/axisDefaults.d.ts +11 -0
- package/types/src/components/Axis/axisEndLabels.d.ts +37 -0
- package/types/src/components/Axis/axisLabelThinning.d.ts +48 -0
- package/types/src/components/Axis/axisLayout.d.ts +10 -0
- package/types/src/components/Axis/axisLayoutLabels.d.ts +30 -0
- package/types/src/components/Axis/axisLayoutScale.d.ts +13 -2
- package/types/src/components/Axis/axisRender.d.ts +1 -30
- package/types/src/components/Axis/axisRounding.d.ts +14 -0
- package/types/src/components/Axis/axisScene.d.ts +33 -0
- package/types/src/components/Axis/brokenScale.d.ts +66 -0
- package/types/src/components/Axis/gridStroke.d.ts +8 -0
- package/types/src/components/Axis/timeValues.d.ts +63 -0
- package/types/src/components/Axis/yearValues.d.ts +21 -0
- package/types/src/components/TextBox.d.ts +1 -36
- package/types/src/components/textBoxLayout.d.ts +45 -0
- package/types/src/components/tooltipDom.d.ts +30 -0
- package/types/src/fluent.d.ts +103 -34
- package/types/src/shapes/Box.d.ts +12 -1
- package/types/src/shapes/Shape.d.ts +2 -3
- package/types/src/shapes/Whisker.d.ts +4 -1
- package/types/src/shapes/emitLabels.d.ts +15 -0
- package/types/src/shapes/shapeConfig.d.ts +35 -5
- package/types/src/shapes/shapeOwners.d.ts +10 -0
- package/types/src/shapes/shapeStandalone.d.ts +7 -0
- package/types/src/shapes/uniqueIds.d.ts +6 -0
- package/types/src/shapes/validateShapeConfig.d.ts +20 -3
- package/types/src/utils/BaseClass.d.ts +6 -0
- package/types/src/utils/D3Scale.d.ts +3 -0
- package/types/src/utils/D3plusConfig.d.ts +940 -99
- package/types/src/utils/configPrep.d.ts +3 -2
- package/types/src/utils/configWarnings.d.ts +5 -0
- package/types/src/utils/index.d.ts +1 -1
- package/types/src/utils/wholeWords.d.ts +28 -0
- package/umd/d3plus-core.full.js +74785 -75059
- package/umd/d3plus-core.full.min.js +2 -10702
- package/umd/d3plus-core.js +44707 -23629
- package/umd/d3plus-core.min.js +2 -6671
- package/es/index.js.map +0 -1
- package/es/internal.js.map +0 -1
- package/es/src/charts/AreaPlot/index.js.map +0 -1
- package/es/src/charts/BarChart/index.js.map +0 -1
- package/es/src/charts/BoxWhisker/index.js.map +0 -1
- package/es/src/charts/BumpChart/index.js.map +0 -1
- package/es/src/charts/Chord/applyLayout.js.map +0 -1
- package/es/src/charts/Chord/emit.js.map +0 -1
- package/es/src/charts/Chord/index.js.map +0 -1
- package/es/src/charts/Donut/index.js.map +0 -1
- package/es/src/charts/Geomap/applyLayout.js.map +0 -1
- package/es/src/charts/Geomap/basemapTheme.js.map +0 -1
- package/es/src/charts/Geomap/emit.js.map +0 -1
- package/es/src/charts/Geomap/index.js.map +0 -1
- package/es/src/charts/Histogram/binData.js.map +0 -1
- package/es/src/charts/Histogram/index.js.map +0 -1
- package/es/src/charts/LinePlot/index.js.map +0 -1
- package/es/src/charts/Matrix/applyLayout.js.map +0 -1
- package/es/src/charts/Matrix/emit.js.map +0 -1
- package/es/src/charts/Matrix/index.js.map +0 -1
- package/es/src/charts/Network/applyLayout.js.map +0 -1
- package/es/src/charts/Network/emit.js.map +0 -1
- package/es/src/charts/Network/index.js.map +0 -1
- package/es/src/charts/Pack/applyLayout.js.map +0 -1
- package/es/src/charts/Pack/emit.js.map +0 -1
- package/es/src/charts/Pack/index.js.map +0 -1
- package/es/src/charts/Pack/recursionCircles.js.map +0 -1
- package/es/src/charts/Pie/applyLayout.js.map +0 -1
- package/es/src/charts/Pie/emit.js.map +0 -1
- package/es/src/charts/Pie/index.js.map +0 -1
- package/es/src/charts/Plot/discreteSpan.js.map +0 -1
- package/es/src/charts/Plot/draw.js.map +0 -1
- package/es/src/charts/Plot/index.js.map +0 -1
- package/es/src/charts/Plot/insetRegion.js.map +0 -1
- package/es/src/charts/Plot/labelPlacement.js.map +0 -1
- package/es/src/charts/Plot/pipeline.js.map +0 -1
- package/es/src/charts/Plot/pipelineDomains.js.map +0 -1
- package/es/src/charts/Plot/pipelineLineLabels.js.map +0 -1
- package/es/src/charts/Plot/plotZoom.js.map +0 -1
- package/es/src/charts/Plot/shapeDefaults.js.map +0 -1
- package/es/src/charts/Plot/sharedHover.js.map +0 -1
- package/es/src/charts/Plot/sharedHoverScene.js.map +0 -1
- package/es/src/charts/Plot/sharedTooltip.js.map +0 -1
- package/es/src/charts/Plot/stackHelpers.js.map +0 -1
- package/es/src/charts/Plot/stackShareLabels.js.map +0 -1
- package/es/src/charts/Plot/stackShareTooltip.js.map +0 -1
- package/es/src/charts/Plot/trendLines.js.map +0 -1
- package/es/src/charts/Plot/trendProjection.js.map +0 -1
- package/es/src/charts/Plot/trendScene.js.map +0 -1
- package/es/src/charts/Plot/trendTooltip.js.map +0 -1
- package/es/src/charts/Priestley/applyLayout.js.map +0 -1
- package/es/src/charts/Priestley/emit.js.map +0 -1
- package/es/src/charts/Priestley/index.js.map +0 -1
- package/es/src/charts/Radar/applyLayout.js.map +0 -1
- package/es/src/charts/Radar/emit.js.map +0 -1
- package/es/src/charts/Radar/index.js.map +0 -1
- package/es/src/charts/RadialMatrix/applyLayout.js.map +0 -1
- package/es/src/charts/RadialMatrix/emit.js.map +0 -1
- package/es/src/charts/RadialMatrix/index.js.map +0 -1
- package/es/src/charts/Rings/applyLayout.js.map +0 -1
- package/es/src/charts/Rings/emit.js.map +0 -1
- package/es/src/charts/Rings/index.js.map +0 -1
- package/es/src/charts/Rings/ringsSizing.js.map +0 -1
- package/es/src/charts/Sankey/applyLayout.js.map +0 -1
- package/es/src/charts/Sankey/emit.js.map +0 -1
- package/es/src/charts/Sankey/index.js.map +0 -1
- package/es/src/charts/StackedArea/index.js.map +0 -1
- package/es/src/charts/Tree/applyLayout.js.map +0 -1
- package/es/src/charts/Tree/emit.js.map +0 -1
- package/es/src/charts/Tree/index.js.map +0 -1
- package/es/src/charts/Treemap/applyLayout.js.map +0 -1
- package/es/src/charts/Treemap/emit.js.map +0 -1
- package/es/src/charts/Treemap/index.js.map +0 -1
- package/es/src/charts/Treemap/thresholdFunction.js.map +0 -1
- package/es/src/charts/definition/ChartDefinition.js.map +0 -1
- package/es/src/charts/definition/applyDefinition.js.map +0 -1
- package/es/src/charts/definition/makeChart.js.map +0 -1
- package/es/src/charts/drawSteps/backControl.js.map +0 -1
- package/es/src/charts/drawSteps/bottomRightControls.js.map +0 -1
- package/es/src/charts/drawSteps/bottomRightControlsMarkup.js.map +0 -1
- package/es/src/charts/drawSteps/controlButtonStyle.js.map +0 -1
- package/es/src/charts/drawSteps/minimap.js.map +0 -1
- package/es/src/charts/drawSteps/minimapMarkup.js.map +0 -1
- package/es/src/charts/drawSteps/searchControls.js.map +0 -1
- package/es/src/charts/drawSteps/searchControlsMarkup.js.map +0 -1
- package/es/src/charts/drawSteps/tableView.js.map +0 -1
- package/es/src/charts/drawSteps/tableViewControl.js.map +0 -1
- package/es/src/charts/drawSteps/tableViewMarkup.js.map +0 -1
- package/es/src/charts/drawSteps/topLeftControls.js.map +0 -1
- package/es/src/charts/drawSteps/topLeftControlsMarkup.js.map +0 -1
- package/es/src/charts/drawSteps/zoomControls.js.map +0 -1
- package/es/src/charts/drawSteps/zoomControlsMarkup.js.map +0 -1
- package/es/src/charts/events/click.legend.js.map +0 -1
- package/es/src/charts/events/click.shape.js.map +0 -1
- package/es/src/charts/events/mouseenter.js.map +0 -1
- package/es/src/charts/events/mouseleave.js.map +0 -1
- package/es/src/charts/events/mousemove.legend.js.map +0 -1
- package/es/src/charts/events/mousemove.shape.js.map +0 -1
- package/es/src/charts/events/touchstart.body.js.map +0 -1
- package/es/src/charts/features/attributionFeature.js.map +0 -1
- package/es/src/charts/features/axes.js.map +0 -1
- package/es/src/charts/features/chartGeometry.js.map +0 -1
- package/es/src/charts/features/colorScaleBucket.js.map +0 -1
- package/es/src/charts/features/edgeArrows.js.map +0 -1
- package/es/src/charts/features/emitHelpers.js.map +0 -1
- package/es/src/charts/features/ensureZoomDom.js.map +0 -1
- package/es/src/charts/features/features.js.map +0 -1
- package/es/src/charts/features/featuresColorScale.js.map +0 -1
- package/es/src/charts/features/featuresLegend.js.map +0 -1
- package/es/src/charts/features/insetState.js.map +0 -1
- package/es/src/charts/features/legendLabel.js.map +0 -1
- package/es/src/charts/features/lineLabels.js.map +0 -1
- package/es/src/charts/features/plotPaint.js.map +0 -1
- package/es/src/charts/features/sceneBounds.js.map +0 -1
- package/es/src/charts/features/shapeEmit.js.map +0 -1
- package/es/src/charts/features/tooltipSwatch.js.map +0 -1
- package/es/src/charts/features/zoomExtent.js.map +0 -1
- package/es/src/charts/helpers/matrixData.js.map +0 -1
- package/es/src/charts/helpers/tileAttributions.js.map +0 -1
- package/es/src/charts/index.js.map +0 -1
- package/es/src/charts/pipeline/drillMorph.js.map +0 -1
- package/es/src/charts/pipeline/insetPlacement.js.map +0 -1
- package/es/src/charts/pipeline/resolveSpec.js.map +0 -1
- package/es/src/charts/pipeline/runChartDraw.js.map +0 -1
- package/es/src/charts/pipeline/runVizPipeline.js.map +0 -1
- package/es/src/charts/pipeline/stages.js.map +0 -1
- package/es/src/charts/pipeline/vizContext.js +0 -29
- package/es/src/charts/pipeline/vizContext.js.map +0 -1
- package/es/src/charts/pipeline/vizDraw.js.map +0 -1
- package/es/src/charts/pipeline/vizDrawPure.js +0 -220
- package/es/src/charts/pipeline/vizDrawPure.js.map +0 -1
- package/es/src/charts/pipeline/vizPreDraw.js.map +0 -1
- package/es/src/charts/pipeline/vizPreDrawPure.js +0 -279
- package/es/src/charts/pipeline/vizPreDrawPure.js.map +0 -1
- package/es/src/charts/plotBuffers/Bar.js.map +0 -1
- package/es/src/charts/plotBuffers/Box.js.map +0 -1
- package/es/src/charts/plotBuffers/Circle.js.map +0 -1
- package/es/src/charts/plotBuffers/Line.js.map +0 -1
- package/es/src/charts/plotBuffers/Rect.js.map +0 -1
- package/es/src/charts/plotBuffers/discreteBuffer.js.map +0 -1
- package/es/src/charts/plotBuffers/numericBuffer.js.map +0 -1
- package/es/src/charts/viz/Viz.js.map +0 -1
- package/es/src/charts/viz/VizBase.js.map +0 -1
- package/es/src/charts/viz/VizBaseConfig.js +0 -538
- package/es/src/charts/viz/VizBaseConfig.js.map +0 -1
- package/es/src/charts/viz/interactionOpacity.js.map +0 -1
- package/es/src/charts/viz/linkGroup.js.map +0 -1
- package/es/src/charts/viz/ordinalColor.js.map +0 -1
- package/es/src/charts/viz/sceneRows.js.map +0 -1
- package/es/src/charts/viz/trailCatchup.js.map +0 -1
- package/es/src/charts/viz/vizDefaults.js.map +0 -1
- package/es/src/charts/viz/vizRender.js.map +0 -1
- package/es/src/charts/viz/vizTypes.js.map +0 -1
- package/es/src/charts/viz/vizVisibility.js.map +0 -1
- package/es/src/components/Axis/Axis.js.map +0 -1
- package/es/src/components/Axis/AxisBottom.js.map +0 -1
- package/es/src/components/Axis/AxisLeft.js.map +0 -1
- package/es/src/components/Axis/AxisRight.js.map +0 -1
- package/es/src/components/Axis/AxisTop.js.map +0 -1
- package/es/src/components/Axis/axisLayout.js.map +0 -1
- package/es/src/components/Axis/axisLayoutLabels.js.map +0 -1
- package/es/src/components/Axis/axisLayoutScale.js.map +0 -1
- package/es/src/components/Axis/axisRender.js.map +0 -1
- package/es/src/components/ColorScale/ColorScale.js.map +0 -1
- package/es/src/components/ColorScale/colorScaleRender.js.map +0 -1
- package/es/src/components/ColorScale/colorScaleScale.js.map +0 -1
- package/es/src/components/Legend/Legend.js.map +0 -1
- package/es/src/components/Legend/legendConfig.js.map +0 -1
- package/es/src/components/Legend/legendRender.js.map +0 -1
- package/es/src/components/Message.js.map +0 -1
- package/es/src/components/SizeLegend/SizeLegend.js.map +0 -1
- package/es/src/components/SizeLegend/sizeLegendLayout.js.map +0 -1
- package/es/src/components/TextBox.js.map +0 -1
- package/es/src/components/Timeline/Timeline.js.map +0 -1
- package/es/src/components/Timeline/timelineConfig.js.map +0 -1
- package/es/src/components/Timeline/timelineRender.js.map +0 -1
- package/es/src/components/Tooltip.js.map +0 -1
- package/es/src/components/index.js.map +0 -1
- package/es/src/fluent.js.map +0 -1
- package/es/src/shapes/Area.js.map +0 -1
- package/es/src/shapes/Bar.js.map +0 -1
- package/es/src/shapes/Box.js.map +0 -1
- package/es/src/shapes/Circle.js.map +0 -1
- package/es/src/shapes/Image.js.map +0 -1
- package/es/src/shapes/Line.js.map +0 -1
- package/es/src/shapes/Path.js.map +0 -1
- package/es/src/shapes/Rect.js.map +0 -1
- package/es/src/shapes/Shape.js.map +0 -1
- package/es/src/shapes/Whisker.js.map +0 -1
- package/es/src/shapes/buildLabelData.js.map +0 -1
- package/es/src/shapes/emitLabels.js.map +0 -1
- package/es/src/shapes/hitAreaNode.js.map +0 -1
- package/es/src/shapes/index.js.map +0 -1
- package/es/src/shapes/interactionPoints.js.map +0 -1
- package/es/src/shapes/sceneSort.js.map +0 -1
- package/es/src/shapes/shapeConfig.js.map +0 -1
- package/es/src/shapes/textureKey.js.map +0 -1
- package/es/src/shapes/validateShapeConfig.js.map +0 -1
- package/es/src/utils/AccessorFn.js.map +0 -1
- package/es/src/utils/BaseClass.js.map +0 -1
- package/es/src/utils/D3Scale.js.map +0 -1
- package/es/src/utils/D3plusConfig.js.map +0 -1
- package/es/src/utils/RESET.js.map +0 -1
- package/es/src/utils/accessor.js.map +0 -1
- package/es/src/utils/configDefault.js.map +0 -1
- package/es/src/utils/configPrep.js.map +0 -1
- package/es/src/utils/configWarnings.js.map +0 -1
- package/es/src/utils/constant.js.map +0 -1
- package/es/src/utils/getProp.js.map +0 -1
- package/es/src/utils/index.js.map +0 -1
- package/es/src/utils/paintComponentScene.js.map +0 -1
- package/es/umd-entry.js +0 -16
- package/es/umd-entry.js.map +0 -1
- package/types/src/charts/AreaPlot.d.ts +0 -16
- package/types/src/charts/BarChart.d.ts +0 -16
- package/types/src/charts/BoxWhisker.d.ts +0 -11
- package/types/src/charts/BumpChart.d.ts +0 -36
- package/types/src/charts/ChartDefinition.d.ts +0 -75
- package/types/src/charts/Donut.d.ts +0 -11
- package/types/src/charts/Geomap.d.ts +0 -126
- package/types/src/charts/LinePlot.d.ts +0 -15
- package/types/src/charts/Matrix.d.ts +0 -48
- package/types/src/charts/Network.d.ts +0 -54
- package/types/src/charts/Pack.d.ts +0 -34
- package/types/src/charts/Pie.d.ts +0 -17
- package/types/src/charts/Plot.d.ts +0 -150
- package/types/src/charts/Priestley.d.ts +0 -37
- package/types/src/charts/Radar.d.ts +0 -38
- package/types/src/charts/RadialMatrix.d.ts +0 -63
- package/types/src/charts/Rings.d.ts +0 -61
- package/types/src/charts/Sankey.d.ts +0 -77
- package/types/src/charts/StackedArea.d.ts +0 -14
- package/types/src/charts/Tree.d.ts +0 -17
- package/types/src/charts/Treemap.d.ts +0 -42
- package/types/src/charts/Viz.d.ts +0 -90
- package/types/src/charts/VizBase.d.ts +0 -158
- package/types/src/charts/VizBaseConfig.d.ts +0 -148
- package/types/src/charts/applyDefinition.d.ts +0 -13
- package/types/src/charts/axes.d.ts +0 -134
- package/types/src/charts/chartGeometry.d.ts +0 -58
- package/types/src/charts/drawSteps/drawAttribution.d.ts +0 -7
- package/types/src/charts/drawSteps/drawBack.d.ts +0 -6
- package/types/src/charts/drawSteps/drawColorScale.d.ts +0 -6
- package/types/src/charts/drawSteps/drawLegend.d.ts +0 -12
- package/types/src/charts/drawSteps/drawSubtitle.d.ts +0 -7
- package/types/src/charts/drawSteps/drawTimeline.d.ts +0 -7
- package/types/src/charts/drawSteps/drawTitle.d.ts +0 -7
- package/types/src/charts/drawSteps/drawTotal.d.ts +0 -7
- package/types/src/charts/emitHelpers.d.ts +0 -122
- package/types/src/charts/ensureZoomDom.d.ts +0 -39
- package/types/src/charts/factories.d.ts +0 -73
- package/types/src/charts/features/colorScaleBucketShare.d.ts +0 -16
- package/types/src/charts/features.d.ts +0 -152
- package/types/src/charts/featuresLegend.d.ts +0 -12
- package/types/src/charts/legendLabel.d.ts +0 -11
- package/types/src/charts/lineLabels.d.ts +0 -40
- package/types/src/charts/makeChart.d.ts +0 -22
- package/types/src/charts/pipeline/vizContext.d.ts +0 -45
- package/types/src/charts/pipeline/vizDrawPure.d.ts +0 -46
- package/types/src/charts/pipeline/vizPreDrawPure.d.ts +0 -68
- package/types/src/charts/plotPaint.d.ts +0 -233
- package/types/src/charts/resolveSpec.d.ts +0 -50
- package/types/src/charts/runChartDraw.d.ts +0 -38
- package/types/src/charts/runVizPipeline.d.ts +0 -31
- package/types/src/charts/shapeEmit.d.ts +0 -61
- package/types/src/charts/stages.d.ts +0 -117
- package/types/src/charts/viz/VizBaseConfig.d.ts +0 -175
- package/types/src/charts/vizContext.d.ts +0 -46
- package/types/src/charts/vizDefaults.d.ts +0 -8
- package/types/src/charts/vizDraw.d.ts +0 -25
- package/types/src/charts/vizDrawPure.d.ts +0 -17
- package/types/src/charts/vizPreDraw.d.ts +0 -22
- package/types/src/charts/vizPreDrawPure.d.ts +0 -40
- package/types/src/charts/vizRender.d.ts +0 -8
- package/types/src/charts/vizTypes.d.ts +0 -202
- package/types/src/components/Axis.d.ts +0 -183
- package/types/src/components/AxisBottom.d.ts +0 -11
- package/types/src/components/AxisLeft.d.ts +0 -11
- package/types/src/components/AxisRight.d.ts +0 -11
- package/types/src/components/AxisTop.d.ts +0 -11
- package/types/src/components/ColorScale.d.ts +0 -80
- package/types/src/components/Legend.d.ts +0 -93
- package/types/src/components/Timeline.d.ts +0 -83
- package/types/src/components/axisLayout.d.ts +0 -27
- package/types/src/components/axisLayoutLabels.d.ts +0 -42
- package/types/src/components/axisLayoutScale.d.ts +0 -12
- package/types/src/components/axisRender.d.ts +0 -65
- package/types/src/components/colorScaleRender.d.ts +0 -15
- package/types/src/components/colorScaleScale.d.ts +0 -19
- package/types/src/components/legendConfig.d.ts +0 -7
- package/types/src/components/legendRender.d.ts +0 -16
- package/types/src/components/timelineConfig.d.ts +0 -6
- package/types/src/components/timelineRender.d.ts +0 -14
- package/umd/d3plus-core.full.js.map +0 -1
- package/umd/d3plus-core.js.map +0 -1
|
@@ -2,23 +2,105 @@ import type { ColorDefaults } from "@d3plus/color";
|
|
|
2
2
|
import type { DataPoint } from "@d3plus/data";
|
|
3
3
|
import type VizBase from "../charts/viz/VizBase.js";
|
|
4
4
|
import type { LinkOption } from "../charts/viz/linkGroup.js";
|
|
5
|
+
import type { FacetConfig } from "../charts/facet/facetConfig.js";
|
|
6
|
+
import type { BrushSelection } from "../charts/ParallelCoordinates/brushFilter.js";
|
|
7
|
+
import type { DimensionOptions } from "../charts/ParallelCoordinates/dimensions.js";
|
|
5
8
|
import type { AccessorFn } from "./AccessorFn.js";
|
|
9
|
+
import type { ConstOrAccessor, CssColor, Orient, SideOrient } from "../shapes/shapeConfig.js";
|
|
6
10
|
import type { SizeLegendLineConfig, SizeLegendShapeConfig, SizeLegendTextConfig } from "../components/SizeLegend/SizeLegend.js";
|
|
7
11
|
import type { SizeLegendScale, SizeLegendSize } from "../components/SizeLegend/sizeLegendLayout.js";
|
|
8
12
|
type Position = "top" | "right" | "bottom" | "left";
|
|
13
|
+
/** A legend or colorScale side, or `"auto"` to let the chart choose (inside the chart when it fits, else right on wide charts and bottom otherwise). */
|
|
14
|
+
type PanelPosition = Position | "auto";
|
|
9
15
|
type DataPointAccessor<T> = string | ((d: DataPoint) => T);
|
|
10
16
|
/** A config value that is either a constant or a `(datum, index)` accessor. */
|
|
11
17
|
type Accessor<T> = T | ((d: DataPoint, i?: number) => T);
|
|
12
18
|
type AxisScale = "auto" | "band" | "diverging" | "divergingLog" | "divergingPow" | "divergingSqrt" | "divergingSymlog" | "identity" | "implicit" | "jenks" | "linear" | "log" | "ordinal" | "point" | "pow" | "quantile" | "quantize" | "radial" | "sequential" | "sequentialLog" | "sequentialPow" | "sequentialQuantile" | "sequentialSqrt" | "sequentialSymlog" | "sqrt" | "symlog" | "threshold" | "time" | "utc";
|
|
13
19
|
export interface AxisConfig {
|
|
14
20
|
barConfig?: Record<string, string | number>;
|
|
21
|
+
/**
|
|
22
|
+
The axis's domain: `[min, max]` on a continuous axis, or the
|
|
23
|
+
categories to show on a discrete one. A full domain is drawn exactly
|
|
24
|
+
as given unless this axis config's `rounding` says otherwise, just as
|
|
25
|
+
on an Axis. In a Plot's axis configs it is a lower-level override than
|
|
26
|
+
`xDomain`/`yDomain`: it wins over them, isn't stretched to the
|
|
27
|
+
chart's `baseline`, and isn't rounded by Plot's own "outside"
|
|
28
|
+
default. In `xConfig`/`yConfig`, one with a single end set (`[min]`
|
|
29
|
+
or `[undefined, max]`) on a continuous axis works exactly like
|
|
30
|
+
`yDomain([min])` instead: it pins that end, and the data fills the
|
|
31
|
+
other, rounded as `rounding` says.
|
|
32
|
+
*/
|
|
33
|
+
domain?: (number | string | Date | undefined)[];
|
|
34
|
+
/**
|
|
35
|
+
The value the axis's `baselineBreak` returns to: the tick kept below
|
|
36
|
+
(or above) the break. Defaults to `0`. To start a Plot's value axis at
|
|
37
|
+
a value, set the chart's `baseline` instead, which sets the axis's
|
|
38
|
+
minimum exactly like `yDomain([n])`, break back to this tick included.
|
|
39
|
+
*/
|
|
40
|
+
baseline?: number;
|
|
41
|
+
/**
|
|
42
|
+
When the domain of a linear value axis stops short of the `baseline`
|
|
43
|
+
(e.g. `[1100, 2100]` with a baseline of `0`), keeps the baseline as the
|
|
44
|
+
axis's end tick and breaks the axis between it and the domain: a short
|
|
45
|
+
stretch of axis holds the baseline tick and two tilted marks with a gap
|
|
46
|
+
in the axis line, then the domain spans the rest. Style it with the
|
|
47
|
+
axis's `baselineBreakConfig`. In a Plot it applies to a user-supplied
|
|
48
|
+
value domain (`yDomain`/`yConfig.domain`, or the x versions for
|
|
49
|
+
horizontal charts), and bars and areas start at the baseline tick,
|
|
50
|
+
with the break's gap cut across them (`baselineBreakConfig`'s
|
|
51
|
+
`mask`); turned off, a `yDomain` stretches to reach the baseline while a
|
|
52
|
+
`yConfig.domain` is kept and cuts its bars off at the axis. Defaults
|
|
53
|
+
to `true` for the Plots whose marks grow from `0`, such as BarChart,
|
|
54
|
+
AreaPlot, Histogram, and Lollipop (each chart lists its own default),
|
|
55
|
+
and `false` for other Plots and a standalone Axis.
|
|
56
|
+
*/
|
|
57
|
+
baselineBreak?: boolean;
|
|
58
|
+
/**
|
|
59
|
+
Style of the baseline break: `space` (pixels of axis between the baseline
|
|
60
|
+
tick and the first tick after the break, default `36`), `gap` (pixels
|
|
61
|
+
between the two marks, where the axis line is not drawn, default `5`),
|
|
62
|
+
`size` (length of each mark, drawn outward from the axis line on the
|
|
63
|
+
tick side so it never reaches into the plot, default `10`), `angle`
|
|
64
|
+
(degrees each mark tilts from perpendicular to the axis, default `30`),
|
|
65
|
+
`lines` (whether a Plot runs a straight line across the plot from the
|
|
66
|
+
foot of each mark, perpendicular to the axis, default `true`; they take
|
|
67
|
+
the axis line's `barConfig` style), `lineConfig` (those lines'
|
|
68
|
+
`stroke`, `stroke-width`, and other line styles, layered over the axis
|
|
69
|
+
line style), `mask` (whether a Plot cuts the gap between the two
|
|
70
|
+
lines straight across the shapes, default `true`), plus `stroke`,
|
|
71
|
+
`stroke-width`, and the other line styles `barConfig` takes, for the
|
|
72
|
+
marks.
|
|
73
|
+
*/
|
|
74
|
+
baselineBreakConfig?: Record<string, string | number | boolean | Record<string, string | number>>;
|
|
75
|
+
/**
|
|
76
|
+
Value ranges to remove from a linear axis: one `[start, end]` pair, or a
|
|
77
|
+
list of them (`[[start, end], [start, end]]`). Each range collapses to a
|
|
78
|
+
short fixed gap in the axis, marked like the baseline break, with no
|
|
79
|
+
ticks or gridlines inside it and both of its edges labeled; the values
|
|
80
|
+
on either side keep one shared scale. Reversed pairs are flipped,
|
|
81
|
+
overlapping ones merged, and ranges that don't lie strictly inside the
|
|
82
|
+
domain (or that don't leave room for the data) are ignored. Only
|
|
83
|
+
positions change — tooltips and labels still show the real values.
|
|
84
|
+
*/
|
|
85
|
+
break?: false | [number, number] | [number, number][];
|
|
86
|
+
/**
|
|
87
|
+
Style of the ranges set with `break`: the same `space`, `gap`, `size`,
|
|
88
|
+
`angle`, `lines`, `lineConfig`, `mask`, and mark line styles, with the
|
|
89
|
+
same defaults, as `baselineBreakConfig`.
|
|
90
|
+
*/
|
|
91
|
+
breakConfig?: Record<string, string | number | boolean | Record<string, string | number>>;
|
|
15
92
|
/** Grid values of the axis. */
|
|
16
93
|
grid?: unknown[];
|
|
17
94
|
gridConfig?: Record<string, string | number>;
|
|
18
95
|
/** Grid size of the axis. */
|
|
19
96
|
gridSize?: number;
|
|
20
97
|
label?: string;
|
|
21
|
-
/**
|
|
98
|
+
/**
|
|
99
|
+
Visible tick labels of the axis. Also takes a list of label lists, from
|
|
100
|
+
the most labels to the fewest: the axis labels the first list whose
|
|
101
|
+
labels all fit whole without crowding, else the last one, thinned. Its
|
|
102
|
+
ticks then follow the chosen list unless `ticks` is set.
|
|
103
|
+
*/
|
|
22
104
|
labels?: unknown[];
|
|
23
105
|
labelOffset?: false | number;
|
|
24
106
|
/**
|
|
@@ -36,9 +118,34 @@ export interface AxisConfig {
|
|
|
36
118
|
but one may be `undefined` to allow the default behavior for that value.
|
|
37
119
|
*/
|
|
38
120
|
range?: (number | undefined)[];
|
|
121
|
+
/**
|
|
122
|
+
Tick formatter for labels drawn rotated (see `labelRotation`), in place
|
|
123
|
+
of `tickFormat`: rotation is decided by measuring the labels this way,
|
|
124
|
+
so a long label can rotate in a shorter form.
|
|
125
|
+
*/
|
|
126
|
+
rotatedTickFormat?: (d: number | string) => string | number;
|
|
127
|
+
/**
|
|
128
|
+
How a linear or log axis rounds its domain to "nice" values:
|
|
129
|
+
"outside" widens each end past the data, "inside" pulls each end in
|
|
130
|
+
(marking them with the `roundingInside*` prefixes and suffixes), and
|
|
131
|
+
"none" keeps the domain as given. Defaults to "none" on an Axis; a
|
|
132
|
+
Plot rounds "outside" unless its axis config says otherwise or sets a
|
|
133
|
+
full `domain`, which is rounded only when asked for here. With a
|
|
134
|
+
user domain on a Plot (`xDomain`/`yDomain`, `baseline`, or a
|
|
135
|
+
one-sided `domain` here) only an end left open is rounded:
|
|
136
|
+
`yDomain([n])` keeps `n` exactly and rounds the far end where the
|
|
137
|
+
axis would with no domain set, and "none" leaves that end at the
|
|
138
|
+
data. A `yDomain` with both ends set isn't rounded unless `rounding`
|
|
139
|
+
is set here.
|
|
140
|
+
*/
|
|
141
|
+
rounding?: "none" | "outside" | "inside";
|
|
39
142
|
/** Scale of the axis. */
|
|
40
143
|
scale?: AxisScale;
|
|
41
|
-
/**
|
|
144
|
+
/** The shape drawn at each tick: `"Line"` (the default), `"Rect"`, or `"Circle"`. */
|
|
145
|
+
shape?: "Line" | "Rect" | "Circle";
|
|
146
|
+
/** Tick style of the axis. */
|
|
147
|
+
shapeConfig?: Record<string, unknown>;
|
|
148
|
+
/** Tick formatter, called with the axis as `this`. Defaults to the locale's abbreviated number format ("1.5k"), with years printed in full ("1990") when the axis's values are all whole numbers from 1000 through 2999. */
|
|
42
149
|
tickFormat?: (d: number | string) => string | number;
|
|
43
150
|
/** Tick values of the axis. */
|
|
44
151
|
ticks?: unknown[];
|
|
@@ -59,12 +166,14 @@ export interface AxisConfig {
|
|
|
59
166
|
timeLocale?: Record<string, unknown>;
|
|
60
167
|
/** Title of the axis. */
|
|
61
168
|
title?: string;
|
|
169
|
+
/** Title configuration of the axis. */
|
|
170
|
+
titleConfig?: Record<string, unknown>;
|
|
62
171
|
}
|
|
63
172
|
export interface TooltipConfig {
|
|
64
173
|
/** The inner HTML content of the arrow element, empty by default. */
|
|
65
174
|
arrow?: ((d: DataPoint) => string) | string;
|
|
66
175
|
/** The background color accessor for each tooltip. */
|
|
67
|
-
background?: ((d: DataPoint) =>
|
|
176
|
+
background?: ((d: DataPoint) => CssColor) | CssColor;
|
|
68
177
|
/** The border accessor for each tooltip. */
|
|
69
178
|
border?: ((d: DataPoint) => string) | string;
|
|
70
179
|
/** The border-radius accessor for each tooltip. */
|
|
@@ -80,10 +189,28 @@ export interface TooltipConfig {
|
|
|
80
189
|
/** The inner padding of each tooltip. */
|
|
81
190
|
padding?: ((d: DataPoint) => string | number) | string | number;
|
|
82
191
|
title?: ((d: DataPoint) => string) | string;
|
|
192
|
+
/**
|
|
193
|
+
Whether a chart's tooltip title leads with a swatch of the hovered
|
|
194
|
+
shape's color and shape. `true` by default; set it in `legendTooltip`
|
|
195
|
+
to drop the swatch from legend tooltips only.
|
|
196
|
+
*/
|
|
197
|
+
titleSwatch?: boolean;
|
|
198
|
+
/** Overall CSS styles applied to the tooltip container. */
|
|
199
|
+
tooltipStyle?: Record<string, string>;
|
|
83
200
|
body?: ((d: DataPoint) => string) | string;
|
|
201
|
+
/**
|
|
202
|
+
Header rows. A cell function receives `(d, i, x)`; in Pie, Treemap, and
|
|
203
|
+
stacked Plot charts `x.share` is the row's fraction of its total, unless
|
|
204
|
+
the data has its own `share` field (then `x.share` is that field).
|
|
205
|
+
*/
|
|
84
206
|
thead?: ((d: DataPoint) => [string, string][]) | Array<Array<((d: DataPoint, i?: number, x?: {
|
|
85
207
|
share: number;
|
|
86
208
|
}) => string) | string>>;
|
|
209
|
+
/**
|
|
210
|
+
Body rows. A cell function receives `(d, i, x)`; in Pie, Treemap, and
|
|
211
|
+
stacked Plot charts `x.share` is the row's fraction of its total, unless
|
|
212
|
+
the data has its own `share` field (then `x.share` is that field).
|
|
213
|
+
*/
|
|
87
214
|
tbody?: ((d: DataPoint) => [string, string][]) | Array<Array<((d: DataPoint, i?: number, x?: {
|
|
88
215
|
share: number;
|
|
89
216
|
}) => string) | string>>;
|
|
@@ -92,7 +219,7 @@ export interface TextBoxConfig {
|
|
|
92
219
|
/** The text content for each box. */
|
|
93
220
|
text?: Accessor<string>;
|
|
94
221
|
/** The font color as an accessor function or static string. Inferred from the DOM selection by default. */
|
|
95
|
-
fontColor?: Accessor<
|
|
222
|
+
fontColor?: Accessor<CssColor>;
|
|
96
223
|
/** The font size in pixels. Inferred from the DOM selection by default. */
|
|
97
224
|
fontSize?: Accessor<number>;
|
|
98
225
|
/**
|
|
@@ -112,7 +239,7 @@ export interface TextBoxConfig {
|
|
|
112
239
|
/** The font opacity as an accessor function or static number between 0 and 1. */
|
|
113
240
|
fontOpacity?: Accessor<number>;
|
|
114
241
|
/** The font stroke color for the rendered text. */
|
|
115
|
-
fontStroke?: Accessor<
|
|
242
|
+
fontStroke?: Accessor<CssColor>;
|
|
116
243
|
/** The font stroke width for the rendered text. */
|
|
117
244
|
fontStrokeWidth?: Accessor<number>;
|
|
118
245
|
/** The line height, which is 1.2 times the font size by default. */
|
|
@@ -141,6 +268,8 @@ export interface TextBoxConfig {
|
|
|
141
268
|
x?: Accessor<number>;
|
|
142
269
|
/** The y position (top edge) for each text box. */
|
|
143
270
|
y?: Accessor<number>;
|
|
271
|
+
/** The outline text wraps within, `"square"` or `"circle"`, or a `(datum, index)` accessor. */
|
|
272
|
+
shape?: "square" | "circle" | ((d: DataPoint, i: number) => "square" | "circle");
|
|
144
273
|
}
|
|
145
274
|
export interface TimelineConfig {
|
|
146
275
|
/** Brush event filter. */
|
|
@@ -234,7 +363,7 @@ export interface TrendLineConfig {
|
|
|
234
363
|
/** Shows the fitted equation, R², and observations when hovering a line. Defaults to `true`. */
|
|
235
364
|
tooltip?: boolean;
|
|
236
365
|
/** Line color. Defaults to the series color (dark gray when `group` is `"all"`). */
|
|
237
|
-
stroke?:
|
|
366
|
+
stroke?: CssColor;
|
|
238
367
|
/** Line width in pixels. Defaults to 2. */
|
|
239
368
|
strokeWidth?: number;
|
|
240
369
|
/** Line dash pattern. Defaults to `"6 4"`. */
|
|
@@ -263,6 +392,14 @@ export interface ColorScaleConfig {
|
|
|
263
392
|
export type ColorDefaultsConfig = Partial<Omit<ColorDefaults, "scale">> & {
|
|
264
393
|
scale?: ColorDefaults["scale"] | string[];
|
|
265
394
|
};
|
|
395
|
+
/** One `confidence` bound: a data key, an accessor, or `false` for none. */
|
|
396
|
+
export type ConfidenceBound = string | ((d: DataPoint, i: number) => number) | false;
|
|
397
|
+
/** One `confidence` band: a `[lower, upper]` pair, `[lower, upper, label]`, or a `{lower, upper, label}` object. */
|
|
398
|
+
export type ConfidenceBandSetting = [ConfidenceBound, ConfidenceBound] | [ConfidenceBound, ConfidenceBound, string] | {
|
|
399
|
+
lower?: ConfidenceBound;
|
|
400
|
+
upper?: ConfidenceBound;
|
|
401
|
+
label?: string;
|
|
402
|
+
};
|
|
266
403
|
export interface D3plusConfig {
|
|
267
404
|
/** Data array or URL string to load data from. */
|
|
268
405
|
data?: DataPoint[] | string;
|
|
@@ -277,105 +414,456 @@ export interface D3plusConfig {
|
|
|
277
414
|
/** Hides the SVG from assistive technology when true (`aria-hidden`). */
|
|
278
415
|
ariaHidden?: boolean;
|
|
279
416
|
/**
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
417
|
+
The Radar's axis styles, named after the parts of a Plot axis: the
|
|
418
|
+
inner level rings are its gridlines (`gridConfig`, a faint stroke like
|
|
419
|
+
Plot's gridlines), the outer ring is its axis line (`barConfig`, the
|
|
420
|
+
chart's background ink), and the spokes and metric labels are its ticks
|
|
421
|
+
(`shapeConfig`, with `shapeConfig.labelConfig` for the labels). Ring
|
|
422
|
+
styles take `stroke`, `strokeWidth`, `strokeOpacity`,
|
|
423
|
+
`strokeDasharray`, and `opacity` (or Plot's `"stroke-width"` spelling),
|
|
424
|
+
each a value or a `(ring, i) => value` accessor.
|
|
425
|
+
*/
|
|
426
|
+
axisConfig?: {
|
|
427
|
+
barConfig?: Record<string, unknown>;
|
|
428
|
+
gridConfig?: Record<string, unknown>;
|
|
429
|
+
shapeConfig?: Record<string, unknown>;
|
|
430
|
+
};
|
|
431
|
+
/**
|
|
432
|
+
Sets text to be shown positioned absolute on top of the visualization in the bottom-right corner. This is most often used in Geomaps to display the copyright of map tiles. The text is rendered as HTML, so any valid HTML string will render as expected (eg. anchor links work).
|
|
285
433
|
*/
|
|
286
434
|
attribution?: string | boolean;
|
|
287
435
|
/**
|
|
288
|
-
Overrides the "ⓘ"
|
|
289
|
-
otherwise renders as an inline SVG. A string is used as the badge's
|
|
290
|
-
raw HTML content; a mount function, `(el: HTMLElement) => void | (() =>
|
|
291
|
-
void)`, is called once with the badge's reserved element so a live
|
|
292
|
-
component (a React tree via `createRoot(el).render(...)`, or anything
|
|
293
|
-
else imperative) can be mounted into it — return a cleanup function if
|
|
294
|
-
there's teardown to do.
|
|
436
|
+
Overrides the "ⓘ" icon a long attribution collapses to (see `attribution`), which otherwise renders as an inline SVG. Accepts an HTML string — used as the toggle button's content — or a mount function, `(el: HTMLElement) => void | (() => void)`, called once with the button's reserved icon slot so a live component (a React tree via `createRoot(el).render(...)`, or anything else imperative) can be mounted into it. A returned cleanup function runs right before that slot is discarded, which happens whenever the credit's markup regenerates (its text or theme changes), not just once per chart.
|
|
295
437
|
*/
|
|
296
438
|
attributionIcon?: string | ((el: HTMLElement) => void | (() => void));
|
|
297
439
|
/** CSS key/value pairs used to style the attribution text. */
|
|
298
440
|
attributionStyle?: Record<string, unknown>;
|
|
299
|
-
/**
|
|
441
|
+
/**
|
|
442
|
+
An additional CSS class name (or space-separated list of class names) applied to the back button, alongside its fixed `back-control` class. Setting this automatically disables d3plus's built-in inline `backControlStyle` default (as long as you haven't already customized it yourself), so a host page's own button styling — Tailwind, Bootstrap, a design system — applies through the cascade with no other configuration needed.
|
|
443
|
+
*/
|
|
300
444
|
backControlClassName?: string;
|
|
445
|
+
/**
|
|
446
|
+
An object containing CSS key/value pairs that is used to style the back button. Passing `false` will remove all default styling. Automatically skipped (as if `false`) once `.backControlClassName(...)` is set, unless you've explicitly customized this yourself.
|
|
447
|
+
*/
|
|
448
|
+
backControlStyle?: Record<string, unknown> | false;
|
|
301
449
|
/** Padding between bars in pixels. */
|
|
302
450
|
barPadding?: number;
|
|
303
|
-
/**
|
|
451
|
+
/**
|
|
452
|
+
BarChart/Marimekko: makes each bar as wide as its own measure (a data
|
|
453
|
+
key or accessor, read off the merge of the bar's rows, so numbers sum
|
|
454
|
+
unless `aggs` says otherwise). The bars sit end to end along a
|
|
455
|
+
continuous axis of cumulative width, each labeled at its center, and
|
|
456
|
+
tooltips show each bar's width and its share of the total. Off by
|
|
457
|
+
default on BarChart; on Marimekko, `false` turns it off.
|
|
458
|
+
*/
|
|
459
|
+
barWidth?: string | false | ((d: DataPoint, i?: number) => number);
|
|
460
|
+
/**
|
|
461
|
+
BarChart/Marimekko with `barWidth`: whether each category's axis label
|
|
462
|
+
also shows its bar's share of the total width, beneath the name along
|
|
463
|
+
a horizontal axis ("Retail" over "50%") and after it along a vertical
|
|
464
|
+
one ("Retail (50%)"). Along a horizontal axis, a name wraps to fit
|
|
465
|
+
a narrow bar, widening into room its neighbors leave; a label that
|
|
466
|
+
still can't fit is left out, and the labels rotate, showing the name
|
|
467
|
+
alone, only when half or more can't fit. The tooltip always shows the
|
|
468
|
+
share. In small
|
|
469
|
+
multiples (`facet`), each panel's shares are of that panel's own total
|
|
470
|
+
width and add to 100%, even when shared scales draw a smaller panel
|
|
471
|
+
narrower.
|
|
472
|
+
On for Marimekko, off for BarChart.
|
|
473
|
+
*/
|
|
474
|
+
barWidthShare?: boolean;
|
|
475
|
+
/**
|
|
476
|
+
Starts a Plot's value axis (the x axis for horizontal charts) at a
|
|
477
|
+
value: `baseline(n)` renders exactly like `yDomain([n])` (or
|
|
478
|
+
`xDomain([n])`). Bars, areas, and stems still grow from the chart's
|
|
479
|
+
own `0` in the Plots that draw from one (such as BarChart, AreaPlot,
|
|
480
|
+
Histogram, and Lollipop), so with `baselineBreak` on (their default)
|
|
481
|
+
the axis breaks back to a `0`
|
|
482
|
+
tick and bars run through the break, with its gap cut across them,
|
|
483
|
+
and with it off the axis
|
|
484
|
+
stretches down to `0`. As with `yDomain([n])`, only `n` is
|
|
485
|
+
pinned: the far end comes from the data and is rounded where the
|
|
486
|
+
axis would round it with no domain set (left at the data when the
|
|
487
|
+
axis config's `rounding` is "none"), and marks for values past `n`
|
|
488
|
+
stop at the axis's edge.
|
|
489
|
+
When every value sits at or below `n`, it ends the axis instead,
|
|
490
|
+
like `yDomain([undefined, n])`. A bound given in
|
|
491
|
+
`yDomain`/`xDomain` wins.
|
|
492
|
+
*/
|
|
304
493
|
baseline?: number;
|
|
494
|
+
/**
|
|
495
|
+
When the domain of a linear value axis stops short of the `baseline`
|
|
496
|
+
(e.g. `[1100, 2100]` with a baseline of `0`), keeps the baseline as the
|
|
497
|
+
axis's end tick and breaks the axis between it and the domain: a short
|
|
498
|
+
stretch of axis holds the baseline tick and two tilted marks with a gap
|
|
499
|
+
in the axis line, then the domain spans the rest. Style it with the
|
|
500
|
+
axis's `baselineBreakConfig`. In a Plot it applies to a user-supplied
|
|
501
|
+
value domain (`yDomain`/`yConfig.domain`, or the x versions for
|
|
502
|
+
horizontal charts), and bars and areas start at the baseline tick,
|
|
503
|
+
with the break's gap cut across them (`baselineBreakConfig`'s
|
|
504
|
+
`mask`); turned off, a `yDomain` stretches to reach the baseline while a
|
|
505
|
+
`yConfig.domain` is kept and cuts its bars off at the axis. Defaults
|
|
506
|
+
to `true` for the Plots whose marks grow from `0`, such as BarChart,
|
|
507
|
+
AreaPlot, Histogram, and Lollipop (each chart lists its own default),
|
|
508
|
+
and `false` for other Plots and a standalone Axis.
|
|
509
|
+
*/
|
|
510
|
+
baselineBreak?: boolean;
|
|
511
|
+
/** Bullet: the qualitative ranges behind each measure, as threshold values (`[60, 85]`) or band objects (`{min, max, color}`), or a `(d, i) => bands` accessor for per-row bands. */
|
|
512
|
+
bands?: (number | {
|
|
513
|
+
min?: number;
|
|
514
|
+
max?: number;
|
|
515
|
+
color?: string;
|
|
516
|
+
})[] | ((d: DataPoint, i: number) => (number | {
|
|
517
|
+
min?: number;
|
|
518
|
+
max?: number;
|
|
519
|
+
color?: string;
|
|
520
|
+
})[]);
|
|
521
|
+
/** Candlestick: the share of each period's room its candle body (or OHLC ticks) spans, from 0 to 1. Defaults to `0.7`. */
|
|
522
|
+
bodyWidth?: number;
|
|
523
|
+
/**
|
|
524
|
+
ParallelCoordinates: the brush strips over each axis — `width` (px), the
|
|
525
|
+
selection's `fill`, `fillOpacity`, `stroke`, and `strokeWidth`, and
|
|
526
|
+
`inactiveOpacity`, the stroke opacity of the grayed lines outside the
|
|
527
|
+
brushes (by default 30% of each line's own opacity).
|
|
528
|
+
*/
|
|
529
|
+
brushConfig?: Record<string, unknown>;
|
|
530
|
+
/**
|
|
531
|
+
ParallelCoordinates: the active brush filters, keyed by dimension — a
|
|
532
|
+
numeric `[min, max]` or a list of selected categories. Rows must pass
|
|
533
|
+
every brush. Brushing an axis updates it, and `on("brush", fn)` is called
|
|
534
|
+
with the new value; `{}` clears every brush.
|
|
535
|
+
*/
|
|
536
|
+
brushes?: BrushSelection;
|
|
537
|
+
/**
|
|
538
|
+
ParallelCoordinates: whether each axis can be brushed to filter the
|
|
539
|
+
lines (default `true`). Clicking an axis outside its brush,
|
|
540
|
+
double-clicking it, or pressing Escape while it has focus clears it.
|
|
541
|
+
*/
|
|
542
|
+
brushing?: boolean;
|
|
543
|
+
/** Bullet: the most each bullet's band can be thick, in pixels (default 40); raise it to let rows fill a tall chart. */
|
|
544
|
+
bulletSize?: number;
|
|
305
545
|
/** Whether to cache the processed data between renders. */
|
|
306
546
|
cache?: boolean;
|
|
547
|
+
/** Calendar: styles the weekday, month, and year labels (`fontColor`, `fontFamily`, `fontSize`, default `11`, and `fontWeight`). */
|
|
548
|
+
calendarLabelConfig?: {
|
|
549
|
+
fontColor?: string;
|
|
550
|
+
fontFamily?: string | string[];
|
|
551
|
+
fontSize?: number;
|
|
552
|
+
fontWeight?: number | string;
|
|
553
|
+
};
|
|
554
|
+
/** Matrix and Calendar: the gap between neighboring cells, in pixels. */
|
|
555
|
+
cellPadding?: number;
|
|
556
|
+
/** Calendar: each cell's corner radius, in pixels (kept below a third of the cell). Defaults to `2`. */
|
|
557
|
+
cellRadius?: number;
|
|
558
|
+
/**
|
|
559
|
+
Candlestick: accessor or data key for each period's closing value
|
|
560
|
+
(default `"close"`). It is the chart's `y`: setting `y` sets it.
|
|
561
|
+
*/
|
|
562
|
+
close?: string | ((d: DataPoint, i: number) => number);
|
|
563
|
+
/**
|
|
564
|
+
Defines the main color to be used for each data point in a visualization. Can be either an accessor function or a string key to reference in each data point. If a color value is returned, it will be used as is. If a string is returned, a unique color will be assigned based on the string.
|
|
565
|
+
|
|
566
|
+
When the color is a category that isn't one of the `groupBy` levels (for example, points grouped by `"country"` and colored by `"region"`), the legend shows one entry per category, labelled by the category. Clicking, shift+clicking, or hovering an entry hides, solos, or highlights every item in that category.
|
|
567
|
+
*/
|
|
568
|
+
color?: string | ((d: DataPoint, i: number) => DataPoint[keyof DataPoint]) | false;
|
|
307
569
|
/** Overrides for the default colors used for data fills and legible text (see `colorDefaults` in @d3plus/color). */
|
|
308
570
|
colorDefaults?: ColorDefaultsConfig;
|
|
309
571
|
/** Treat a discrete color field as ordered: color it with a single-hue light→dark ramp instead of nominal categorical hues. */
|
|
310
572
|
colorOrdinal?: boolean;
|
|
311
|
-
/**
|
|
312
|
-
|
|
313
|
-
|
|
573
|
+
/**
|
|
574
|
+
Defines the value to be used for a color scale. Can be either an accessor function or a string key to reference in each data point.
|
|
575
|
+
*/
|
|
576
|
+
colorScale?: string | ((d: DataPoint, i: number) => DataPoint[keyof DataPoint]) | false;
|
|
577
|
+
/** A pass-through to the config method of ColorScale. */
|
|
314
578
|
colorScaleConfig?: {
|
|
315
579
|
axisConfig?: AxisConfig;
|
|
316
580
|
centered?: boolean;
|
|
317
581
|
colors?: string[];
|
|
318
|
-
colorMin?:
|
|
319
|
-
colorMid?:
|
|
320
|
-
colorMax?:
|
|
582
|
+
colorMin?: CssColor;
|
|
583
|
+
colorMid?: CssColor;
|
|
584
|
+
colorMax?: CssColor;
|
|
321
585
|
scale?: AxisScale;
|
|
322
586
|
};
|
|
323
|
-
/**
|
|
587
|
+
/**
|
|
588
|
+
The maximum pixel size for drawing the color scale: width for horizontal scales and height for vertical scales.
|
|
589
|
+
*/
|
|
590
|
+
colorScaleMaxSize?: number;
|
|
591
|
+
/**
|
|
592
|
+
Tells the colorScale whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the colorScale appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.
|
|
593
|
+
*/
|
|
324
594
|
colorScalePadding?: boolean | ((viz: VizBase) => boolean);
|
|
325
|
-
/**
|
|
326
|
-
|
|
595
|
+
/**
|
|
596
|
+
Defines which side of the visualization to anchor the color scale. Acceptable values are `"auto"` (the default), `"top"`, `"bottom"`, `"left"`, `"right"`, and `false`. `"auto"` lets the chart choose: inside the chart when it fits there (see `legendInset`), otherwise the right side of charts more than 1.5 times as wide as they are tall and the bottom of all others. Any other side keeps the color scale there. A `false` value will cause the color scale to not be displayed, but will still color shapes based on the scale.
|
|
597
|
+
*/
|
|
598
|
+
colorScalePosition?: false | PanelPosition | (() => false | PanelPosition);
|
|
327
599
|
/** Column key for matrix-style layouts. */
|
|
328
600
|
column?: string;
|
|
601
|
+
/** Pyramid: where the category labels go — `"center"` (a gutter between the halves, the default) or `"left"`. */
|
|
602
|
+
categoryPosition?: "center" | "left";
|
|
603
|
+
/** Pyramid: a comparison value per row (data key or accessor), drawn as an outline around each side's bars. */
|
|
604
|
+
comparison?: string | ((d: DataPoint, i: number) => number) | false;
|
|
605
|
+
/** Pyramid: line styles for the comparison outline (`stroke`, `strokeWidth`, `strokeOpacity`, `strokeDasharray`), each optionally a function of the side value and its index. */
|
|
606
|
+
comparisonConfig?: Record<string, unknown>;
|
|
607
|
+
/** Waterfall: draws a thin line from the end of each bar to the start of the next. */
|
|
608
|
+
connectors?: boolean;
|
|
329
609
|
/**
|
|
330
610
|
The confidence interval as `[lower, upper]` bounds — each given as an
|
|
331
611
|
accessor function or a static data key (e.g. `["lci", "hci"]`), or `false`
|
|
332
|
-
to disable.
|
|
612
|
+
to disable (no band or error bars, no axis widening, no tooltip bounds).
|
|
613
|
+
Lines draw it as a band, bars as error bars; a row without a bound
|
|
614
|
+
pinches the band onto its line. An array of bands, outermost first, draws
|
|
615
|
+
nested bands around each line (a fan) — each a `[lower, upper]` pair,
|
|
616
|
+
`[lower, upper, label]`, or `{lower, upper, label}` — shaded by
|
|
617
|
+
`confidenceConfig.bandOpacity`, with each band's range listed in
|
|
618
|
+
tooltips under its label (bars draw the first band).
|
|
333
619
|
*/
|
|
334
|
-
confidence?: [
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
620
|
+
confidence?: ConfidenceBandSetting | ConfidenceBandSetting[] | false;
|
|
621
|
+
/**
|
|
622
|
+
Styles the `confidence` interval: a line's band (an Area) or a bar's
|
|
623
|
+
error bar (a Path, with `stroke`, `strokeWidth`, and `capWidth` — the end
|
|
624
|
+
caps' length in pixels or as a percentage string of the bar's thickness).
|
|
625
|
+
Keys nested under `Area` or `Bar` apply only to that shape. `tooltip:
|
|
626
|
+
false` leaves the bounds out of tooltips. With nested bands,
|
|
627
|
+
`bandOpacity` sets how each band looks where it is the innermost band
|
|
628
|
+
drawn — an array ramps from the outermost band to the innermost
|
|
629
|
+
(default `[0.15, 0.6]`), a number gives every band that opacity — in
|
|
630
|
+
place of `fillOpacity`. Accepted keys: any Area or Path key,
|
|
631
|
+
`bandOpacity`, `capWidth`, `tooltip`, `Area` (Area keys), and `Bar`
|
|
632
|
+
(Path keys and `capWidth`); any other key logs a warning.
|
|
633
|
+
*/
|
|
634
|
+
confidenceConfig?: Record<string, unknown>;
|
|
635
|
+
/** Funnel: fills the gap between consecutive stages with a neck joining their widths. */
|
|
636
|
+
connector?: boolean;
|
|
637
|
+
/**
|
|
638
|
+
Funnel: paint for the necks between stages (`fill`, `opacity`,
|
|
639
|
+
`stroke`, `strokeWidth`), each optionally a function of the stage the
|
|
640
|
+
neck leads into. Waterfall: line styles for the connectors between bars
|
|
641
|
+
(`stroke`, `strokeWidth`, `strokeOpacity`, `strokeDasharray`), each
|
|
642
|
+
optionally a function of the row the connector leaves and its index.
|
|
643
|
+
*/
|
|
644
|
+
connectorConfig?: Record<string, unknown>;
|
|
645
|
+
/** Funnel: the conversion rates each stage's label shows: `"first"`, `"previous"`, `"both"` (or `true`), or `false`. */
|
|
646
|
+
conversion?: boolean | "first" | "previous" | "both" | ("first" | "previous")[];
|
|
338
647
|
/**
|
|
339
648
|
Paint for the shared tooltip's crosshair guide line (`stroke`,
|
|
340
649
|
`strokeWidth`, `strokeDasharray`, `strokeOpacity`, …).
|
|
341
650
|
*/
|
|
342
651
|
crosshairConfig?: Record<string, unknown>;
|
|
652
|
+
/**
|
|
653
|
+
Funnel: how the width changes between stages, `"linear"` (straight
|
|
654
|
+
sides) or `"smooth"` (curved). ParallelCoordinates: `"linear"`
|
|
655
|
+
(default) draws straight segments between the axes; `"bump"` curves
|
|
656
|
+
into and out of each axis.
|
|
657
|
+
*/
|
|
658
|
+
curve?: "linear" | "smooth" | "bump";
|
|
343
659
|
/** Maximum number of data points to render before downsampling. */
|
|
344
660
|
dataCutoff?: number;
|
|
661
|
+
/**
|
|
662
|
+
Calendar: the day each row falls on, as a data key or accessor returning
|
|
663
|
+
a `Date`, a millisecond timestamp, or a date string (a bare
|
|
664
|
+
`"YYYY-MM-DD"` is read as that local day). Defaults to the row's `date`,
|
|
665
|
+
else its `time`.
|
|
666
|
+
*/
|
|
667
|
+
date?: string | ((d: DataPoint, i: number) => Date | number | string);
|
|
668
|
+
/** Waterfall: fill for bars that lower the running total. Defaults to `colorDefaults.off`. */
|
|
669
|
+
decreaseColor?: string;
|
|
670
|
+
/**
|
|
671
|
+
Kernel density options for Violin and Ridgeline curves: `kernel`
|
|
672
|
+
(`"gaussian"` or `"epanechnikov"`), `bandwidth` (in data units; each
|
|
673
|
+
group's own Silverman rule-of-thumb bandwidth by default), `points` (how
|
|
674
|
+
many values each curve is evaluated at, default 80), and `cut` (how far
|
|
675
|
+
each curve runs past its group's smallest and largest value, in
|
|
676
|
+
bandwidths: 2 for Violin, 3 for Ridgeline).
|
|
677
|
+
*/
|
|
678
|
+
densityConfig?: {
|
|
679
|
+
kernel?: "gaussian" | "epanechnikov" | ((u: number) => number);
|
|
680
|
+
bandwidth?: number | ((values: number[]) => number);
|
|
681
|
+
points?: number;
|
|
682
|
+
cut?: number;
|
|
683
|
+
};
|
|
684
|
+
/**
|
|
685
|
+
How Violin and Ridgeline curves are sized against each other: `"area"`
|
|
686
|
+
(default) gives every shape the same area, `"count"` makes areas
|
|
687
|
+
proportional to each group's observations, and `"width"` scales every
|
|
688
|
+
shape to the full width (Violin) or height (Ridgeline).
|
|
689
|
+
*/
|
|
690
|
+
densityScale?: "area" | "count" | "width";
|
|
345
691
|
/** Active depth level for nested groupings. */
|
|
346
692
|
depth?: number;
|
|
693
|
+
/**
|
|
694
|
+
If the width and/or height of a Viz is not user-defined, it is determined by the size of it's parent element. When this method is set to `true`, the Viz will listen for the `window.onresize` event and adjust it's dimensions accordingly.
|
|
695
|
+
*/
|
|
696
|
+
detectResize?: boolean;
|
|
697
|
+
/**
|
|
698
|
+
When resizing the browser window, this is the millisecond delay to trigger the resize event.
|
|
699
|
+
*/
|
|
700
|
+
detectResizeDelay?: number;
|
|
701
|
+
/**
|
|
702
|
+
Toggles whether or not the Viz should try to detect if it visible in the current viewport. When this method is set to `true`, the Viz will only be rendered when it has entered the viewport either through scrolling or if it's display or visibility is changed.
|
|
703
|
+
*/
|
|
704
|
+
detectVisible?: boolean;
|
|
705
|
+
/**
|
|
706
|
+
The interval, in milliseconds, for checking if the visualization is visible on the page. When `detectVisible` defers a render until the visualization scrolls into view, this is also how long it must stay in view before it renders, so visualizations scrolled past quickly are never drawn.
|
|
707
|
+
*/
|
|
708
|
+
detectVisibleInterval?: number;
|
|
709
|
+
/**
|
|
710
|
+
When `true` (the default) and `detectVisible` is enabled, the Viz releases its DOM and scene while it is scrolled out of view and redraws when it returns, keeping the page light when there are many visualizations. Data and configuration are retained; interaction state such as zoom or selection is not, so set this to `false` to keep it. With `detectVisible` enabled, each chart's `<svg>` is also given `content-visibility: auto`, so the browser skips rendering its contents while it is far off-screen (this matters most when this is `false` and charts are kept). For a larger saving you can also apply `content-visibility: auto` and a `contain-intrinsic-size` to the container element yourself; that adds paint containment to an element you own, so it is not done automatically. Requires `IntersectionObserver`.
|
|
711
|
+
*/
|
|
712
|
+
detectVisibleUnload?: boolean;
|
|
713
|
+
/**
|
|
714
|
+
ParallelCoordinates: per-dimension options, keyed by dimension — `domain`
|
|
715
|
+
(either end of a numeric domain may be `undefined`), `reverse`, `title`,
|
|
716
|
+
and any Axis config (`tickFormat`, `ticks`, `scale`, …).
|
|
717
|
+
*/
|
|
718
|
+
dimensionConfig?: Record<string, DimensionOptions>;
|
|
719
|
+
/**
|
|
720
|
+
ParallelCoordinates: the data keys to draw an axis for, in order.
|
|
721
|
+
Defaults to every numeric key except the `groupBy` keys and `id`; a key
|
|
722
|
+
whose values aren't all numbers gets a categorical axis.
|
|
723
|
+
*/
|
|
724
|
+
dimensions?: string[];
|
|
347
725
|
/** Sets orientation of main category axis. */
|
|
348
|
-
discrete?: "x" | "y";
|
|
726
|
+
discrete?: "x" | "y" | "radius" | "angle";
|
|
727
|
+
/** Candlestick: the color of periods that closed below their open, or an accessor of the row. Defaults to red. */
|
|
728
|
+
downColor?: string | ((d: DataPoint, i: number) => string);
|
|
349
729
|
/** Default duration of transitions, in milliseconds. */
|
|
350
730
|
duration?: number;
|
|
731
|
+
/** Calendar: the fill of days without a value. Defaults to a faint tint of the chart's text color, legible on light and dark backgrounds. */
|
|
732
|
+
emptyFill?: string;
|
|
733
|
+
/** Splits the chart into small multiples: one equally sized panel per distinct value of this data key or accessor, sharing one legend, color scale, title, and timeline. `false` draws a single chart. */
|
|
734
|
+
facet?: string | ((d: DataPoint, i: number) => unknown) | false;
|
|
735
|
+
/** Layout and scale sharing for small multiples (see `facet`): `columns`, `rows`, `padding`, `sort`, `scales` (`"shared"` or `"independent"`), `axes` (`"outer"` or `"all"`, for both axes or per axis as `{x, y}`), `title`, and `titleConfig`. */
|
|
736
|
+
facetConfig?: FacetConfig;
|
|
737
|
+
/**
|
|
738
|
+
Fills the area between two series' lines, in the color of whichever
|
|
739
|
+
series is higher, switching color where the lines cross: `true` fills
|
|
740
|
+
between the first two series, `[a, b]` between the series with ids `a`
|
|
741
|
+
and `b`, and a list of `[a, b]` pairs fills between each pair. The fill
|
|
742
|
+
follows the lines' curve and leaves pointer events to the lines.
|
|
743
|
+
Defaults to `false`.
|
|
744
|
+
*/
|
|
745
|
+
fillBetween?: boolean | [string | number, string | number] | [string | number, string | number][];
|
|
746
|
+
/**
|
|
747
|
+
Area styles for `fillBetween` (default `{fillOpacity: 0.25}`). Style
|
|
748
|
+
accessors receive a data row of whichever series is higher, with
|
|
749
|
+
`above` and `below` keys naming the higher and lower series, so a
|
|
750
|
+
`fill` accessor can color the A > B and B > A regions apart. Like a
|
|
751
|
+
confidence band, the fill takes `texture`, `textureDefault`,
|
|
752
|
+
`backgroundImage`, and `backgroundImageFit` from `shapeConfig` (or
|
|
753
|
+
`shapeConfig.Area`), so a texture accessor that picks a series
|
|
754
|
+
textures the regions where that series is higher; set them here to
|
|
755
|
+
style the fill alone, or to `false` to keep it plain.
|
|
756
|
+
*/
|
|
757
|
+
fillBetweenConfig?: Record<string, unknown>;
|
|
351
758
|
/** Predicate filtering which data points are included, or false to disable. */
|
|
352
759
|
filter?: ((d: DataPoint, i: number) => boolean) | false;
|
|
353
760
|
/** Allows removing specific geographies from topojson file to improve zoom. */
|
|
354
761
|
fitFilter?: number | string | ((d: Record<string, unknown>) => boolean);
|
|
762
|
+
/**
|
|
763
|
+
Marks a forecast: the stretch of the discrete axis after it gets a
|
|
764
|
+
shaded backdrop, a rule at its start, and a translated "Forecast"
|
|
765
|
+
label, and each line's forecast stretch is dashed (see
|
|
766
|
+
`forecastConfig`). A function flags the forecast rows (e.g.
|
|
767
|
+
`d => d.Type === "Predicted"`): each line is dashed from its last
|
|
768
|
+
unflagged point, or throughout when every row is flagged, and the
|
|
769
|
+
backdrop starts at the earliest of those. `"auto"` (or `true`) flags
|
|
770
|
+
the rows whose `confidence` bounds spread away from their line. A
|
|
771
|
+
discrete-axis value (a date or year on a time axis) starts the
|
|
772
|
+
forecast there. Unset (the default), only a trend line projection
|
|
773
|
+
(`trendLineConfig.projection`) is marked, from the last fitted value;
|
|
774
|
+
`false` marks nothing, not even a projection. On bar charts the
|
|
775
|
+
backdrop starts at the edge of the first forecast bar, and bars keep
|
|
776
|
+
their own styles. Defaults to `"auto"` on a FanChart.
|
|
777
|
+
|
|
778
|
+
Bullet: each row's forecast (or other comparative measure), drawn as
|
|
779
|
+
a paler bar behind the measure: a data key, an accessor returning the
|
|
780
|
+
row's value, a number shared by every row, or `false`.
|
|
781
|
+
*/
|
|
782
|
+
forecast?: boolean | "auto" | number | string | Date | ((d: DataPoint, i: number) => boolean | number);
|
|
783
|
+
/**
|
|
784
|
+
Styles for the `forecast` marker: the backdrop's `fill` and
|
|
785
|
+
`fillOpacity` (default `0.05`; `fill: false` hides it), the rule's
|
|
786
|
+
`stroke`, `strokeWidth` (`1`), `strokeOpacity` (`0.4`), and
|
|
787
|
+
`strokeDasharray` (`"4 4"`; `stroke: false` hides it), the label's
|
|
788
|
+
text as `label` (default "Forecast", translated; `false` hides it)
|
|
789
|
+
with `fontColor`, `fontFamily`, `fontSize` (`12`), `fontWeight`, and
|
|
790
|
+
`fontOpacity` (`0.7`), and `lineDasharray`, the dash pattern of each
|
|
791
|
+
line's forecast stretch (default `"6 4"`; `false` keeps lines solid).
|
|
792
|
+
Colors default to the chart's text color for its background. The
|
|
793
|
+
backdrop is chart chrome with no data row, so `shapeConfig.texture`
|
|
794
|
+
and `shapeConfig.backgroundImage` leave it plain; give it its own
|
|
795
|
+
`texture` (a textures.js name or config, drawn in the backdrop's color
|
|
796
|
+
over its shade at `textureOpacity`, default `0.3`, with
|
|
797
|
+
`textureDefault`) or `backgroundImage` (a URL,
|
|
798
|
+
fit by `backgroundImageFit`, `"cover"` or `"contain"`). Both are off
|
|
799
|
+
by default.
|
|
800
|
+
|
|
801
|
+
Bullet: the forecast bar's `size` (a fraction of the band's
|
|
802
|
+
thickness), `opacity`, `fill`, `texture`, and
|
|
803
|
+
`backgroundImage`/`backgroundImageFit`, each a value or a `(d, i)`
|
|
804
|
+
accessor.
|
|
805
|
+
*/
|
|
806
|
+
forecastConfig?: Record<string, unknown>;
|
|
807
|
+
/**
|
|
808
|
+
Dumbbell: orders the categories by their gap, the distance between each
|
|
809
|
+
category's smallest and largest value. `"descending"` puts the widest gap
|
|
810
|
+
first (at the top of horizontal dumbbells, at the left of vertical ones),
|
|
811
|
+
`"ascending"` the narrowest, and `false` keeps the category axis's own
|
|
812
|
+
order. A `ySort`/`xSort` comparator on the category axis takes precedence.
|
|
813
|
+
*/
|
|
814
|
+
gapSort?: false | "ascending" | "descending";
|
|
355
815
|
/** Grouping key(s) or accessor function(s). */
|
|
356
816
|
groupBy?: string | string[] | ((d: DataPoint) => string | number) | ((d: DataPoint) => string | number)[];
|
|
357
817
|
/** Padding between groups of bars in pixels. */
|
|
358
818
|
groupPadding?: number;
|
|
359
819
|
/** Overall height of the visualization in pixels. */
|
|
360
820
|
height?: number;
|
|
361
|
-
/**
|
|
362
|
-
|
|
363
|
-
|
|
821
|
+
/**
|
|
822
|
+
Defines the color used for legend shapes when the corresponding grouping is hidden from display (by clicking on the legend).
|
|
823
|
+
*/
|
|
824
|
+
hiddenColor?: CssColor | ((d: DataPoint, i: number) => CssColor);
|
|
825
|
+
/**
|
|
826
|
+
Defines the opacity used for legend labels when the corresponding grouping is hidden from display (by clicking on the legend).
|
|
827
|
+
*/
|
|
364
828
|
hiddenOpacity?: number | ((d: DataPoint, i: number) => number);
|
|
365
829
|
/** The hover callback function for highlighting shapes on mouseover. */
|
|
366
830
|
hover?: ((d: DataPoint, i: number) => boolean) | false | null;
|
|
831
|
+
/** Candlestick: accessor or data key for each period's highest value (default `"high"`). */
|
|
832
|
+
high?: string | ((d: DataPoint, i: number) => number);
|
|
367
833
|
/** Persistently emphasizes matching marks (keep color) and grays the rest. */
|
|
368
834
|
highlight?: ((d: DataPoint, i: number) => boolean) | false | null;
|
|
369
|
-
/**
|
|
835
|
+
/**
|
|
836
|
+
Candlestick: draws rising candles as outlines and falling candles
|
|
837
|
+
filled (default `true`), so direction reads without relying on color;
|
|
838
|
+
`false` fills both.
|
|
839
|
+
*/
|
|
840
|
+
hollow?: boolean;
|
|
841
|
+
/** Waterfall: fill for bars that raise the running total. Defaults to `colorDefaults.on`. */
|
|
842
|
+
increaseColor?: string;
|
|
843
|
+
/**
|
|
844
|
+
What Violin draws inside each violin: `"box"` (default; a narrow box
|
|
845
|
+
plot), `"quartiles"` (a solid line at the median and dashed lines at the
|
|
846
|
+
quartiles), `"points"` (the observations packed into a swarm), an array
|
|
847
|
+
of several, or `false` for nothing.
|
|
848
|
+
*/
|
|
849
|
+
inner?: "box" | "quartiles" | "points" | ("box" | "quartiles" | "points")[] | false;
|
|
850
|
+
/** Styles for Violin's `inner` overlays: `box` (Box config), `quartiles` (Line config), and `points` (Circle config). */
|
|
851
|
+
innerConfig?: {
|
|
852
|
+
box?: Record<string, unknown>;
|
|
853
|
+
quartiles?: Record<string, unknown>;
|
|
854
|
+
points?: Record<string, unknown>;
|
|
855
|
+
};
|
|
856
|
+
/**
|
|
857
|
+
Accessor function, or a constant string applied to every data point's
|
|
858
|
+
label (unlike `value`/`nodeId`/etc., a string here is not treated as a
|
|
859
|
+
per-datum object key — pass a function for that).
|
|
860
|
+
*/
|
|
370
861
|
label?: string | string[] | false | AccessorFn;
|
|
371
862
|
/**
|
|
372
|
-
|
|
373
|
-
show it, or a `(config, data) => boolean` accessor to decide dynamically
|
|
374
|
-
— the chart defaults use an accessor to auto-hide the legend when it
|
|
375
|
-
would be redundant.
|
|
863
|
+
Whether to display the legend. By default, the legend shows when it has more than one entry and each entry stands for a single group (or two groups at most), or when the entries are colored by a category that isn't a `groupBy` level (see `color`), in which case each entry is labelled by its category. Pass `false` to hide it, `true` to always show it, or a `(config, data) => boolean` function to decide.
|
|
376
864
|
*/
|
|
377
865
|
legend?: boolean | ((config: D3plusConfig, arr: DataPoint[]) => boolean);
|
|
378
|
-
/** Configuration
|
|
866
|
+
/** Configuration object passed to the legend's config method. */
|
|
379
867
|
legendConfig?: {
|
|
380
868
|
label?: DataPointAccessor<string>;
|
|
381
869
|
/**
|
|
@@ -387,20 +875,22 @@ export interface D3plusConfig {
|
|
|
387
875
|
shape?: "Rect" | "Circle" | "Line" | DataPointAccessor<string>;
|
|
388
876
|
shapeConfig?: Record<string, string | number>;
|
|
389
877
|
};
|
|
390
|
-
/**
|
|
878
|
+
/**
|
|
879
|
+
Defines the click functionality of categorical legend squares. When set to false, clicking will hide that category and shift+clicking will solo that category. When set to true, clicking with solo that category and shift+clicking will hide that category.
|
|
880
|
+
*/
|
|
391
881
|
legendFilterInvert?: boolean | ((viz: VizBase) => boolean);
|
|
392
882
|
/**
|
|
393
|
-
Whether
|
|
394
|
-
marks instead of in a margin (size legend first, then legend, then
|
|
395
|
-
colorScale), or an accessor receiving the resolved config. Defaults to `true`.
|
|
883
|
+
Whether the chart may draw one of its legends inside the empty space around its marks instead of in a margin, for charts that leave open space around their marks, such as Plot and the charts built on it, Network, Pack, Pie, and Geomap; a chart whose marks fill its area, like Treemap, keeps its legends in the margins. After the chart lays out, the size legend is tried first, then the legend, then the colorScale; the first that fits is drawn over a semi-transparent box (see `legendInsetConfig`), and any others keep their margins. Space enclosed by the marks, like the middle of a ring of points, is never used. Only a legend or colorScale whose position is `"auto"` (the default) can move inside; one set to a side stays in that margin. Defaults to `true`; also accepts a function that receives the resolved chart config and returns a boolean.
|
|
396
884
|
*/
|
|
397
885
|
legendInset?: boolean | ((config: D3plusConfig) => boolean);
|
|
398
|
-
/**
|
|
886
|
+
/**
|
|
887
|
+
Style of the box drawn behind a legend placed inside the chart (see `legendInset`): `fill` (defaults to the chart's background color), `fillOpacity` (0.85), `stroke` (defaults to a faint contrasting line), `strokeWidth` (1), `rx` (corner radius, 4), `margin` (space between the box's edge and the legend, 6), and `padding` (space kept between the box and the chart's marks and edges, 10).
|
|
888
|
+
*/
|
|
399
889
|
legendInsetConfig?: {
|
|
400
890
|
/** Box fill; defaults to the chart's background color. */
|
|
401
|
-
fill?:
|
|
891
|
+
fill?: CssColor;
|
|
402
892
|
fillOpacity?: number;
|
|
403
|
-
stroke?:
|
|
893
|
+
stroke?: CssColor;
|
|
404
894
|
strokeWidth?: number;
|
|
405
895
|
/** Corner radius. */
|
|
406
896
|
rx?: number;
|
|
@@ -409,30 +899,134 @@ export interface D3plusConfig {
|
|
|
409
899
|
/** Space kept between the box and the chart's marks and edges. */
|
|
410
900
|
padding?: number;
|
|
411
901
|
};
|
|
412
|
-
/**
|
|
902
|
+
/**
|
|
903
|
+
Tells the legend whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the legend appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.
|
|
904
|
+
*/
|
|
413
905
|
legendPadding?: boolean | ((viz: VizBase) => boolean);
|
|
414
|
-
/**
|
|
415
|
-
|
|
906
|
+
/**
|
|
907
|
+
Defines which side of the visualization to anchor the legend. Expected values are `"auto"` (the default), `"top"`, `"bottom"`, `"left"`, `"right"`, and `false` to hide it. `"auto"` lets the chart choose: inside the chart when it fits there (see `legendInset`), otherwise the right side of charts more than 1.5 times as wide as they are tall and the bottom of all others. Any other side keeps the legend there.
|
|
908
|
+
*/
|
|
909
|
+
legendPosition?: false | PanelPosition | (() => false | PanelPosition);
|
|
416
910
|
/** Custom sort comparator for legend items. */
|
|
417
911
|
legendSort?: (a: DataPoint, b: DataPoint) => number;
|
|
418
|
-
/**
|
|
912
|
+
/** Configuration object for the legend tooltip. */
|
|
419
913
|
legendTooltip?: TooltipConfig;
|
|
914
|
+
/**
|
|
915
|
+
Formats the Radar's level value labels. Receives the ring's value and
|
|
916
|
+
returns its label. Defaults to the abbreviated number format the axes
|
|
917
|
+
use (`1.5k`, `2M`, …).
|
|
918
|
+
*/
|
|
919
|
+
levelFormat?: (d: number) => string | number;
|
|
920
|
+
/**
|
|
921
|
+
Direction of the Radar's level value labels, in degrees clockwise from
|
|
922
|
+
12 o'clock. `0` (the default) runs the labels straight up from the
|
|
923
|
+
center. Each label sits just inside its ring, offset to the clockwise
|
|
924
|
+
side of that direction so neither line crosses the text. Spokes start
|
|
925
|
+
at 3 o'clock, so the spoke for the metric at index `i` of `n` sits at
|
|
926
|
+
`90 + 360 * i / n` degrees.
|
|
927
|
+
*/
|
|
928
|
+
levelLabelAngle?: number;
|
|
929
|
+
/** Style of the Radar's level value labels. */
|
|
930
|
+
levelLabelConfig?: {
|
|
931
|
+
/** Text color. Defaults to the color that contrasts with the chart's background. */
|
|
932
|
+
fontColor?: CssColor;
|
|
933
|
+
/** Font family. Defaults to the chart's `fontFamily`. */
|
|
934
|
+
fontFamily?: string | string[];
|
|
935
|
+
/** Text opacity. Defaults to `1`. */
|
|
936
|
+
fontOpacity?: number;
|
|
937
|
+
/** Font size, in pixels. Defaults to `10`. */
|
|
938
|
+
fontSize?: number;
|
|
939
|
+
/** Font weight. Defaults to `400`. */
|
|
940
|
+
fontWeight?: number | string;
|
|
941
|
+
};
|
|
942
|
+
/** Whether the Radar labels each level ring with its value. Defaults to `true`. */
|
|
943
|
+
levelLabels?: boolean;
|
|
944
|
+
/**
|
|
945
|
+
The Radar's level rings. A number (default `6`) is the approximate ring
|
|
946
|
+
count: the radial domain is rounded out to "nice" values and the rings
|
|
947
|
+
sit on its ticks, the same way axis ticks are chosen. An array sets the
|
|
948
|
+
exact ring values.
|
|
949
|
+
*/
|
|
950
|
+
levels?: number | number[];
|
|
951
|
+
/** ParallelCoordinates: the lines' stroke opacity, or `"auto"` (default) to fade them as their number grows. */
|
|
952
|
+
lineOpacity?: number | "auto";
|
|
420
953
|
/** Whether to show labels on line charts. */
|
|
421
954
|
lineLabels?: boolean;
|
|
955
|
+
/**
|
|
956
|
+
RadialBar's sweep, in degrees from `startAngle`. Defaults to 270 for
|
|
957
|
+
tracks and 360 for the circular bar chart.
|
|
958
|
+
*/
|
|
959
|
+
maxAngle?: number;
|
|
422
960
|
/** Links this chart to every other chart with the same group name, so hovering, `active`, `highlight` (including search), and legend hide/solo clicks in one are mirrored in the rest, and a value gets the same categorical color in every chart. Rows match across charts by the value of `by` (a data key or accessor), which defaults to the chart's own id. A string is shorthand for `{group}`; set `hover`, `active`, `highlight`, `legend`, or `color` to `false` to stop sharing that behavior. */
|
|
423
961
|
link?: LinkOption;
|
|
424
|
-
/**
|
|
962
|
+
/**
|
|
963
|
+
Toggles the visibility of the status message that is displayed when loading AJAX requests and displaying errors.
|
|
964
|
+
*/
|
|
425
965
|
loadingMessage?: boolean;
|
|
426
|
-
/**
|
|
966
|
+
/**
|
|
967
|
+
The inner HTML of the status message displayed when loading AJAX requests and displaying errors. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.
|
|
968
|
+
*/
|
|
427
969
|
loadingHTML?: string | ((viz: VizBase) => string);
|
|
970
|
+
/** Candlestick: accessor or data key for each period's lowest value (default `"low"`). */
|
|
971
|
+
low?: string | ((d: DataPoint, i: number) => number);
|
|
972
|
+
/** Bullet: the measure bar's thickness, as a fraction of the band's thickness. */
|
|
973
|
+
measureSize?: number;
|
|
974
|
+
/** Orders Violin and Ridgeline categories by median: `false` (default; data order), `"ascending"`, or `"descending"`. */
|
|
975
|
+
medianSort?: false | "ascending" | "descending";
|
|
976
|
+
/**
|
|
977
|
+
The color of the mask displayed underneath the status message when loading AJAX requests and displaying errors. Set to `false` to turn off the mask completely.
|
|
978
|
+
*/
|
|
979
|
+
messageMask?: string | boolean;
|
|
980
|
+
/**
|
|
981
|
+
Defines the CSS style properties for the status message that is displayed when loading AJAX requests and displaying errors.
|
|
982
|
+
*/
|
|
983
|
+
messageStyle?: Record<string, unknown>;
|
|
428
984
|
/** Metric key for the visualization. */
|
|
429
985
|
metric?: string;
|
|
430
986
|
/** Shows a small overview + draggable-viewport minimap underneath the zoom controls once the chart is zoomed in. On by default whenever `zoom` is enabled. */
|
|
431
987
|
minimap?: boolean;
|
|
432
|
-
/**
|
|
988
|
+
/**
|
|
989
|
+
An additional CSS class name (or space-separated list of class names) applied to the minimap's outer box, viewport box, and zoom-level label, alongside their fixed `d3plus-minimap` / `d3plus-minimap-viewport` / `d3plus-minimap-label` classes. Setting this automatically disables d3plus's built-in inline `minimapStyle`/`minimapViewportStyle`/`minimapViewportStyleActive`/`minimapLabelStyle` defaults (as long as you haven't already customized them yourself), so a host page's own styling applies through the cascade with no other configuration needed.
|
|
990
|
+
*/
|
|
433
991
|
minimapClassName?: string;
|
|
434
|
-
/**
|
|
992
|
+
/**
|
|
993
|
+
An object containing CSS key/value pairs that is used to style the minimap's zoom-level text label (e.g. "2x"). Passing `false` will remove all default styling. Automatically skipped (as if `false`) once `.minimapClassName(...)` is set, unless you've explicitly customized this yourself.
|
|
994
|
+
*/
|
|
995
|
+
minimapLabelStyle?: Record<string, unknown> | false;
|
|
996
|
+
/**
|
|
997
|
+
An object containing CSS key/value pairs that is used to style the minimap's outer box (the full-scene overview). Passing `false` will remove all default styling. Automatically skipped (as if `false`) once `.minimapClassName(...)` is set, unless you've explicitly customized this yourself.
|
|
998
|
+
*/
|
|
999
|
+
minimapStyle?: Record<string, unknown> | false;
|
|
1000
|
+
/**
|
|
1001
|
+
An object containing CSS key/value pairs that is used to style the minimap's draggable viewport box in its resting state. Passing `false` will remove all default styling. Automatically skipped (as if `false`) once `.minimapClassName(...)` is set, unless you've explicitly customized this yourself.
|
|
1002
|
+
*/
|
|
1003
|
+
minimapViewportStyle?: Record<string, unknown> | false;
|
|
1004
|
+
/**
|
|
1005
|
+
An object containing CSS key/value pairs that is used to style the minimap's draggable viewport box while it's being dragged. Passing `false` will remove all default styling. Automatically skipped (as if `false`) once `.minimapClassName(...)` is set, unless you've explicitly customized this yourself.
|
|
1006
|
+
*/
|
|
1007
|
+
minimapViewportStyleActive?: Record<string, unknown> | false;
|
|
1008
|
+
/**
|
|
1009
|
+
Calendar: formats the month names along year blocks and the titles of
|
|
1010
|
+
month blocks — a d3-time-format specifier read in the chart's `locale`,
|
|
1011
|
+
a function of the month's first day, or `false` for none.
|
|
1012
|
+
*/
|
|
1013
|
+
monthFormat?: string | ((date: Date) => string) | false;
|
|
1014
|
+
/** Calendar: whether to outline each month inside year blocks. Defaults to `true`. */
|
|
1015
|
+
monthOutline?: boolean;
|
|
1016
|
+
/** Calendar: styles the month outlines (`stroke`, `strokeWidth`, `strokeDasharray`). */
|
|
1017
|
+
monthOutlineConfig?: {
|
|
1018
|
+
stroke?: string;
|
|
1019
|
+
strokeWidth?: number;
|
|
1020
|
+
strokeDasharray?: number[];
|
|
1021
|
+
};
|
|
1022
|
+
/**
|
|
1023
|
+
The inner HTML of the status message displayed when no data is supplied to the visualization. Must be a valid HTML string or a function that, when passed this Viz instance, returns a valid HTML string.
|
|
1024
|
+
*/
|
|
435
1025
|
noDataHTML?: string | ((viz: VizBase) => string);
|
|
1026
|
+
/**
|
|
1027
|
+
Toggles the visibility of the status message that is displayed when no data is supplied to the visualization.
|
|
1028
|
+
*/
|
|
1029
|
+
noDataMessage?: boolean;
|
|
436
1030
|
/**
|
|
437
1031
|
Ocean color for geomaps (any CSS value including 'transparent'), or a
|
|
438
1032
|
`{light, dark}` pair chosen by the chart's backdrop. Defaults to the
|
|
@@ -444,6 +1038,34 @@ export interface D3plusConfig {
|
|
|
444
1038
|
};
|
|
445
1039
|
/** Event listeners keyed by event name. */
|
|
446
1040
|
on?: Record<string, (event: Event) => void>;
|
|
1041
|
+
/** Candlestick: accessor or data key for each period's opening value (default `"open"`). */
|
|
1042
|
+
open?: string | ((d: DataPoint, i: number) => number);
|
|
1043
|
+
/**
|
|
1044
|
+
Layout direction. Charts that can be drawn either way take
|
|
1045
|
+
`"horizontal"` or `"vertical"`, as do Box shapes. Whisker shapes take the
|
|
1046
|
+
side they point toward: `"top"`, `"bottom"`, `"left"`, or `"right"`.
|
|
1047
|
+
Shapes also accept a per-datum accessor.
|
|
1048
|
+
*/
|
|
1049
|
+
orient?: ConstOrAccessor<Orient | SideOrient>;
|
|
1050
|
+
/**
|
|
1051
|
+
How far Ridgeline's tallest ridge rises, in category steps (default
|
|
1052
|
+
1.5): 1 reaches the next baseline up, larger values overlap the ridges
|
|
1053
|
+
above.
|
|
1054
|
+
*/
|
|
1055
|
+
overlap?: number;
|
|
1056
|
+
/**
|
|
1057
|
+
Room (px) the Radar reserves around its web for the metric labels.
|
|
1058
|
+
`"auto"` (the default) measures the labels and gives the web the largest
|
|
1059
|
+
radius at which every label fits inside the chart, wrapping long labels
|
|
1060
|
+
onto two lines (and truncating what still doesn't fit) rather than
|
|
1061
|
+
shrinking the web below half its largest possible size. A number
|
|
1062
|
+
reserves exactly that much room and wraps labels to that width.
|
|
1063
|
+
*/
|
|
1064
|
+
outerPadding?: number | "auto";
|
|
1065
|
+
/** Pyramid: draws each value as a fraction of the frame's total, with the axis and tooltip reading percentages. */
|
|
1066
|
+
percent?: boolean;
|
|
1067
|
+
/** Calendar: what each block covers — `"year"` (the default; whole years, stacked) or `"month"` (whole months, as a grid of small calendars). */
|
|
1068
|
+
period?: "year" | "month";
|
|
447
1069
|
/** Coordinate accessor for point-based geomaps. */
|
|
448
1070
|
point?: (d: DataPoint) => number[];
|
|
449
1071
|
/** Point size accessor for geomaps. */
|
|
@@ -458,16 +1080,52 @@ export interface D3plusConfig {
|
|
|
458
1080
|
projectionPadding?: number | string;
|
|
459
1081
|
/** Rotation offset for the map projection center. */
|
|
460
1082
|
projectionRotate?: [number, number];
|
|
1083
|
+
/**
|
|
1084
|
+
How PolarArea maps values onto radii: `"sqrt"` (default) keeps each
|
|
1085
|
+
wedge's area proportional to its value; `"linear"` its radius.
|
|
1086
|
+
*/
|
|
1087
|
+
radialScale?: "sqrt" | "linear";
|
|
461
1088
|
/** Row key for matrix-style layouts. */
|
|
462
1089
|
row?: string;
|
|
463
|
-
/**
|
|
464
|
-
|
|
1090
|
+
/**
|
|
1091
|
+
If using scroll or visibility detection, this method allow a custom override of the element to which the scroll detection function gets attached.
|
|
1092
|
+
*/
|
|
1093
|
+
scrollContainer?: string | HTMLElement | Window;
|
|
465
1094
|
/** Shows a top-left search button that expands into an input; typing highlights shapes whose label matches. On by default for every chart. */
|
|
466
1095
|
search?: boolean;
|
|
467
|
-
/**
|
|
1096
|
+
/**
|
|
1097
|
+
Resolves the string the search box matches its typed term against, for
|
|
1098
|
+
a given datum. Defaults to the mark's resolved on-screen label
|
|
1099
|
+
(`viz._drawLabel`) — the same text the user reads on the chart.
|
|
1100
|
+
Override it to match against something else instead, e.g. a data
|
|
1101
|
+
field that isn't shown as the label.
|
|
1102
|
+
|
|
1103
|
+
This is checked alongside, not instead of, every level of the datum's
|
|
1104
|
+
own groupBy hierarchy — searching a leaf's label also matches its
|
|
1105
|
+
ancestor group's cell/legend entry, and vice versa, regardless of
|
|
1106
|
+
this accessor's override.
|
|
1107
|
+
*/
|
|
468
1108
|
searchAccessor?: (d: DataPoint, i: number) => string;
|
|
469
|
-
/**
|
|
1109
|
+
/**
|
|
1110
|
+
An additional CSS class name (or space-separated list of class names) applied to the search toggle button and input, alongside their fixed `search-control` classes. Setting this automatically disables d3plus's built-in inline `searchControlStyle`/`searchControlStyleActive`/`searchControlStyleHover` defaults (as long as you haven't already customized them yourself), so a host page's own button styling — Tailwind, Bootstrap, a design system — applies through the cascade with no other configuration needed.
|
|
1111
|
+
*/
|
|
470
1112
|
searchControlClassName?: string;
|
|
1113
|
+
/**
|
|
1114
|
+
An object containing CSS key/value pairs that is used to style the search toggle button. Passing `false` will remove all default styling. Automatically skipped (as if `false`) once `.searchControlClassName(...)` is set, unless you've explicitly customized this yourself.
|
|
1115
|
+
*/
|
|
1116
|
+
searchControlStyle?: Record<string, unknown> | false;
|
|
1117
|
+
/**
|
|
1118
|
+
An object containing CSS key/value pairs that is used to style the search toggle button while open. Passing `false` will remove all default styling. Automatically skipped (as if `false`) once `.searchControlClassName(...)` is set, unless you've explicitly customized this yourself.
|
|
1119
|
+
*/
|
|
1120
|
+
searchControlStyleActive?: Record<string, unknown> | false;
|
|
1121
|
+
/**
|
|
1122
|
+
An object containing CSS key/value pairs that is used to style the search toggle button on hover. Passing `false` will remove all default styling. Automatically skipped (as if `false`) once `.searchControlClassName(...)` is set, unless you've explicitly customized this yourself.
|
|
1123
|
+
*/
|
|
1124
|
+
searchControlStyleHover?: Record<string, unknown> | false;
|
|
1125
|
+
/**
|
|
1126
|
+
Changes the primary shape used to represent each data point in a visualization. Not all visualizations support changing shapes, this method can be provided the String name of a D3plus shape class (for example, "Rect" or "Circle"), or an accessor Function that returns the String class name to be used for each individual data point.
|
|
1127
|
+
*/
|
|
1128
|
+
shape?: string | ((d: DataPoint, i: number) => string);
|
|
471
1129
|
/** Configuration for shape rendering. */
|
|
472
1130
|
shapeConfig?: {
|
|
473
1131
|
duration?: number;
|
|
@@ -480,25 +1138,43 @@ export interface D3plusConfig {
|
|
|
480
1138
|
all shapes of a given type.
|
|
481
1139
|
*/
|
|
482
1140
|
shapeSort?: (a: string, b: string) => number;
|
|
1141
|
+
/** Bullet: whether every bullet reads against one shared domain, labeled by a single value axis. */
|
|
1142
|
+
sharedDomain?: boolean;
|
|
1143
|
+
/** Pyramid: the side values (the first `groupBy` level) as `[left, right]`. */
|
|
1144
|
+
sides?: unknown[];
|
|
1145
|
+
/** Pyramid: TextBox styles for the side titles. */
|
|
1146
|
+
sideTitleConfig?: TextBoxConfig;
|
|
1147
|
+
/** Pyramid: draws the name of each side above its half of the chart. */
|
|
1148
|
+
sideTitles?: boolean;
|
|
1149
|
+
/**
|
|
1150
|
+
Whether to display the size legend: a nested-circle key, in the chart's bottom-right corner, for charts that size their marks with a `size` accessor (bubble plots, Geomap points via `pointSize`, Network, Rings). By default it shows whenever marks are sized by more than one value, unless it would take up more than a third of the chart's width or height. Pass `true` to always show it, `false` to hide it, or a function that receives the resolved chart config, the radius scale, and the legend's measured `{width, height, availableWidth, availableHeight}`, and returns a boolean.
|
|
1151
|
+
*/
|
|
1152
|
+
sizeLegend?: boolean | ((config: D3plusConfig, scale: SizeLegendScale, size: SizeLegendSize) => boolean);
|
|
1153
|
+
/**
|
|
1154
|
+
Candlestick: places periods one slot apart in date order (default
|
|
1155
|
+
`true`), so days without data (weekends, holidays) leave no gap, with
|
|
1156
|
+
ticks on calendar boundaries; `false` places each period at its date
|
|
1157
|
+
on a continuous time axis.
|
|
1158
|
+
*/
|
|
1159
|
+
skipGaps?: boolean;
|
|
483
1160
|
/** Size accessor key. */
|
|
484
1161
|
size?: string;
|
|
485
1162
|
/**
|
|
486
|
-
|
|
487
|
-
bottom-right corner of charts that size their marks. Shown by default
|
|
488
|
-
whenever marks are sized by more than one value, unless it would take
|
|
489
|
-
up more than a third of the chart's width or height; pass `true` to
|
|
490
|
-
always show it, `false` to hide it, or a `(config, scale, size) =>
|
|
491
|
-
boolean` accessor.
|
|
1163
|
+
Configuration object passed to the size legend's config method: `values` (an array of values to draw, or how many to pick), `tickFormat`, `title` (defaults to the `size` key when `size` is set to a string), `shapeConfig`, `lineConfig`, `labelConfig`, `titleConfig`, `padding`, `lineLength`, and `labelPadding`.
|
|
492
1164
|
*/
|
|
493
|
-
sizeLegend?: boolean | ((config: D3plusConfig, scale: SizeLegendScale, size: SizeLegendSize) => boolean);
|
|
494
|
-
/** Configuration for the size-legend component. */
|
|
495
1165
|
sizeLegendConfig?: SizeLegendConfig;
|
|
496
1166
|
/**
|
|
497
|
-
Which margin the size legend claims in the bottom-right corner
|
|
498
|
-
`"right"` (default) keeps the chart's full height, `"bottom"` its full
|
|
499
|
-
width.
|
|
1167
|
+
Which margin the size legend claims in the chart's bottom-right corner. `"right"` (the default) widens the right margin, so the chart keeps its full height and the legend sits at the bottom of the right column, below any right-side legend or colorScale. `"bottom"` deepens the bottom margin instead, so the chart keeps its full width and any bottom legend or colorScale narrows to sit beside it.
|
|
500
1168
|
*/
|
|
501
1169
|
sizeLegendPosition?: "right" | "bottom";
|
|
1170
|
+
/**
|
|
1171
|
+
With two groupBy levels, Violin places violins by the first and sets
|
|
1172
|
+
them side by side by the second. `split` draws a category holding
|
|
1173
|
+
exactly two violins as the two halves of one shape instead.
|
|
1174
|
+
*/
|
|
1175
|
+
split?: boolean;
|
|
1176
|
+
/** Funnel: the gap between consecutive stages, as a fraction (0–1) of each stage's slot. */
|
|
1177
|
+
stagePadding?: number;
|
|
502
1178
|
/** Whether to stack series. */
|
|
503
1179
|
stacked?: boolean;
|
|
504
1180
|
/**
|
|
@@ -520,9 +1196,45 @@ export interface D3plusConfig {
|
|
|
520
1196
|
value: string | ((d: DataPoint) => unknown);
|
|
521
1197
|
order?: "ascending" | "descending";
|
|
522
1198
|
} | ((d: DataPoint) => unknown);
|
|
523
|
-
/**
|
|
1199
|
+
/** Bullet: a smaller second label under each row's name, as a data key or accessor. */
|
|
1200
|
+
subLabel?: string | ((d: DataPoint, i: number) => string) | false;
|
|
1201
|
+
/** Configuration object for the subtitle. */
|
|
1202
|
+
subtitleConfig?: Record<string, unknown>;
|
|
1203
|
+
/**
|
|
1204
|
+
Waterfall: marks subtotal rows (a data key or accessor; truthy marks the
|
|
1205
|
+
row). A subtotal bar draws from zero to the running total; when the row
|
|
1206
|
+
has its own value, the running total resets to that value.
|
|
1207
|
+
*/
|
|
1208
|
+
subtotal?: string | ((d: DataPoint, i: number) => unknown);
|
|
1209
|
+
/** Accessor function or string for the visualization's subtitle. */
|
|
524
1210
|
subtitle?: string | ((data: DataPoint[]) => string);
|
|
525
|
-
/**
|
|
1211
|
+
/**
|
|
1212
|
+
Packs a Plot's circles into a beeswarm: each circle keeps its value along
|
|
1213
|
+
one axis and is placed beside its neighbors along the other, so none
|
|
1214
|
+
overlap. `"x"` or `"y"` names the value axis; `true` uses x when its
|
|
1215
|
+
values are numeric, else y; `false` draws a plain scatter. When the other
|
|
1216
|
+
axis holds categories (strings), each category gets its own swarm in its
|
|
1217
|
+
own band; otherwise that axis's values are ignored and its axis is hidden.
|
|
1218
|
+
Circles keep their ids, so switching a chart between `false` and `true`
|
|
1219
|
+
animates each circle between its scatter and swarm position. The default,
|
|
1220
|
+
`"auto"`, swarms only when every mark is a Circle and every row lacks a y
|
|
1221
|
+
(or x) value.
|
|
1222
|
+
*/
|
|
1223
|
+
swarm?: boolean | "auto" | "x" | "y";
|
|
1224
|
+
/**
|
|
1225
|
+
Options for `swarm`: `padding`, the minimum pixel gap between circles
|
|
1226
|
+
(default `1`), and `overflow`, what happens when a swarm is wider than
|
|
1227
|
+
its band — `"shrink"` (default) scales every circle down until each
|
|
1228
|
+
swarm fits, `"clamp"` keeps the sizes and holds outlying circles at the
|
|
1229
|
+
band's edge, and `"visible"` lets swarms spill past their band.
|
|
1230
|
+
*/
|
|
1231
|
+
swarmConfig?: {
|
|
1232
|
+
padding?: number;
|
|
1233
|
+
overflow?: "shrink" | "clamp" | "visible";
|
|
1234
|
+
};
|
|
1235
|
+
/**
|
|
1236
|
+
Tells the subtitle whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the subtitle appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.
|
|
1237
|
+
*/
|
|
526
1238
|
subtitlePadding?: boolean | ((viz: VizBase) => boolean);
|
|
527
1239
|
/** Value accessor for treemaps and aggregation. */
|
|
528
1240
|
sum?: DataPointAccessor<number>;
|
|
@@ -530,24 +1242,44 @@ export interface D3plusConfig {
|
|
|
530
1242
|
svgDesc?: string;
|
|
531
1243
|
/** Accessible title applied to the root SVG (`<title>`). */
|
|
532
1244
|
svgTitle?: string;
|
|
1245
|
+
/** Pyramid: centers the value axis on zero so both halves share one scale. */
|
|
1246
|
+
symmetric?: boolean;
|
|
533
1247
|
/** Enables the top-left table-view toggle button, which swaps the chart for a static, scrollable `<table>` of its data. On by default for every chart. */
|
|
534
1248
|
tableView?: boolean;
|
|
535
|
-
/**
|
|
1249
|
+
/**
|
|
1250
|
+
An additional CSS class name (or space-separated list of class names) applied to the `<table>` element the table-view toggle renders, alongside the fixed `d3plus-table-view-table` class. Lets a host page style the data table with its own table styling (Tailwind, Bootstrap, a design system) via descendant selectors.
|
|
1251
|
+
*/
|
|
536
1252
|
tableViewClassName?: string;
|
|
537
|
-
/**
|
|
1253
|
+
/**
|
|
1254
|
+
An additional CSS class name (or space-separated list of class names) applied to the table-view toggle button, alongside the fixed `table-view-control`/`table-view-toggle` classes. Setting this automatically disables d3plus's built-in inline `tableViewControlStyle`/`tableViewControlStyleActive`/`tableViewControlStyleHover` defaults (as long as you haven't already customized them yourself), so a host page's own button styling applies through the cascade with no other configuration needed.
|
|
1255
|
+
*/
|
|
538
1256
|
tableViewControlClassName?: string;
|
|
539
|
-
/**
|
|
1257
|
+
/**
|
|
1258
|
+
An object containing CSS key/value pairs that is used to style the table-view toggle button. Passing `false` will remove all default styling. Automatically skipped (as if `false`) once `.tableViewControlClassName(...)` is set, unless you've explicitly customized this yourself.
|
|
1259
|
+
*/
|
|
540
1260
|
tableViewControlStyle?: Record<string, unknown> | false;
|
|
541
|
-
/**
|
|
1261
|
+
/**
|
|
1262
|
+
An object containing CSS key/value pairs that is used to style the table-view toggle button while it is active (showing the data table). Passing `false` will remove all default styling. Automatically skipped (as if `false`) once `.tableViewControlClassName(...)` is set, unless you've explicitly customized this yourself.
|
|
1263
|
+
*/
|
|
542
1264
|
tableViewControlStyleActive?: Record<string, unknown> | false;
|
|
543
|
-
/**
|
|
1265
|
+
/**
|
|
1266
|
+
An object containing CSS key/value pairs that is used to style the table-view toggle button on hover. Passing `false` will remove all default styling. Automatically skipped (as if `false`) once `.tableViewControlClassName(...)` is set, unless you've explicitly customized this yourself.
|
|
1267
|
+
*/
|
|
544
1268
|
tableViewControlStyleHover?: Record<string, unknown> | false;
|
|
545
1269
|
/** Whether the data table shows a "download CSV" button, exporting its full (sorted, unpaginated) rows. On by default. */
|
|
546
1270
|
tableViewDownload?: boolean;
|
|
547
|
-
/**
|
|
1271
|
+
/**
|
|
1272
|
+
The number of data-table rows shown per page while in table view. Set to `false` (or any non-positive number) to disable pagination and show every row on one page.
|
|
1273
|
+
*/
|
|
548
1274
|
tableViewPageSize?: number | false;
|
|
549
1275
|
/** Whether the data table's column headers are clickable to sort (toggling asc/desc). On by default. */
|
|
550
1276
|
tableViewSort?: boolean;
|
|
1277
|
+
/** Funnel: narrows each stage toward the next stage's width, drawing a continuous funnel instead of flat bars. */
|
|
1278
|
+
taper?: boolean;
|
|
1279
|
+
/** Bullet: each row's target, drawn as a marker across the band: a data key, an accessor, a number shared by every row, or `false`. */
|
|
1280
|
+
target?: string | number | ((d: DataPoint, i: number) => number) | false;
|
|
1281
|
+
/** Bullet: the target marker's `size` (a fraction of the band's thickness), `stroke`, and `strokeWidth`, each a value or a `(d, i)` accessor. */
|
|
1282
|
+
targetConfig?: Record<string, unknown>;
|
|
551
1283
|
/** Threshold value for grouping small slices. */
|
|
552
1284
|
threshold?: number;
|
|
553
1285
|
/** Label for the threshold group, or a `(datum, index)` accessor. */
|
|
@@ -569,13 +1301,19 @@ export interface D3plusConfig {
|
|
|
569
1301
|
timeFilter?: ((d: DataPoint, i: number) => boolean) | false;
|
|
570
1302
|
/** Whether to show the timeline component. */
|
|
571
1303
|
timeline?: boolean;
|
|
572
|
-
/**
|
|
1304
|
+
/** Configuration object for the timeline. */
|
|
1305
|
+
timelineConfig?: TimelineConfig;
|
|
1306
|
+
/**
|
|
1307
|
+
Tells the timeline whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the timeline appears centered underneath the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.
|
|
1308
|
+
*/
|
|
573
1309
|
timelinePadding?: boolean | ((viz: VizBase) => boolean);
|
|
574
|
-
/**
|
|
1310
|
+
/** Accessor function or string for the visualization's title. */
|
|
575
1311
|
title?: string | ((data: DataPoint[]) => string);
|
|
576
1312
|
/** CSS style configuration for the title. */
|
|
577
1313
|
titleConfig?: Record<string, string | number>;
|
|
578
|
-
/**
|
|
1314
|
+
/**
|
|
1315
|
+
Tells the title whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the title appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.
|
|
1316
|
+
*/
|
|
579
1317
|
titlePadding?: boolean | ((viz: VizBase) => boolean);
|
|
580
1318
|
/** Whether to show tooltips, or a `(datum, index)` accessor deciding per mark. */
|
|
581
1319
|
tooltip?: boolean | ((d: DataPoint, i: number) => boolean);
|
|
@@ -588,6 +1326,16 @@ export interface D3plusConfig {
|
|
|
588
1326
|
share that position.
|
|
589
1327
|
*/
|
|
590
1328
|
tooltipShared?: boolean;
|
|
1329
|
+
/** Configuration object for the total bar. */
|
|
1330
|
+
totalConfig?: Record<string, unknown>;
|
|
1331
|
+
/** Formatter function for the value in the total bar. */
|
|
1332
|
+
totalFormat?: (d: number) => string;
|
|
1333
|
+
/** Whether RadialBar draws a background track behind every bar. Defaults to `true`. */
|
|
1334
|
+
track?: boolean;
|
|
1335
|
+
/** Paint for RadialBar's background tracks: `fill`, `opacity`, `stroke`, `strokeWidth`. */
|
|
1336
|
+
trackConfig?: Record<string, unknown>;
|
|
1337
|
+
/** Share of each RadialBar track (or bar slice) left as a gap between neighbors. Defaults to `0.25`. */
|
|
1338
|
+
trackPadding?: number;
|
|
591
1339
|
/**
|
|
592
1340
|
Draws an automatic trend line fit to the plotted data: `true` (or
|
|
593
1341
|
`"linear"`) for a least-squares line, or `"exponential"`,
|
|
@@ -605,21 +1353,74 @@ export interface D3plusConfig {
|
|
|
605
1353
|
/** Path or object for the topojson data. */
|
|
606
1354
|
topojson?: string | object;
|
|
607
1355
|
/** CSS color to fill the map shapes. */
|
|
608
|
-
topojsonFill?:
|
|
1356
|
+
topojsonFill?: CssColor;
|
|
609
1357
|
/** Accessor function for topojson feature IDs. */
|
|
610
1358
|
topojsonId?: (obj: Record<string, unknown>) => string;
|
|
611
|
-
/**
|
|
1359
|
+
/** Waterfall: fill for subtotal bars. Defaults to `colorDefaults.sequential`. */
|
|
1360
|
+
totalColor?: string;
|
|
1361
|
+
/**
|
|
1362
|
+
Tells the total whether or not to use the internal padding defined by the visualization in it's positioning. For example, d3plus-plot will add padding on the left so that the total appears centered above the x-axis. By default, this padding is only applied on screens larger than 600 pixels wide.
|
|
1363
|
+
*/
|
|
612
1364
|
totalPadding?: boolean | ((viz: VizBase) => boolean);
|
|
1365
|
+
/** Candlestick: the color of periods that closed at or above their open, or an accessor of the row. Defaults to green. */
|
|
1366
|
+
upColor?: string | ((d: DataPoint, i: number) => string);
|
|
613
1367
|
/** Value accessor for the visualization. */
|
|
614
1368
|
value?: DataPointAccessor<number>;
|
|
1369
|
+
/** Funnel and Gauge: formats each value shown in labels and tooltips, as `(value, datum) => string`. */
|
|
1370
|
+
valueFormat?: (value: number, d: DataPoint) => string;
|
|
1371
|
+
/**
|
|
1372
|
+
Candlestick: how each period draws — `"candlestick"` (default), a wick
|
|
1373
|
+
from the high to the low around a body from the open to the close; or
|
|
1374
|
+
`"ohlc"`, a high-low line with the open ticked left and the close
|
|
1375
|
+
ticked right.
|
|
1376
|
+
*/
|
|
1377
|
+
variant?: "candlestick" | "ohlc";
|
|
1378
|
+
/**
|
|
1379
|
+
Candlestick: accessor (or data key) for each period's volume. Off by
|
|
1380
|
+
default; when set, a strip of volume bars draws under the candles, and
|
|
1381
|
+
the tooltip adds a Volume row. `false` turns it off.
|
|
1382
|
+
*/
|
|
1383
|
+
volume?: string | ((d: DataPoint, i: number) => number) | false;
|
|
1384
|
+
/**
|
|
1385
|
+
Candlestick: the volume strip's `height` (a share of the plot, default
|
|
1386
|
+
`0.2`; pixels above 1), `gap` (pixels, default `16`), `axisConfig`
|
|
1387
|
+
(its axis), and `shapeConfig` (its bars).
|
|
1388
|
+
*/
|
|
1389
|
+
volumeConfig?: {
|
|
1390
|
+
height?: number;
|
|
1391
|
+
gap?: number;
|
|
1392
|
+
axisConfig?: AxisConfig;
|
|
1393
|
+
shapeConfig?: Record<string, unknown>;
|
|
1394
|
+
};
|
|
1395
|
+
/** Calendar: formats the weekday names — a d3-time-format specifier read in the chart's `locale` (default `"%a"`), a function of a date on that weekday, or `false` for none. */
|
|
1396
|
+
weekdayFormat?: string | ((date: Date) => string) | false;
|
|
1397
|
+
/** Calendar: the first day of the week, `0` (Sunday) through `6` (Saturday) or a day name such as `"monday"`. Defaults to the first day of the week in the `locale`'s region. */
|
|
1398
|
+
weekStart?: number | string;
|
|
615
1399
|
/** Overall width of the visualization in pixels. */
|
|
616
1400
|
width?: number;
|
|
617
1401
|
/** Key, index, or accessor function for x-axis values. */
|
|
618
1402
|
x?: string | number | ((d: DataPoint, i: number) => unknown);
|
|
619
1403
|
/** Configuration for the x-axis. */
|
|
620
1404
|
xConfig?: AxisConfig;
|
|
621
|
-
/**
|
|
622
|
-
|
|
1405
|
+
/**
|
|
1406
|
+
Value range(s) to remove from the x axis — `[start, end]` or a list of
|
|
1407
|
+
them — drawn as a break in the axis with a gap cut across the shapes
|
|
1408
|
+
that cross it (see the axis `break` and `breakConfig`).
|
|
1409
|
+
*/
|
|
1410
|
+
xBreak?: [number, number] | [number, number][];
|
|
1411
|
+
/**
|
|
1412
|
+
The x domain as an array. On a continuous axis it is `[min, max]`.
|
|
1413
|
+
Setting just one end (`[min]` or `[undefined, max]`) pins only that
|
|
1414
|
+
end: the data fills the other, rounded where the axis would round it
|
|
1415
|
+
with no domain set (left at the data when `xConfig`'s `rounding`
|
|
1416
|
+
is "none"; time axes aren't rounded). With both ends set, neither is
|
|
1417
|
+
rounded. On a discrete axis it lists the categories to show, in
|
|
1418
|
+
order; data in other categories is not drawn. A full `xConfig`
|
|
1419
|
+
`domain` is the lower-level override: it wins over this, and is drawn
|
|
1420
|
+
exactly as given (rounded only by `xConfig`'s own `rounding`),
|
|
1421
|
+
without stretching to the chart's `baseline`.
|
|
1422
|
+
*/
|
|
1423
|
+
xDomain?: (number | string | Date)[];
|
|
623
1424
|
/** The x2 domain as an array. If either value is undefined, it is calculated from the data. */
|
|
624
1425
|
x2Domain?: (number | Date)[];
|
|
625
1426
|
/** Custom sort function for x-axis values. */
|
|
@@ -630,32 +1431,72 @@ export interface D3plusConfig {
|
|
|
630
1431
|
y?: string | number | ((d: DataPoint, i: number) => unknown);
|
|
631
1432
|
/** Configuration for the y-axis. */
|
|
632
1433
|
yConfig?: AxisConfig;
|
|
633
|
-
/**
|
|
634
|
-
|
|
1434
|
+
/**
|
|
1435
|
+
Value range(s) to remove from the y axis — `[start, end]` or a list of
|
|
1436
|
+
them, e.g. `[100, 900]` to fit one outlier bar — drawn as a break in the
|
|
1437
|
+
axis with a gap cut across the shapes that cross it (see the axis
|
|
1438
|
+
`break` and `breakConfig`).
|
|
1439
|
+
*/
|
|
1440
|
+
yBreak?: [number, number] | [number, number][];
|
|
1441
|
+
/**
|
|
1442
|
+
The y domain as an array. On a continuous axis it is `[min, max]`.
|
|
1443
|
+
Setting just one end (`[min]` or `[undefined, max]`) pins only that
|
|
1444
|
+
end: the data fills the other, rounded where the axis would round it
|
|
1445
|
+
with no domain set (left at the data when `yConfig`'s `rounding`
|
|
1446
|
+
is "none"; time axes aren't rounded). With both ends set, neither is
|
|
1447
|
+
rounded. On a discrete axis it lists the categories to show, in
|
|
1448
|
+
order; data in other categories is not drawn. A full `yConfig`
|
|
1449
|
+
`domain` is the lower-level override: it wins over this, and is drawn
|
|
1450
|
+
exactly as given (rounded only by `yConfig`'s own `rounding`),
|
|
1451
|
+
without stretching to the chart's `baseline`.
|
|
1452
|
+
*/
|
|
1453
|
+
yDomain?: (number | string | Date)[];
|
|
635
1454
|
/** The y2 domain as an array. If either value is undefined, it is calculated from the data. */
|
|
636
1455
|
y2Domain?: (number | Date)[];
|
|
637
1456
|
/** Custom sort function for y-axis values. */
|
|
638
1457
|
ySort?: (a: DataPoint, b: DataPoint) => number;
|
|
639
1458
|
/** Defines a custom sorting comparator function for discrete y2 axes. */
|
|
640
1459
|
y2Sort?: (a: DataPoint, b: DataPoint) => number;
|
|
1460
|
+
/** Calendar: formats the year beside each year block — a d3-time-format specifier (default `"%Y"`), a function of the year's first day, or `false` for none. */
|
|
1461
|
+
yearFormat?: string | ((date: Date) => string) | false;
|
|
641
1462
|
/** Enables pan/zoom with zoom-control buttons. On by default for every chart. */
|
|
642
1463
|
zoom?: boolean;
|
|
643
|
-
/**
|
|
1464
|
+
/** The pixel stroke-width of the zoom brush area. */
|
|
1465
|
+
zoomBrushHandleSize?: number;
|
|
1466
|
+
/**
|
|
1467
|
+
An object containing CSS key/value pairs that is used to style the outer handle area of the zoom brush. Passing `false` will remove all default styling.
|
|
1468
|
+
*/
|
|
1469
|
+
zoomBrushHandleStyle?: Record<string, unknown> | false;
|
|
1470
|
+
/**
|
|
1471
|
+
An object containing CSS key/value pairs that is used to style the inner selection area of the zoom brush. Passing `false` will remove all default styling.
|
|
1472
|
+
*/
|
|
1473
|
+
zoomBrushSelectionStyle?: Record<string, unknown> | false;
|
|
1474
|
+
/**
|
|
1475
|
+
An additional CSS class name (or space-separated list of class names) applied to each zoom control button, alongside the fixed `zoom-control` / `zoom-in` / `zoom-out` / `zoom-reset` / `zoom-brush` classes. Setting this automatically disables d3plus's built-in inline `zoomControlStyle`/`zoomControlStyleActive`/`zoomControlStyleHover` defaults (as long as you haven't already customized them yourself), so a host page's own button styling — Tailwind, Bootstrap, a design system — applies through the cascade with no other configuration needed.
|
|
1476
|
+
*/
|
|
644
1477
|
zoomControlClassName?: string;
|
|
645
1478
|
/**
|
|
646
|
-
Overrides one or more of the four built-in zoom-control icons (`zoomIn`,
|
|
647
|
-
`zoomOut`, `zoomReset`, `zoomBrush`), which otherwise render as inline
|
|
648
|
-
SVGs. Each value is either raw HTML — used as that button's content — or
|
|
649
|
-
a mount function, `(el: HTMLElement) => void | (() => void)`, called
|
|
650
|
-
once with the button's reserved icon slot so a live component (a React
|
|
651
|
-
tree via `createRoot(el).render(...)`, or anything else imperative) can
|
|
652
|
-
be mounted into it — return a cleanup function if there's teardown to do.
|
|
1479
|
+
Overrides one or more of the four built-in zoom-control icons (`zoomIn`, `zoomOut`, `zoomReset`, `zoomBrush`), which otherwise render as inline SVGs. Each value is either an HTML string — used as the button's content in place of the built-in icon — or a mount function, `(el: HTMLElement) => void | (() => void)`, called once with the button's reserved icon slot (a 12x12px element) so you can mount anything imperative into it: a React tree (`createRoot(el).render(<Icon/>)`), a Vue app, a canvas sprite, a brand `<img>`. Return a cleanup function from the mount function if there's teardown to do; it runs right before that slot is discarded — which happens whenever the whole button panel's markup regenerates (a `.locale(...)` change, a `zoomControlClassName` change, or the brush toggle switching), not just once per chart.
|
|
653
1480
|
*/
|
|
654
1481
|
zoomControlIcons?: Partial<Record<"zoomIn" | "zoomOut" | "zoomReset" | "zoomBrush", string | ((el: HTMLElement) => void | (() => void))>>;
|
|
1482
|
+
/**
|
|
1483
|
+
An object containing CSS key/value pairs that is used to style each zoom control button (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling. Automatically skipped (as if `false`) once `.zoomControlClassName(...)` is set, unless you've explicitly customized this yourself.
|
|
1484
|
+
*/
|
|
1485
|
+
zoomControlStyle?: Record<string, unknown> | false;
|
|
1486
|
+
/**
|
|
1487
|
+
An object containing CSS key/value pairs that is used to style each zoom control button when active (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling. Automatically skipped (as if `false`) once `.zoomControlClassName(...)` is set, unless you've explicitly customized this yourself.
|
|
1488
|
+
*/
|
|
1489
|
+
zoomControlStyleActive?: Record<string, unknown> | false;
|
|
1490
|
+
/**
|
|
1491
|
+
An object containing CSS key/value pairs that is used to style each zoom control button on hover (`.zoom-in`, `.zoom-out`, `.zoom-reset`, and `.zoom-brush`). Passing `false` will remove all default styling. Automatically skipped (as if `false`) once `.zoomControlClassName(...)` is set, unless you've explicitly customized this yourself.
|
|
1492
|
+
*/
|
|
1493
|
+
zoomControlStyleHover?: Record<string, unknown> | false;
|
|
655
1494
|
/** Multiplier applied to programmatic zoom steps. */
|
|
656
1495
|
zoomFactor?: number;
|
|
657
1496
|
/** Maximum zoom scale factor. Defaults to the scale at which the smallest shape fills the chart area. */
|
|
658
1497
|
zoomMax?: number;
|
|
1498
|
+
/** A pixel value to be used to pad all sides of a zoomed area. */
|
|
1499
|
+
zoomPadding?: number;
|
|
659
1500
|
/** Whether panning (drag) is enabled while zoomed. */
|
|
660
1501
|
zoomPan?: boolean;
|
|
661
1502
|
/**
|