@d3plus/core 4.10.0 → 4.11.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/es/index.js +1 -1
- package/es/internal.js +167 -8
- package/es/src/charts/Alluvial/aggregate.js +145 -0
- package/es/src/charts/Alluvial/applyLayout.js +125 -0
- package/es/src/charts/Alluvial/dimensions.js +56 -0
- package/es/src/charts/Alluvial/emit.js +73 -0
- package/es/src/charts/Alluvial/hover.js +101 -0
- package/es/src/charts/Alluvial/index.js +170 -0
- package/es/src/charts/Alluvial/layout.js +137 -0
- package/es/src/charts/Alluvial/meta.js +57 -0
- package/es/src/charts/Alluvial/titles.js +81 -0
- package/es/src/charts/ArcDiagram/applyLayout.js +386 -0
- package/es/src/charts/ArcDiagram/arcGeometry.js +275 -0
- package/es/src/charts/ArcDiagram/arcLabels.js +171 -0
- package/es/src/charts/ArcDiagram/arcLoops.js +78 -0
- package/es/src/charts/ArcDiagram/emit.js +178 -0
- package/es/src/charts/ArcDiagram/events.js +144 -0
- package/es/src/charts/ArcDiagram/index.js +215 -0
- package/es/src/charts/BarChart/index.js +14 -2
- package/es/src/charts/BoxWhisker/index.js +22 -0
- package/es/src/charts/BubbleChart/emit.js +31 -0
- package/es/src/charts/BubbleChart/index.js +54 -0
- package/es/src/charts/Calendar/emit.js +1 -1
- package/es/src/charts/Calendar/index.js +3 -2
- package/es/src/charts/Candlestick/buffer.js +6 -4
- package/es/src/charts/Candlestick/index.js +2 -1
- package/es/src/charts/Chord/applyLayout.js +56 -69
- package/es/src/charts/Chord/emit.js +55 -24
- package/es/src/charts/Chord/index.js +14 -10
- package/es/src/charts/Chord/labels.js +105 -0
- package/es/src/charts/Donut/index.js +5 -11
- package/es/src/charts/Dumbbell/index.js +2 -4
- package/es/src/charts/Gantt/applyLayout.js +162 -0
- package/es/src/charts/Gantt/emit.js +142 -0
- package/es/src/charts/Gantt/ganttDecor.js +207 -0
- package/es/src/charts/Gantt/ganttGeometry.js +107 -0
- package/es/src/charts/Gantt/ganttLabels.js +85 -0
- package/es/src/charts/Gantt/ganttRows.js +111 -0
- package/es/src/charts/Gantt/ganttTooltip.js +136 -0
- package/es/src/charts/Gantt/index.js +219 -0
- package/es/src/charts/Geomap/applyLayout.js +90 -49
- package/es/src/charts/Geomap/basemapTheme.js +3 -48
- package/es/src/charts/Geomap/emit.js +19 -2
- package/es/src/charts/Geomap/flowEmit.js +132 -0
- package/es/src/charts/Geomap/flowEvents.js +86 -0
- package/es/src/charts/Geomap/flowFields.js +91 -0
- package/es/src/charts/Geomap/flowGeometry.js +225 -0
- package/es/src/charts/Geomap/flowLinks.js +239 -0
- package/es/src/charts/Geomap/geoCache.js +180 -0
- package/es/src/charts/Geomap/globeKeys.js +131 -0
- package/es/src/charts/Geomap/globeRotate.js +208 -0
- package/es/src/charts/Geomap/index.js +51 -16
- package/es/src/charts/Geomap/pointLabels.js +107 -0
- package/es/src/charts/Hexbin/binning.js +103 -0
- package/es/src/charts/Hexbin/buffer.js +33 -0
- package/es/src/charts/Hexbin/contourLabels.js +234 -0
- package/es/src/charts/Hexbin/contours.js +48 -0
- package/es/src/charts/Hexbin/emit.js +142 -0
- package/es/src/charts/Hexbin/index.js +204 -0
- package/es/src/charts/Hexbin/layers.js +212 -0
- package/es/src/charts/Hexbin/settings.js +86 -0
- package/es/src/charts/Hexbin/tooltip.js +77 -0
- package/es/src/charts/Histogram/binData.js +31 -4
- package/es/src/charts/Histogram/index.js +32 -15
- package/es/src/charts/Histogram/labels.js +18 -0
- package/es/src/charts/Icicle/index.js +3 -3
- package/es/src/charts/LinePlot/index.js +7 -0
- package/es/src/charts/Marimekko/index.js +7 -4
- package/es/src/charts/Network/applyLayout.js +138 -94
- package/es/src/charts/Network/bundle.js +81 -0
- package/es/src/charts/Network/clusterLabels.js +423 -0
- package/es/src/charts/Network/clusters.js +290 -0
- package/es/src/charts/Network/emit.js +253 -70
- package/es/src/charts/Network/graph.js +117 -0
- package/es/src/charts/Network/graphFluent.js +79 -0
- package/es/src/charts/Network/index.js +86 -106
- package/es/src/charts/Network/minNodeDistance.js +64 -0
- package/es/src/charts/Network/polygonRows.js +44 -0
- package/es/src/charts/Pack/index.js +5 -1
- package/es/src/charts/Pie/applyLayout.js +86 -27
- package/es/src/charts/Pie/arcFit.js +152 -0
- package/es/src/charts/Pie/curvedLabels.js +134 -0
- package/es/src/charts/Pie/emit.js +43 -96
- package/es/src/charts/Pie/index.js +64 -31
- package/es/src/charts/Pie/labelRoom.js +154 -0
- package/es/src/charts/Pie/outsideLabels.js +224 -0
- package/es/src/charts/Pie/outsideNodes.js +267 -0
- package/es/src/charts/Pie/pieLabels.js +137 -0
- package/es/src/charts/Pie/sectorBox.js +223 -0
- package/es/src/charts/Pie/straightLabels.js +96 -0
- package/es/src/charts/Pie/straightLayout.js +215 -0
- package/es/src/charts/Plot/alongLegend.js +76 -0
- package/es/src/charts/Plot/areaLabelsAlong.js +333 -0
- package/es/src/charts/Plot/axisHoverScene.js +2 -1
- package/es/src/charts/Plot/axisValues.js +43 -0
- package/es/src/charts/Plot/barWidth.js +59 -11
- package/es/src/charts/Plot/circleLabels.js +98 -0
- package/es/src/charts/Plot/connectGaps.js +237 -0
- package/es/src/charts/Plot/connectGapsScene.js +188 -0
- package/es/src/charts/Plot/draw.js +8 -2
- package/es/src/charts/Plot/fillBetween.js +2 -1
- package/es/src/charts/Plot/forecastScene.js +3 -4
- package/es/src/charts/Plot/index.js +18 -10
- package/es/src/charts/Plot/labelPlacement.js +1 -1
- package/es/src/charts/Plot/lineLabelEmit.js +82 -0
- package/es/src/charts/Plot/lineLabelSides.js +51 -0
- package/es/src/charts/Plot/lineLabelSpread.js +65 -0
- package/es/src/charts/Plot/lineLabelsAlong.js +282 -0
- package/es/src/charts/Plot/pipeline.js +66 -19
- package/es/src/charts/Plot/pipelineAxisLayout.js +5 -1
- package/es/src/charts/Plot/pipelineDomains.js +16 -3
- package/es/src/charts/Plot/pipelineLineLabels.js +144 -52
- package/es/src/charts/Plot/pipelineScales.js +40 -8
- package/es/src/charts/Plot/plotFacet.js +12 -1
- package/es/src/charts/Plot/plotInit.js +34 -5
- package/es/src/charts/Plot/plotRangeBreaks.js +85 -0
- package/es/src/charts/Plot/referenceDomains.js +133 -0
- package/es/src/charts/Plot/shapeDefaults.js +10 -5
- package/es/src/charts/Plot/stackLegendOrder.js +176 -0
- package/es/src/charts/Plot/trendLabels.js +183 -0
- package/es/src/charts/Plot/trendLines.js +1 -0
- package/es/src/charts/Plot/trendScene.js +6 -3
- package/es/src/charts/Plot/trendTooltip.js +5 -1
- package/es/src/charts/PolarArea/index.js +2 -2
- package/es/src/charts/Priestley/applyLayout.js +14 -20
- package/es/src/charts/Priestley/index.js +4 -35
- package/es/src/charts/Priestley/timeAxis.js +100 -0
- package/es/src/charts/Radar/axisDecorations.js +49 -12
- package/es/src/charts/Radar/curvedLabels.js +187 -0
- package/es/src/charts/Radar/index.js +2 -3
- package/es/src/charts/RadialBar/curvedLabels.js +111 -0
- package/es/src/charts/RadialBar/emit.js +4 -1
- package/es/src/charts/RadialBar/index.js +16 -9
- package/es/src/charts/RadialBar/trackLayout.js +43 -13
- package/es/src/charts/RadialMatrix/index.js +3 -7
- package/es/src/charts/Rings/applyLayout.js +41 -24
- package/es/src/charts/Rings/emit.js +174 -58
- package/es/src/charts/Rings/index.js +61 -28
- package/es/src/charts/Rings/ringsGraph.js +28 -9
- package/es/src/charts/Rings/ringsLoops.js +73 -0
- package/es/src/charts/Rings/ringsParallel.js +166 -0
- package/es/src/charts/Sankey/applyLayout.js +116 -39
- package/es/src/charts/Sankey/circularLayout.js +208 -0
- package/es/src/charts/Sankey/circularLinks.js +301 -0
- package/es/src/charts/Sankey/emit.js +164 -94
- package/es/src/charts/Sankey/index.js +72 -75
- package/es/src/charts/Sankey/labels.js +80 -0
- package/es/src/charts/Sankey/ribbons.js +88 -0
- package/es/src/charts/Sankey/sankeyCycles.js +117 -0
- package/es/src/charts/Sankey/sankeyLayout.js +8 -3
- package/es/src/charts/Sankey/sankeyLinks.js +47 -0
- package/es/src/charts/Scatter/index.js +25 -0
- package/es/src/charts/SlopeChart/index.js +116 -0
- package/es/src/charts/SlopeChart/slope.js +95 -0
- package/es/src/charts/Streamgraph/index.js +51 -0
- package/es/src/charts/Sunburst/curvedLabels.js +74 -0
- package/es/src/charts/Sunburst/emit.js +74 -63
- package/es/src/charts/Sunburst/index.js +3 -3
- package/es/src/charts/Tree/index.js +2 -6
- package/es/src/charts/Treemap/index.js +2 -5
- package/es/src/charts/Violin/inner.js +3 -5
- package/es/src/charts/definition/makeChart.js +10 -2
- package/es/src/charts/drawSteps/backControl.js +17 -5
- package/es/src/charts/drawSteps/gestureHover.js +79 -0
- package/es/src/charts/drawSteps/minimap.js +6 -5
- package/es/src/charts/drawSteps/minimapMarkup.js +25 -9
- package/es/src/charts/drawSteps/searchControls.js +2 -1
- package/es/src/charts/drawSteps/searchControlsMarkup.js +11 -2
- package/es/src/charts/drawSteps/tableViewMarkup.js +17 -10
- package/es/src/charts/drawSteps/zoomControls.js +21 -5
- package/es/src/charts/events/click.legend.js +7 -2
- package/es/src/charts/events/click.shape.js +8 -1
- package/es/src/charts/events/mousemove.shape.js +5 -2
- package/es/src/charts/facet/drawFacets.js +14 -5
- package/es/src/charts/features/annotationFrame.js +179 -0
- package/es/src/charts/features/annotationText.js +83 -0
- package/es/src/charts/features/annotationTypes.js +10 -0
- package/es/src/charts/features/attributionFeature.js +6 -11
- package/es/src/charts/features/axes.js +2 -1
- package/es/src/charts/features/axesFinal.js +3 -1
- package/es/src/charts/features/axesMeasure.js +7 -4
- package/es/src/charts/features/calloutLayout.js +121 -0
- package/es/src/charts/features/calloutScene.js +155 -0
- package/es/src/charts/features/chartGeometry.js +1 -1
- package/es/src/charts/features/circleLabelPlacement.js +297 -0
- package/es/src/charts/features/circleLabels.js +207 -0
- package/es/src/charts/features/colorScaleBucket.js +2 -1
- package/es/src/charts/features/colorScaleHover.js +3 -2
- package/es/src/charts/features/colorScaleValue.js +97 -0
- package/es/src/charts/features/curvedArrows.js +158 -0
- package/es/src/charts/features/edgeArrows.js +160 -4
- package/es/src/charts/features/edgeBundling.js +442 -0
- package/es/src/charts/features/edgeBundlingSmooth.js +117 -0
- package/es/src/charts/features/ensureZoomDom.js +32 -8
- package/es/src/charts/features/features.js +32 -14
- package/es/src/charts/features/featuresColorScale.js +20 -6
- package/es/src/charts/features/featuresLegend.js +15 -24
- package/es/src/charts/features/legendKeys.js +64 -0
- package/es/src/charts/features/lineLabels.js +55 -46
- package/es/src/charts/features/linkBundle.js +19 -0
- package/es/src/charts/features/linkColor.js +72 -0
- package/es/src/charts/features/linkFields.js +86 -0
- package/es/src/charts/features/linkFocus.js +118 -0
- package/es/src/charts/features/linkInteraction.js +312 -0
- package/es/src/charts/features/linkKeys.js +20 -0
- package/es/src/charts/features/linkLabelGeometry.js +209 -0
- package/es/src/charts/features/linkLabelPath.js +162 -0
- package/es/src/charts/features/linkLabels.js +340 -0
- package/es/src/charts/features/linkWidths.js +32 -0
- package/es/src/charts/features/pathLabelGeometry.js +232 -0
- package/es/src/charts/features/pathLabels.js +50 -0
- package/es/src/charts/features/plotAnnotations.js +68 -17
- package/es/src/charts/features/plotPaint.js +38 -11
- package/es/src/charts/features/polyline.js +129 -0
- package/es/src/charts/features/referenceAnnotations.js +403 -0
- package/es/src/charts/features/referenceLabelPlacement.js +106 -0
- package/es/src/charts/features/ringLabelNodes.js +93 -0
- package/es/src/charts/features/ringLabels.js +222 -0
- package/es/src/charts/features/sceneBounds.js +26 -6
- package/es/src/charts/features/selfLoops.js +306 -0
- package/es/src/charts/features/shapeEmit.js +47 -31
- package/es/src/charts/features/sharedFields.js +15 -2
- package/es/src/charts/features/textHalo.js +29 -0
- package/es/src/charts/index.js +8 -0
- package/es/src/charts/partition/chartFields.js +2 -2
- package/es/src/charts/partition/interaction.js +9 -5
- package/es/src/charts/partition/zoom.js +7 -6
- package/es/src/charts/pipeline/insetPlacement.js +14 -6
- package/es/src/charts/pipeline/preDrawData.js +46 -3
- package/es/src/charts/pipeline/runVizPipeline.js +5 -0
- package/es/src/charts/pipeline/vizPreDraw.js +5 -3
- package/es/src/charts/plotBuffers/discreteBuffer.js +7 -4
- package/es/src/charts/polar/config.js +2 -3
- package/es/src/charts/viz/Viz.js +39 -36
- package/es/src/charts/viz/VizBase.js +18 -10
- package/es/src/charts/viz/backgroundInk.js +13 -7
- package/es/src/charts/viz/focusRing.js +104 -0
- package/es/src/charts/viz/focusTargets.js +208 -0
- package/es/src/charts/viz/history.js +74 -0
- package/es/src/charts/viz/keyboardNav.js +297 -0
- package/es/src/charts/viz/keyboardNavHost.js +95 -0
- package/es/src/charts/viz/loaderFormat.js +114 -0
- package/es/src/charts/viz/missingFields.js +2 -1
- package/es/src/charts/viz/mountTarget.js +9 -0
- package/es/src/charts/viz/nearestHover.js +183 -0
- package/es/src/charts/viz/nearestHoverSurface.js +92 -0
- package/es/src/charts/viz/ordinalColor.js +14 -12
- package/es/src/charts/viz/pageTheme.js +83 -0
- package/es/src/charts/viz/pointTooltipAnchor.js +59 -0
- package/es/src/charts/viz/pointVoronoi.js +124 -0
- package/es/src/charts/viz/reducedMotion.js +27 -0
- package/es/src/charts/viz/vizDataPolling.js +8 -3
- package/es/src/charts/viz/vizDefaults.js +15 -23
- package/es/src/charts/viz/vizFields.js +35 -0
- package/es/src/charts/viz/vizRender.js +43 -28
- package/es/src/charts/viz/vizTheme.js +96 -0
- package/es/src/charts/viz/vizVisibility.js +14 -0
- package/es/src/components/Axis/Axis.js +6 -0
- package/es/src/components/Axis/AxisBottom.js +1 -0
- package/es/src/components/Axis/AxisLeft.js +1 -0
- package/es/src/components/Axis/AxisRight.js +1 -0
- package/es/src/components/Axis/AxisTop.js +1 -0
- package/es/src/components/Axis/axisBreak.js +4 -1
- package/es/src/components/Axis/axisDefaults.js +5 -9
- package/es/src/components/Axis/axisLayoutScale.js +7 -1
- package/es/src/components/Axis/axisRangeBreaks.js +77 -0
- package/es/src/components/Axis/brokenTimeScale.js +196 -0
- package/es/src/components/Axis/rangeBreaks.js +201 -0
- package/es/src/components/Axis/timeValues.js +19 -4
- package/es/src/components/ColorScale/ColorScale.js +15 -9
- package/es/src/components/ColorScale/bucketBounds.js +32 -3
- package/es/src/components/ColorScale/colorScaleHoverMark.js +3 -3
- package/es/src/components/ColorScale/colorScaleScale.js +28 -15
- package/es/src/components/Legend/Legend.js +3 -0
- package/es/src/components/Legend/legendConfig.js +2 -6
- package/es/src/components/SizeLegend/SizeLegend.js +1 -0
- package/es/src/components/TextBox.js +29 -65
- package/es/src/components/Timeline/Timeline.js +12 -3
- package/es/src/components/Timeline/timelineConfig.js +20 -10
- package/es/src/components/Timeline/timelineMode.js +26 -0
- package/es/src/components/Timeline/timelineRender.js +7 -3
- package/es/src/components/Tooltip.js +15 -5
- package/es/src/components/fontStack.js +20 -0
- package/es/src/components/textBoxLayout.js +58 -21
- package/es/src/components/textBoxPath.js +73 -0
- package/es/src/components/textBoxScene.js +223 -0
- package/es/src/components/textBoxWords.js +70 -0
- package/es/src/shapes/Area.js +1 -0
- package/es/src/shapes/Bar.js +1 -0
- package/es/src/shapes/Box.js +1 -0
- package/es/src/shapes/Circle.js +1 -0
- package/es/src/shapes/Line.js +1 -0
- package/es/src/shapes/Path.js +1 -0
- package/es/src/shapes/Rect.js +1 -0
- package/es/src/shapes/Shape.js +1 -0
- package/es/src/shapes/Whisker.js +1 -0
- package/es/src/utils/BaseClass.js +25 -12
- package/es/src/utils/configPrep.js +2 -1
- package/es/src/utils/constant.js +13 -1
- package/es/src/utils/displayName.js +12 -0
- package/es/src/utils/theme.js +190 -0
- package/es/src/utils/themeInk.js +68 -0
- package/package.json +14 -11
- package/types/index.d.ts +6 -2
- package/types/internal.d.ts +250 -8
- package/types/src/charts/Alluvial/aggregate.d.ts +98 -0
- package/types/src/charts/Alluvial/applyLayout.d.ts +67 -0
- package/types/src/charts/Alluvial/dimensions.d.ts +40 -0
- package/types/src/charts/Alluvial/emit.d.ts +9 -0
- package/types/src/charts/Alluvial/hover.d.ts +31 -0
- package/types/src/charts/Alluvial/index.d.ts +27 -0
- package/types/src/charts/Alluvial/layout.d.ts +70 -0
- package/types/src/charts/Alluvial/meta.d.ts +54 -0
- package/types/src/charts/Alluvial/titles.d.ts +33 -0
- package/types/src/charts/ArcDiagram/applyLayout.d.ts +70 -0
- package/types/src/charts/ArcDiagram/arcGeometry.d.ts +150 -0
- package/types/src/charts/ArcDiagram/arcLabels.d.ts +89 -0
- package/types/src/charts/ArcDiagram/arcLoops.d.ts +48 -0
- package/types/src/charts/ArcDiagram/emit.d.ts +23 -0
- package/types/src/charts/ArcDiagram/events.d.ts +28 -0
- package/types/src/charts/ArcDiagram/index.d.ts +28 -0
- package/types/src/charts/BubbleChart/emit.d.ts +20 -0
- package/types/src/charts/BubbleChart/index.d.ts +16 -0
- package/types/src/charts/Chord/applyLayout.d.ts +3 -0
- package/types/src/charts/Chord/labels.d.ts +66 -0
- package/types/src/charts/Donut/index.d.ts +2 -1
- package/types/src/charts/Gantt/applyLayout.d.ts +64 -0
- package/types/src/charts/Gantt/emit.d.ts +17 -0
- package/types/src/charts/Gantt/ganttDecor.d.ts +41 -0
- package/types/src/charts/Gantt/ganttGeometry.d.ts +57 -0
- package/types/src/charts/Gantt/ganttLabels.d.ts +41 -0
- package/types/src/charts/Gantt/ganttRows.d.ts +84 -0
- package/types/src/charts/Gantt/ganttTooltip.d.ts +57 -0
- package/types/src/charts/Gantt/index.d.ts +36 -0
- package/types/src/charts/Geomap/applyLayout.d.ts +8 -0
- package/types/src/charts/Geomap/basemapTheme.d.ts +2 -19
- package/types/src/charts/Geomap/emit.d.ts +2 -2
- package/types/src/charts/Geomap/flowEmit.d.ts +35 -0
- package/types/src/charts/Geomap/flowEvents.d.ts +20 -0
- package/types/src/charts/Geomap/flowFields.d.ts +7 -0
- package/types/src/charts/Geomap/flowGeometry.d.ts +91 -0
- package/types/src/charts/Geomap/flowLinks.d.ts +97 -0
- package/types/src/charts/Geomap/geoCache.d.ts +47 -0
- package/types/src/charts/Geomap/globeKeys.d.ts +41 -0
- package/types/src/charts/Geomap/globeRotate.d.ts +70 -0
- package/types/src/charts/Geomap/index.d.ts +3 -0
- package/types/src/charts/Geomap/pointLabels.d.ts +24 -0
- package/types/src/charts/Hexbin/binning.d.ts +64 -0
- package/types/src/charts/Hexbin/buffer.d.ts +18 -0
- package/types/src/charts/Hexbin/contourLabels.d.ts +95 -0
- package/types/src/charts/Hexbin/contours.d.ts +48 -0
- package/types/src/charts/Hexbin/emit.d.ts +23 -0
- package/types/src/charts/Hexbin/index.d.ts +25 -0
- package/types/src/charts/Hexbin/layers.d.ts +94 -0
- package/types/src/charts/Hexbin/settings.d.ts +122 -0
- package/types/src/charts/Hexbin/tooltip.d.ts +26 -0
- package/types/src/charts/Histogram/binData.d.ts +20 -1
- package/types/src/charts/Histogram/index.d.ts +3 -2
- package/types/src/charts/Histogram/labels.d.ts +7 -0
- package/types/src/charts/Marimekko/index.d.ts +2 -1
- package/types/src/charts/Network/bundle.d.ts +67 -0
- package/types/src/charts/Network/clusterLabels.d.ts +112 -0
- package/types/src/charts/Network/clusters.d.ts +115 -0
- package/types/src/charts/Network/graph.d.ts +65 -0
- package/types/src/charts/Network/graphFluent.d.ts +20 -0
- package/types/src/charts/Network/minNodeDistance.d.ts +18 -0
- package/types/src/charts/Network/polygonRows.d.ts +29 -0
- package/types/src/charts/Pie/applyLayout.d.ts +31 -3
- package/types/src/charts/Pie/arcFit.d.ts +63 -0
- package/types/src/charts/Pie/curvedLabels.d.ts +57 -0
- package/types/src/charts/Pie/labelRoom.d.ts +83 -0
- package/types/src/charts/Pie/outsideLabels.d.ts +119 -0
- package/types/src/charts/Pie/outsideNodes.d.ts +93 -0
- package/types/src/charts/Pie/pieLabels.d.ts +85 -0
- package/types/src/charts/Pie/sectorBox.d.ts +95 -0
- package/types/src/charts/Pie/straightLabels.d.ts +24 -0
- package/types/src/charts/Pie/straightLayout.d.ts +88 -0
- package/types/src/charts/Plot/alongLegend.d.ts +42 -0
- package/types/src/charts/Plot/areaLabelsAlong.d.ts +119 -0
- package/types/src/charts/Plot/axisValues.d.ts +24 -0
- package/types/src/charts/Plot/barWidth.d.ts +38 -4
- package/types/src/charts/Plot/circleLabels.d.ts +29 -0
- package/types/src/charts/Plot/connectGaps.d.ts +99 -0
- package/types/src/charts/Plot/connectGapsScene.d.ts +55 -0
- package/types/src/charts/Plot/forecastScene.d.ts +5 -0
- package/types/src/charts/Plot/index.d.ts +15 -8
- package/types/src/charts/Plot/lineLabelEmit.d.ts +48 -0
- package/types/src/charts/Plot/lineLabelSides.d.ts +50 -0
- package/types/src/charts/Plot/lineLabelSpread.d.ts +15 -0
- package/types/src/charts/Plot/lineLabelsAlong.d.ts +116 -0
- package/types/src/charts/Plot/pipeline.d.ts +15 -1
- package/types/src/charts/Plot/pipelineLineLabels.d.ts +68 -0
- package/types/src/charts/Plot/plotFacet.d.ts +5 -0
- package/types/src/charts/Plot/plotInit.d.ts +14 -0
- package/types/src/charts/Plot/plotRangeBreaks.d.ts +35 -0
- package/types/src/charts/Plot/referenceDomains.d.ts +49 -0
- package/types/src/charts/Plot/stackLegendOrder.d.ts +83 -0
- package/types/src/charts/Plot/trendLabels.d.ts +73 -0
- package/types/src/charts/Plot/trendTooltip.d.ts +6 -0
- package/types/src/charts/Priestley/timeAxis.d.ts +76 -0
- package/types/src/charts/Radar/axisDecorations.d.ts +7 -2
- package/types/src/charts/Radar/curvedLabels.d.ts +94 -0
- package/types/src/charts/RadialBar/curvedLabels.d.ts +31 -0
- package/types/src/charts/RadialBar/trackLayout.d.ts +34 -3
- package/types/src/charts/Rings/emit.d.ts +50 -0
- package/types/src/charts/Rings/ringsGraph.d.ts +10 -2
- package/types/src/charts/Rings/ringsLoops.d.ts +13 -0
- package/types/src/charts/Rings/ringsParallel.d.ts +43 -0
- package/types/src/charts/Sankey/circularLayout.d.ts +103 -0
- package/types/src/charts/Sankey/circularLinks.d.ts +178 -0
- package/types/src/charts/Sankey/emit.d.ts +58 -0
- package/types/src/charts/Sankey/labels.d.ts +19 -0
- package/types/src/charts/Sankey/ribbons.d.ts +36 -0
- package/types/src/charts/Sankey/sankeyCycles.d.ts +24 -0
- package/types/src/charts/Sankey/sankeyLayout.d.ts +6 -0
- package/types/src/charts/Sankey/sankeyLinks.d.ts +36 -0
- package/types/src/charts/Scatter/index.d.ts +15 -0
- package/types/src/charts/SlopeChart/index.d.ts +43 -0
- package/types/src/charts/SlopeChart/slope.d.ts +43 -0
- package/types/src/charts/Streamgraph/index.d.ts +28 -0
- package/types/src/charts/Sunburst/curvedLabels.d.ts +56 -0
- package/types/src/charts/definition/ChartDefinition.d.ts +13 -0
- package/types/src/charts/definition/makeChart.d.ts +3 -2
- package/types/src/charts/drawSteps/backControl.d.ts +7 -22
- package/types/src/charts/drawSteps/gestureHover.d.ts +33 -0
- package/types/src/charts/drawSteps/minimapMarkup.d.ts +5 -4
- package/types/src/charts/drawSteps/tableViewMarkup.d.ts +3 -1
- package/types/src/charts/drawSteps/zoomGesture.d.ts +32 -0
- package/types/src/charts/events/click.legend.d.ts +2 -1
- package/types/src/charts/facet/facetConfig.d.ts +4 -2
- package/types/src/charts/features/annotationFrame.d.ts +108 -0
- package/types/src/charts/features/annotationText.d.ts +57 -0
- package/types/src/charts/features/annotationTypes.d.ts +161 -0
- package/types/src/charts/features/axesMeasure.d.ts +4 -0
- package/types/src/charts/features/calloutLayout.d.ts +78 -0
- package/types/src/charts/features/calloutScene.d.ts +40 -0
- package/types/src/charts/features/chartGeometry.d.ts +1 -1
- package/types/src/charts/features/circleLabelPlacement.d.ts +97 -0
- package/types/src/charts/features/circleLabels.d.ts +130 -0
- package/types/src/charts/features/colorScaleValue.d.ts +35 -0
- package/types/src/charts/features/curvedArrows.d.ts +105 -0
- package/types/src/charts/features/edgeArrows.d.ts +74 -2
- package/types/src/charts/features/edgeBundling.d.ts +86 -0
- package/types/src/charts/features/edgeBundlingSmooth.d.ts +29 -0
- package/types/src/charts/features/ensureZoomDom.d.ts +19 -1
- package/types/src/charts/features/featuresLegend.d.ts +4 -3
- package/types/src/charts/features/legendKeys.d.ts +34 -0
- package/types/src/charts/features/lineLabels.d.ts +15 -12
- package/types/src/charts/features/linkBundle.d.ts +16 -0
- package/types/src/charts/features/linkColor.d.ts +48 -0
- package/types/src/charts/features/linkFields.d.ts +16 -0
- package/types/src/charts/features/linkFocus.d.ts +51 -0
- package/types/src/charts/features/linkInteraction.d.ts +183 -0
- package/types/src/charts/features/linkKeys.d.ts +11 -0
- package/types/src/charts/features/linkLabelGeometry.d.ts +67 -0
- package/types/src/charts/features/linkLabelPath.d.ts +85 -0
- package/types/src/charts/features/linkLabels.d.ts +77 -0
- package/types/src/charts/features/linkWidths.d.ts +19 -0
- package/types/src/charts/features/pathLabelGeometry.d.ts +99 -0
- package/types/src/charts/features/pathLabels.d.ts +41 -0
- package/types/src/charts/features/plotAnnotations.d.ts +23 -8
- package/types/src/charts/features/plotPaint.d.ts +17 -0
- package/types/src/charts/features/polyline.d.ts +32 -0
- package/types/src/charts/features/referenceAnnotations.d.ts +130 -0
- package/types/src/charts/features/referenceLabelPlacement.d.ts +58 -0
- package/types/src/charts/features/ringLabelNodes.d.ts +63 -0
- package/types/src/charts/features/ringLabels.d.ts +164 -0
- package/types/src/charts/features/sceneBounds.d.ts +6 -0
- package/types/src/charts/features/selfLoops.d.ts +165 -0
- package/types/src/charts/features/shapeEmit.d.ts +3 -1
- package/types/src/charts/features/sharedFields.d.ts +11 -2
- package/types/src/charts/features/textHalo.d.ts +14 -0
- package/types/src/charts/index.d.ts +8 -0
- package/types/src/charts/partition/interaction.d.ts +6 -3
- package/types/src/charts/partition/zoom.d.ts +4 -4
- package/types/src/charts/pipeline/preDrawData.d.ts +14 -1
- package/types/src/charts/pipeline/stages.d.ts +7 -0
- package/types/src/charts/plotBuffers/discreteBuffer.d.ts +0 -5
- package/types/src/charts/viz/Viz.d.ts +16 -2
- package/types/src/charts/viz/VizBase.d.ts +6 -6
- package/types/src/charts/viz/backgroundInk.d.ts +11 -4
- package/types/src/charts/viz/focusRing.d.ts +25 -0
- package/types/src/charts/viz/focusTargets.d.ts +56 -0
- package/types/src/charts/viz/history.d.ts +35 -0
- package/types/src/charts/viz/keyboardNav.d.ts +55 -0
- package/types/src/charts/viz/keyboardNavHost.d.ts +53 -0
- package/types/src/charts/viz/loaderFormat.d.ts +78 -0
- package/types/src/charts/viz/mountTarget.d.ts +7 -0
- package/types/src/charts/viz/nearestHover.d.ts +75 -0
- package/types/src/charts/viz/nearestHoverSurface.d.ts +21 -0
- package/types/src/charts/viz/ordinalColor.d.ts +10 -8
- package/types/src/charts/viz/pageTheme.d.ts +34 -0
- package/types/src/charts/viz/pointTooltipAnchor.d.ts +36 -0
- package/types/src/charts/viz/pointVoronoi.d.ts +65 -0
- package/types/src/charts/viz/reducedMotion.d.ts +25 -0
- package/types/src/charts/viz/vizDefaults.d.ts +0 -9
- package/types/src/charts/viz/vizFields.d.ts +32 -0
- package/types/src/charts/viz/vizRender.d.ts +2 -1
- package/types/src/charts/viz/vizTheme.d.ts +40 -0
- package/types/src/charts/viz/vizTypes.d.ts +84 -7
- package/types/src/charts/viz/vizVisibility.d.ts +6 -0
- package/types/src/components/Axis/Axis.d.ts +1 -0
- package/types/src/components/Axis/AxisBottom.d.ts +1 -0
- package/types/src/components/Axis/AxisLeft.d.ts +1 -0
- package/types/src/components/Axis/AxisRight.d.ts +1 -0
- package/types/src/components/Axis/AxisTop.d.ts +1 -0
- package/types/src/components/Axis/axisBreak.d.ts +2 -0
- package/types/src/components/Axis/axisRangeBreaks.d.ts +25 -0
- package/types/src/components/Axis/brokenTimeScale.d.ts +51 -0
- package/types/src/components/Axis/rangeBreaks.d.ts +82 -0
- package/types/src/components/Axis/timeValues.d.ts +1 -1
- package/types/src/components/ColorScale/ColorScale.d.ts +1 -0
- package/types/src/components/ColorScale/bucketBounds.d.ts +15 -1
- package/types/src/components/Legend/Legend.d.ts +1 -0
- package/types/src/components/SizeLegend/SizeLegend.d.ts +1 -0
- package/types/src/components/TextBox.d.ts +1 -0
- package/types/src/components/Timeline/Timeline.d.ts +1 -0
- package/types/src/components/Timeline/timelineConfig.d.ts +5 -0
- package/types/src/components/Timeline/timelineMode.d.ts +17 -0
- package/types/src/components/Tooltip.d.ts +4 -3
- package/types/src/components/fontStack.d.ts +10 -0
- package/types/src/components/textBoxLayout.d.ts +18 -9
- package/types/src/components/textBoxPath.d.ts +59 -0
- package/types/src/components/textBoxScene.d.ts +51 -0
- package/types/src/components/textBoxWords.d.ts +33 -0
- package/types/src/shapes/Area.d.ts +1 -0
- package/types/src/shapes/Bar.d.ts +1 -0
- package/types/src/shapes/Box.d.ts +1 -0
- package/types/src/shapes/Circle.d.ts +1 -0
- package/types/src/shapes/Line.d.ts +1 -0
- package/types/src/shapes/Path.d.ts +1 -0
- package/types/src/shapes/Rect.d.ts +1 -0
- package/types/src/shapes/Shape.d.ts +1 -0
- package/types/src/shapes/Whisker.d.ts +1 -0
- package/types/src/utils/BaseClass.d.ts +9 -0
- package/types/src/utils/D3plusConfig.d.ts +981 -30
- package/types/src/utils/configPrep.d.ts +2 -0
- package/types/src/utils/constant.d.ts +8 -0
- package/types/src/utils/displayName.d.ts +10 -0
- package/types/src/utils/index.d.ts +1 -1
- package/types/src/utils/theme.d.ts +170 -0
- package/types/src/utils/themeInk.d.ts +56 -0
- package/umd/d3plus-core.full.js +86811 -61031
- package/umd/d3plus-core.full.min.js +2 -2
- package/umd/d3plus-core.js +28392 -6498
- package/umd/d3plus-core.min.js +2 -2
- package/es/src/components/Axis/gridStroke.js +0 -10
- package/types/src/components/Axis/gridStroke.d.ts +0 -8
|
@@ -53,12 +53,25 @@ interface ChartDefinitionBase {
|
|
|
53
53
|
chart has no room to offer.
|
|
54
54
|
*/
|
|
55
55
|
insetRegion?: (viz: VizInstance) => InsetRegion | null;
|
|
56
|
+
/**
|
|
57
|
+
Optional rows for the table view, in place of the chart's data: for a
|
|
58
|
+
chart whose marks come from more than its data (ArcDiagram's nodes and
|
|
59
|
+
links). Return null to show the data.
|
|
60
|
+
*/
|
|
61
|
+
tableData?: (viz: VizInstance) => DataPoint[] | null;
|
|
56
62
|
/**
|
|
57
63
|
Optional shape a colorScale row draws as, when it isn't the row's
|
|
58
64
|
`shape`: the `shapeConfig` key the colorScale's bucket swatches take
|
|
59
65
|
their stroke and opacity from (a Geomap row drawn as a topojson Path).
|
|
60
66
|
*/
|
|
61
67
|
colorScaleShape?: (viz: VizInstance, d: DataPoint, i: number) => string;
|
|
68
|
+
/**
|
|
69
|
+
Optional test for which painted scene nodes are point marks, the marks
|
|
70
|
+
nearest-point hover (`hoverDistance`) resolves the pointer to (see
|
|
71
|
+
`isPointShape`). Without one, the base chart's applies (none for a
|
|
72
|
+
data-driven chart; Circle and Rect shapes for the Plot family).
|
|
73
|
+
*/
|
|
74
|
+
pointMark?: (viz: VizInstance, node: SceneNode) => boolean;
|
|
62
75
|
/**
|
|
63
76
|
Optional small-multiples hooks (see `facet/facetConfig.ts`): the panel
|
|
64
77
|
aspect the chart reads best at, and for charts with scales, how panels
|
|
@@ -6,8 +6,9 @@
|
|
|
6
6
|
`applyDefinition(this, def)`, its `_draw` runs the shared Viz pipeline
|
|
7
7
|
then the chart's own layout stage via `runChartDraw`, and its
|
|
8
8
|
`_thresholdFunction` / `_thresholdLegend` / `_sizeLegendScale` / `_insetRegion` /
|
|
9
|
-
`_colorScaleShape` delegate to `def.thresholdFunction` /
|
|
10
|
-
`def.sizeLegendScale` / `def.insetRegion` / `def.colorScaleShape`
|
|
9
|
+
`_tableData` / `_colorScaleShape` / `_pointMark` delegate to `def.thresholdFunction` /
|
|
10
|
+
`def.sizeLegendScale` / `def.insetRegion` / `def.tableData` / `def.colorScaleShape` /
|
|
11
|
+
`def.pointMark` if
|
|
11
12
|
present (else to the base chart's), `_facetHooks` layers `def.facet` over the base chart's, and
|
|
12
13
|
`toScene` passes the base chart's scene through `def.decorateScene`.
|
|
13
14
|
|
|
@@ -1,29 +1,14 @@
|
|
|
1
|
-
/**
|
|
2
|
-
The "← Back" control's contribution to the shared top-left controls
|
|
3
|
-
panel (`topLeftControls.ts`) — visible only when the chart has
|
|
4
|
-
drill-down history to pop. Styled like the zoom/search controls: a real
|
|
5
|
-
`<button>` at the same 20px height, an SVG arrow icon (not a text
|
|
6
|
-
glyph), and no default background/border/color — a plain
|
|
7
|
-
browser-appearance button that lets native/host-page button chrome
|
|
8
|
-
show through, restylable via `.backControlStyle()`/
|
|
9
|
-
`.backControlClassName()` the same way zoom/search are.
|
|
10
|
-
|
|
11
|
-
Previously `backFeature` rendered "← Back" as an SVG text scene node in
|
|
12
|
-
its own margin-claiming row, with its click routed through
|
|
13
|
-
`Viz._routeSceneEvent`'s `interactionGroup === "back"` special case —
|
|
14
|
-
the only way to attach a click handler to a plain scene text node. As a
|
|
15
|
-
real button inside the shared `htmlOverlay` panel, its click instead
|
|
16
|
-
rides the same declarative delegated-events map every other top-left/
|
|
17
|
-
zoom control uses, and it claims no margin of its own — like zoom, it
|
|
18
|
-
floats over whatever's there, and content that needs to avoid it insets
|
|
19
|
-
around the whole panel via `topLeftControlsInset`.
|
|
20
|
-
|
|
21
|
-
@module
|
|
22
|
-
*/
|
|
23
1
|
import type Viz from "../viz/Viz.js";
|
|
24
2
|
import type { Contribution } from "./topLeftControlsMarkup.js";
|
|
25
3
|
/** Paints the back button's inline style. There's no active/hover override — unlike zoom/search it's not a toggle, so it relies on the browser's native `:hover`, like their own hover default (`false`) already does. */
|
|
26
4
|
export declare function paintBackButton(viz: Viz, btn: HTMLElement): void;
|
|
5
|
+
/**
|
|
6
|
+
Pops the Back history and re-renders: a legend entry puts back the
|
|
7
|
+
legend's hide/solo state (mirrored to linked charts), a drill-down entry
|
|
8
|
+
the view (and any legend state the drill cleared) before it. With no
|
|
9
|
+
entry left, steps up a level.
|
|
10
|
+
*/
|
|
11
|
+
export declare function goBack(viz: Viz): void;
|
|
27
12
|
/** The back button's markup: a real `<button>` (icon + visible "Back" text), so host-page button styling applies through the cascade once `backControlClassName` auto-disables the inline default. */
|
|
28
13
|
export declare function backControlsHtml(viz: Viz): string;
|
|
29
14
|
export declare function backContribution(viz: Viz): Contribution | null;
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
Tooltips and hover during zoom gestures. Once a drag pans the chart (or
|
|
3
|
+
turns a Geomap globe), or a wheel or pinch zooms it, the marks move out
|
|
4
|
+
from under a pointer that d3-zoom keeps from reporting moves: the pointer
|
|
5
|
+
leaves whatever it was over, hiding its tooltip and hover, and pointer
|
|
6
|
+
events wait for the gesture to end. The next move after it hovers what is
|
|
7
|
+
under the pointer then. A press that lets go without moving changes
|
|
8
|
+
nothing, so a click behaves as without zoom.
|
|
9
|
+
|
|
10
|
+
@module
|
|
11
|
+
*/
|
|
12
|
+
import type { ZoomGestureEvent } from "./zoomGesture.js";
|
|
13
|
+
import type { VizInstance } from "../viz/vizTypes.js";
|
|
14
|
+
type Point = [number, number];
|
|
15
|
+
/** The client position of a mouse or wheel event, or of a touch event's first touch. */
|
|
16
|
+
export declare function clientPoint(event: Event | null | undefined): Point | null;
|
|
17
|
+
/**
|
|
18
|
+
Whether a zoom gesture's source event moves the chart: a wheel, a touch
|
|
19
|
+
move, or a mouse move away from where the press began. Programmatic zooms
|
|
20
|
+
(no source event) and the press itself don't.
|
|
21
|
+
@param press The press's client position, if the gesture began with one.
|
|
22
|
+
@param source The event behind a d3-zoom "zoom" event.
|
|
23
|
+
*/
|
|
24
|
+
export declare function gestureMoves(press: Point | null, source: Event | null | undefined): boolean;
|
|
25
|
+
/** Whether a zoom gesture is moving the chart, so pointer events wait. */
|
|
26
|
+
export declare function gestureHolds(viz: Pick<VizInstance, "_gestureHover">): boolean;
|
|
27
|
+
/** A zoom gesture begins (d3-zoom's "start"). */
|
|
28
|
+
export declare function gestureHoverStart(viz: VizInstance, event: ZoomGestureEvent): void;
|
|
29
|
+
/** A zoom gesture moves (d3-zoom's "zoom"): the first move leaves the hovered mark. */
|
|
30
|
+
export declare function gestureHoverMove(viz: VizInstance, event: ZoomGestureEvent): void;
|
|
31
|
+
/** A zoom gesture ends (d3-zoom's "end"). */
|
|
32
|
+
export declare function gestureHoverEnd(viz: VizInstance): void;
|
|
33
|
+
export {};
|
|
@@ -28,10 +28,11 @@ export declare function formatZoomLabel(k: number): string;
|
|
|
28
28
|
`minimap.ts`), the same reason `zoomControlsHtml` bakes in everything
|
|
29
29
|
that CAN change (locale, className) but nothing here changes per-tick.
|
|
30
30
|
The viewport box is `tabindex="0"` so it's keyboard-focusable — arrow
|
|
31
|
-
keys nudge the pan, matching what the `aria-label` describes.
|
|
32
|
-
`
|
|
33
|
-
`slider` is one-dimensional),
|
|
34
|
-
|
|
31
|
+
keys nudge the pan, matching what the `aria-label` describes. Its role
|
|
32
|
+
is `application`, like the chart's keyboard-nav host: a 2D pan target
|
|
33
|
+
has no widget role (a `slider` is one-dimensional), `aria-label` isn't
|
|
34
|
+
allowed on a div without a role, and `application` also has screen
|
|
35
|
+
readers pass the arrow keys through instead of reading the page.
|
|
35
36
|
|
|
36
37
|
`minimapClassName` (documented as applying to all three elements — the
|
|
37
38
|
outer box, viewport box, and label) is appended to the viewport/label
|
|
@@ -58,7 +58,9 @@ export declare function tableViewButtonHtml(viz: Viz): string;
|
|
|
58
58
|
default, or `viz._data` (raw, untouched input) once the toggle picks
|
|
59
59
|
"raw" — guarded by `hasDistinctRawData` so a stale `_tableViewDataSource`
|
|
60
60
|
from a previous, genuinely-different dataset can't silently switch a
|
|
61
|
-
chart whose raw/aggregate happen to now coincide.
|
|
61
|
+
chart whose raw/aggregate happen to now coincide. A chart that supplies
|
|
62
|
+
its own rows (`ChartDefinition.tableData`) shows those instead, in its
|
|
63
|
+
order, with no raw toggle.
|
|
62
64
|
|
|
63
65
|
Absent an explicit column sort, the AGGREGATE source is further
|
|
64
66
|
reordered (`defaultRowOrder`) to match the chart's original `.data()`
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
@module
|
|
5
5
|
*/
|
|
6
|
+
import type { ZoomTransform } from "d3-zoom";
|
|
6
7
|
/** The groups inside the zoom surface that hold a d3-brush: the timeline's and the zoom brush. */
|
|
7
8
|
export declare const BRUSH_GROUPS = "g.d3plus-viz-timeline, g.d3plus-zoom-brush";
|
|
8
9
|
/**
|
|
@@ -15,3 +16,34 @@ export declare const BRUSH_GROUPS = "g.d3plus-viz-timeline, g.d3plus-zoom-brush"
|
|
|
15
16
|
@param event The pointer event d3-zoom is filtering.
|
|
16
17
|
*/
|
|
17
18
|
export declare function startsOnBrush(event: Pick<Event, "target">): boolean;
|
|
19
|
+
/** A d3-zoom gesture event, as `ZoomGesture` reads it. */
|
|
20
|
+
export interface ZoomGestureEvent {
|
|
21
|
+
/** The zoom transform the event carries. */
|
|
22
|
+
transform: ZoomTransform;
|
|
23
|
+
/** The pointer or wheel event behind it, or null for a programmatic zoom. */
|
|
24
|
+
sourceEvent: Event | null;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
A chart's own handling of the zoom behavior's gestures, consulted before
|
|
28
|
+
the zoom transform changes (Geomap turns a globe on a drag).
|
|
29
|
+
*/
|
|
30
|
+
export interface ZoomGesture {
|
|
31
|
+
/** A gesture begins. */
|
|
32
|
+
start(event: ZoomGestureEvent): void;
|
|
33
|
+
/** A gesture moves; true when the chart handled it, so the zoom transform is left alone. */
|
|
34
|
+
zoom(event: ZoomGestureEvent): boolean;
|
|
35
|
+
/** A gesture ends. */
|
|
36
|
+
end(event: ZoomGestureEvent): void;
|
|
37
|
+
/** The zoom controls' reset was pressed, just before the zoom resets. */
|
|
38
|
+
reset(): void;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
The hover hold of a zoom gesture in progress (see `gestureHover.ts`):
|
|
42
|
+
where its press began, and whether it has moved the chart yet.
|
|
43
|
+
*/
|
|
44
|
+
export interface GestureHoverState {
|
|
45
|
+
/** The press's client position, or null for a gesture without one (a wheel). */
|
|
46
|
+
press: [number, number] | null;
|
|
47
|
+
/** Whether the gesture has moved the chart, holding off hover until it ends. */
|
|
48
|
+
moving: boolean;
|
|
49
|
+
}
|
|
@@ -2,7 +2,8 @@ import type { DataPoint } from "@d3plus/data";
|
|
|
2
2
|
import type Viz from "../viz/Viz.js";
|
|
3
3
|
/**
|
|
4
4
|
@module clickLegend
|
|
5
|
-
On click event for all legend shapes in a Viz.
|
|
5
|
+
On click event for all legend shapes in a Viz. A click that changes what
|
|
6
|
+
is hidden or solo'd goes on the chart's Back history (see `legendHistory`).
|
|
6
7
|
@private
|
|
7
8
|
*/
|
|
8
9
|
export default function (this: Viz, d: DataPoint, i: number, x: DataPoint, event: MouseEvent): void;
|
|
@@ -91,8 +91,8 @@ export interface FacetPanelContext {
|
|
|
91
91
|
default panel aspect.
|
|
92
92
|
*/
|
|
93
93
|
export interface FacetHooks {
|
|
94
|
-
/** The panel width/height ratio the chart reads best at, used to pick the grid shape. */
|
|
95
|
-
aspect?: number;
|
|
94
|
+
/** The panel width/height ratio the chart reads best at, used to pick the grid shape, or a function of the chart returning it. */
|
|
95
|
+
aspect?: number | ((viz: VizInstance) => number);
|
|
96
96
|
/** The chart's default for `FacetConfig.scales` (`"shared"` when unset). */
|
|
97
97
|
scales?: "shared" | "independent";
|
|
98
98
|
/** The chart's default for `FacetConfig.axes` (`"outer"` when unset), or a function of the chart returning it. */
|
|
@@ -106,6 +106,8 @@ export interface FacetHooks {
|
|
|
106
106
|
x?: boolean;
|
|
107
107
|
y?: boolean;
|
|
108
108
|
};
|
|
109
|
+
/** Runs before the chrome lays out, with each panel's rows (one array per panel), for chrome that reads what the panels draw (such as a stacked chart's legend order). */
|
|
110
|
+
chrome?: (viz: VizInstance, panels: DataPoint[][]) => void;
|
|
109
111
|
/** Computes the scales every panel shares from each panel's rows (one array per panel). Runs before any panel draws, when scales are shared. */
|
|
110
112
|
share?: (viz: VizInstance, panels: DataPoint[][]) => unknown;
|
|
111
113
|
/** Applies a panel's overrides before it draws; returns a function undoing them. */
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
import type { VizInstance } from "../viz/vizTypes.js";
|
|
2
|
+
import type { AnnotationRef } from "./annotationTypes.js";
|
|
3
|
+
import type { PlotAxisFn } from "./plotPaint.js";
|
|
4
|
+
/** A Plot axis an annotation can position against. */
|
|
5
|
+
export type AnnotationAxis = "x" | "y" | "x2" | "y2";
|
|
6
|
+
/** The plot area, in the chart's content pixels. */
|
|
7
|
+
export interface PlotRect {
|
|
8
|
+
x0: number;
|
|
9
|
+
y0: number;
|
|
10
|
+
x1: number;
|
|
11
|
+
y1: number;
|
|
12
|
+
}
|
|
13
|
+
/** One axis's mapping from data values to pixels. */
|
|
14
|
+
export interface AxisFrame {
|
|
15
|
+
/** Maps a (parsed) value to its pixel position. */
|
|
16
|
+
scale: (value: unknown) => number;
|
|
17
|
+
/** Whether the axis plots dates, so values parse as dates. */
|
|
18
|
+
time?: boolean;
|
|
19
|
+
/** A category axis's categories, which values must match (or fall between, when numeric). */
|
|
20
|
+
categories?: unknown[];
|
|
21
|
+
/** Whether each category fills a slot along the axis (bars), which spans take in whole. */
|
|
22
|
+
slots?: boolean;
|
|
23
|
+
}
|
|
24
|
+
/** The plot area and its axes, as annotations position against them. */
|
|
25
|
+
export interface AnnotationFrame {
|
|
26
|
+
plot: PlotRect;
|
|
27
|
+
axes: Partial<Record<AnnotationAxis, AxisFrame>>;
|
|
28
|
+
}
|
|
29
|
+
/** Whether an axis runs vertically. */
|
|
30
|
+
export declare const isVertical: (axis: AnnotationAxis) => boolean;
|
|
31
|
+
/**
|
|
32
|
+
The pixel position of `value` on `axis`, or NaN when it has none: the
|
|
33
|
+
axis is missing, the value is not one of a category axis's categories,
|
|
34
|
+
or it does not parse. A `"plot"` value is a fraction of the plot area
|
|
35
|
+
(`0` at the left or bottom edge, `1` at the right or top).
|
|
36
|
+
@param frame The plot area and its axes.
|
|
37
|
+
@param axis The axis the value is on.
|
|
38
|
+
@param value The value, in data units or as a fraction.
|
|
39
|
+
@param ref How the value is read.
|
|
40
|
+
*/
|
|
41
|
+
export declare function axisPixel(frame: AnnotationFrame, axis: AnnotationAxis, value: unknown, ref?: AnnotationRef): number;
|
|
42
|
+
/**
|
|
43
|
+
The pixel position of a number (or date) that is not itself a category
|
|
44
|
+
on an axis of numeric categories: interpolated between the categories on
|
|
45
|
+
either side of it, or NaN outside them or among non-numeric categories.
|
|
46
|
+
@param a The axis.
|
|
47
|
+
@param value The value.
|
|
48
|
+
*/
|
|
49
|
+
export declare function betweenCategories(a: AxisFrame, value: unknown): number;
|
|
50
|
+
/**
|
|
51
|
+
Half the pixel distance between neighboring categories on a category
|
|
52
|
+
axis whose categories fill slots (bars; half the plot's extent along it
|
|
53
|
+
when it has one category), or `0` on any other axis.
|
|
54
|
+
@param frame The plot area and its axes.
|
|
55
|
+
@param axis The axis.
|
|
56
|
+
*/
|
|
57
|
+
export declare function categoryHalfStep(frame: AnnotationFrame, axis: AnnotationAxis): number;
|
|
58
|
+
/**
|
|
59
|
+
The pixel extent `[lo, hi]` between two values on an axis, or null when
|
|
60
|
+
either has no position. On a category axis of bars it takes in each end
|
|
61
|
+
category's whole slot.
|
|
62
|
+
@param frame The plot area and its axes.
|
|
63
|
+
@param axis The axis the values are on.
|
|
64
|
+
@param values The two values.
|
|
65
|
+
@param ref How the values are read.
|
|
66
|
+
*/
|
|
67
|
+
export declare function axisSpan(frame: AnnotationFrame, axis: AnnotationAxis, values: [unknown, unknown], ref?: AnnotationRef): [number, number] | null;
|
|
68
|
+
/**
|
|
69
|
+
Clips a pixel extent to `[min, max]`, or null when nothing of it is left.
|
|
70
|
+
@param span The extent.
|
|
71
|
+
@param min The lower bound.
|
|
72
|
+
@param max The upper bound.
|
|
73
|
+
*/
|
|
74
|
+
export declare function clipSpan(span: [number, number], min: number, max: number): [number, number] | null;
|
|
75
|
+
/**
|
|
76
|
+
Whether a pixel point lies in the plot area, give or take `tolerance`.
|
|
77
|
+
@param point The point.
|
|
78
|
+
@param plot The plot area.
|
|
79
|
+
@param tolerance Pixels of slack on each side.
|
|
80
|
+
*/
|
|
81
|
+
export declare function inPlot([x, y]: [number, number], plot: PlotRect, tolerance?: number): boolean;
|
|
82
|
+
/**
|
|
83
|
+
The pixel position of an annotation row's anchor: its `x` (or `x2`, on
|
|
84
|
+
that axis) and `y` (or `y2`), or NaN coordinates when it has none.
|
|
85
|
+
@param frame The plot area and its axes.
|
|
86
|
+
@param d The row.
|
|
87
|
+
@param xRef How its x value is read.
|
|
88
|
+
@param yRef How its y value is read.
|
|
89
|
+
*/
|
|
90
|
+
export declare function anchorPoint(frame: AnnotationFrame, d: Record<string, unknown>, xRef?: AnnotationRef, yRef?: AnnotationRef): [number, number];
|
|
91
|
+
/**
|
|
92
|
+
The annotation frame of a painted Plot: its plot area in content pixels
|
|
93
|
+
and its rendered axes. `x2`/`y2` are present only when the chart plots
|
|
94
|
+
on them, and `slots` marks a bar chart, whose categories fill slots
|
|
95
|
+
along its discrete axis.
|
|
96
|
+
@param viz The chart.
|
|
97
|
+
@param measured The axis functions and ranges `renderAxes` solved.
|
|
98
|
+
*/
|
|
99
|
+
export declare function plotAnnotationFrame(viz: VizInstance, measured: {
|
|
100
|
+
x: PlotAxisFn;
|
|
101
|
+
y: PlotAxisFn;
|
|
102
|
+
xRange: number[];
|
|
103
|
+
yRange: number[];
|
|
104
|
+
x2Height: number;
|
|
105
|
+
x2Exists?: boolean;
|
|
106
|
+
y2Exists?: boolean;
|
|
107
|
+
slots?: boolean;
|
|
108
|
+
}): AnnotationFrame;
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
/**
|
|
2
|
+
Text for callouts and reference labels: the theme-aware text style, the
|
|
3
|
+
label wrapped to a width, and the text node that draws it.
|
|
4
|
+
*/
|
|
5
|
+
import type { TextNode } from "@d3plus/render";
|
|
6
|
+
import type { VizInstance } from "../viz/vizTypes.js";
|
|
7
|
+
/** A resolved annotation text style. */
|
|
8
|
+
export interface AnnotationText {
|
|
9
|
+
fontColor: string;
|
|
10
|
+
fontFamily: string;
|
|
11
|
+
fontSize: number;
|
|
12
|
+
fontWeight: number | string;
|
|
13
|
+
lineHeight: number;
|
|
14
|
+
maxWidth: number;
|
|
15
|
+
}
|
|
16
|
+
/** A label wrapped into lines. */
|
|
17
|
+
export interface TextBlock {
|
|
18
|
+
lines: string[];
|
|
19
|
+
widths: number[];
|
|
20
|
+
/** The widest line's width. */
|
|
21
|
+
width: number;
|
|
22
|
+
/** All lines' height. */
|
|
23
|
+
height: number;
|
|
24
|
+
lineHeight: number;
|
|
25
|
+
}
|
|
26
|
+
/** Which way text lines up against its `x`. */
|
|
27
|
+
export type TextAlign = "start" | "middle" | "end";
|
|
28
|
+
/**
|
|
29
|
+
The text style for an annotation: each key from `config` (through `pick`,
|
|
30
|
+
which may read a row), else the defaults: the chart's text color for its
|
|
31
|
+
background and font family, 12px, weight 400, a 1.3 line height, and
|
|
32
|
+
a 150px wrap width.
|
|
33
|
+
@param viz The chart.
|
|
34
|
+
@param pick Reads one style key.
|
|
35
|
+
*/
|
|
36
|
+
export declare function annotationTextStyle(viz: VizInstance, pick: (key: string) => unknown): AnnotationText;
|
|
37
|
+
/**
|
|
38
|
+
Wraps `text` at the style's `maxWidth`, measuring each line.
|
|
39
|
+
@param text The label.
|
|
40
|
+
@param style The text style.
|
|
41
|
+
*/
|
|
42
|
+
export declare function wrapAnnotationText(text: string, style: AnnotationText): TextBlock;
|
|
43
|
+
/**
|
|
44
|
+
The text node that draws a wrapped label whose block's top edge sits at
|
|
45
|
+
`y`, lined up against `x` by `align` (its left edge, center, or right
|
|
46
|
+
edge). Inert: annotations take no pointer or keyboard focus.
|
|
47
|
+
@param block The wrapped label.
|
|
48
|
+
@param style Its text style.
|
|
49
|
+
@param at Where the block goes, and its key.
|
|
50
|
+
*/
|
|
51
|
+
export declare function annotationTextNode(block: TextBlock, style: AnnotationText, at: {
|
|
52
|
+
key: string;
|
|
53
|
+
x: number;
|
|
54
|
+
y: number;
|
|
55
|
+
align: TextAlign;
|
|
56
|
+
opacity?: number;
|
|
57
|
+
}): TextNode;
|
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
/**
|
|
2
|
+
The config shapes of a Plot's callout annotations, reference lines, and
|
|
3
|
+
reference bands.
|
|
4
|
+
*/
|
|
5
|
+
import type { DataPoint } from "@d3plus/data";
|
|
6
|
+
/**
|
|
7
|
+
How an annotation position is read on one axis: `"data"` (the default)
|
|
8
|
+
maps it through the axis scale, in data units (a number, a date, or a
|
|
9
|
+
category); `"plot"` reads it as a fraction of the plot area, from `0` at
|
|
10
|
+
the left (or bottom) edge to `1` at the right (or top) edge.
|
|
11
|
+
*/
|
|
12
|
+
export type AnnotationRef = "data" | "plot";
|
|
13
|
+
/** A value on a Plot axis: a number, a date (a Date, timestamp, or date string), or a category. */
|
|
14
|
+
export type AnnotationValue = number | string | Date;
|
|
15
|
+
/**
|
|
16
|
+
A user annotation: a shape key (a Shape class name such as `"Line"` or
|
|
17
|
+
`"Rect"`, or `"Callout"`, `"ReferenceLine"`, or `"ReferenceBand"`) plus
|
|
18
|
+
its config, optionally z-layered.
|
|
19
|
+
*/
|
|
20
|
+
export interface Annotation {
|
|
21
|
+
shape: string;
|
|
22
|
+
layer?: string;
|
|
23
|
+
[key: string]: unknown;
|
|
24
|
+
}
|
|
25
|
+
/** A constant, or a `(datum, index)` accessor over a callout's data rows. */
|
|
26
|
+
type CalloutValue<T> = T | ((d: DataPoint, i: number) => T);
|
|
27
|
+
/** The text and stroke styles shared by callouts and reference labels. */
|
|
28
|
+
export interface AnnotationTextStyle {
|
|
29
|
+
/** Text color. Defaults to the chart's text color for its background. */
|
|
30
|
+
fontColor?: string;
|
|
31
|
+
/** Font family. Defaults to the chart's `fontFamily`. */
|
|
32
|
+
fontFamily?: string | string[];
|
|
33
|
+
/** Font size, in pixels. Defaults to `12`. */
|
|
34
|
+
fontSize?: number;
|
|
35
|
+
/** Font weight. Defaults to `400`. */
|
|
36
|
+
fontWeight?: number | string;
|
|
37
|
+
/** Line height, in pixels. Defaults to 1.3 times `fontSize`. */
|
|
38
|
+
lineHeight?: number;
|
|
39
|
+
/** The width, in pixels, the text wraps at. Defaults to `150`. */
|
|
40
|
+
maxWidth?: number;
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
A callout annotation (`{shape: "Callout", data: [...]}` in `annotations`):
|
|
44
|
+
a note anchored at each row's `x`/`y` (or `x2`/`y2`, on those axes), drawn
|
|
45
|
+
as wrapped text in a box offset from the anchor by `dx`/`dy` pixels, with
|
|
46
|
+
a connector line from the box to the anchor ending in an arrowhead or a
|
|
47
|
+
dot. Each style key takes a constant or a `(d, i)` accessor, and a row's
|
|
48
|
+
own key of the same name wins over a constant. The box stays inside the
|
|
49
|
+
plot area. Callouts draw in front of the data unless `layer: "back"`, and
|
|
50
|
+
never respond to the pointer or keyboard.
|
|
51
|
+
*/
|
|
52
|
+
export interface CalloutAnnotation extends AnnotationTextStyle {
|
|
53
|
+
shape: "Callout";
|
|
54
|
+
/** The anchors: each row's `x`/`y` (or `x2`/`y2`) and `label`. */
|
|
55
|
+
data: DataPoint[];
|
|
56
|
+
/** `"front"` (the default) or `"back"` of the data shapes. */
|
|
57
|
+
layer?: "back" | "front";
|
|
58
|
+
/** How the anchors' `x` values are read. Defaults to `"data"`. */
|
|
59
|
+
xRef?: AnnotationRef;
|
|
60
|
+
/** How the anchors' `y` values are read. Defaults to `"data"`. */
|
|
61
|
+
yRef?: AnnotationRef;
|
|
62
|
+
/** The text. Defaults to each row's `label`. */
|
|
63
|
+
label?: CalloutValue<string>;
|
|
64
|
+
/** Horizontal offset of the box's center from the anchor, in pixels. Defaults to `0`. */
|
|
65
|
+
dx?: CalloutValue<number>;
|
|
66
|
+
/** Vertical offset of the box's center from the anchor, in pixels (negative is up). Defaults to `-40`. */
|
|
67
|
+
dy?: CalloutValue<number>;
|
|
68
|
+
/** Text alignment in the box: `"start"`, `"middle"` (the default), or `"end"`. */
|
|
69
|
+
textAlign?: CalloutValue<"start" | "middle" | "end">;
|
|
70
|
+
/** Space between the text and the box's edge, in pixels. Defaults to `6`. */
|
|
71
|
+
padding?: CalloutValue<number>;
|
|
72
|
+
/** Box fill. Defaults to the chart's background; `false` or `"none"` draws no box. */
|
|
73
|
+
fill?: CalloutValue<string | false>;
|
|
74
|
+
/** Box fill opacity. Defaults to `1`. */
|
|
75
|
+
fillOpacity?: CalloutValue<number>;
|
|
76
|
+
/** Box border color. Defaults to the text color. `false` or `"none"` draws no border. */
|
|
77
|
+
stroke?: CalloutValue<string | false>;
|
|
78
|
+
/** Box border opacity. Defaults to `0.25`. */
|
|
79
|
+
strokeOpacity?: CalloutValue<number>;
|
|
80
|
+
/** Box border width. Defaults to `1`. */
|
|
81
|
+
strokeWidth?: CalloutValue<number>;
|
|
82
|
+
/** Box corner radius. Defaults to `3`. */
|
|
83
|
+
rx?: CalloutValue<number>;
|
|
84
|
+
/** Whether a line joins the box to its anchor. Defaults to `true`. */
|
|
85
|
+
connector?: CalloutValue<boolean>;
|
|
86
|
+
/** Connector color. Defaults to the text color. */
|
|
87
|
+
connectorStroke?: CalloutValue<string>;
|
|
88
|
+
/** Connector width. Defaults to `1`. */
|
|
89
|
+
connectorStrokeWidth?: CalloutValue<number>;
|
|
90
|
+
/** Connector opacity. Defaults to `1`. */
|
|
91
|
+
connectorStrokeOpacity?: CalloutValue<number>;
|
|
92
|
+
/** Connector dash pattern, as a string ("4 2") or numbers. */
|
|
93
|
+
connectorStrokeDasharray?: CalloutValue<string | number[]>;
|
|
94
|
+
/** What marks the anchor: `"arrow"` (the default), `"dot"`, or `"none"`. */
|
|
95
|
+
marker?: CalloutValue<"arrow" | "dot" | "none">;
|
|
96
|
+
/** Arrowhead length or dot diameter, in pixels. Defaults to `6`. */
|
|
97
|
+
markerSize?: CalloutValue<number>;
|
|
98
|
+
/** Gap between the connector's end and the anchor, in pixels. Defaults to `0`. */
|
|
99
|
+
standoff?: CalloutValue<number>;
|
|
100
|
+
/** Whether the box is kept inside the plot area. Defaults to `true`. */
|
|
101
|
+
clamp?: CalloutValue<boolean>;
|
|
102
|
+
}
|
|
103
|
+
/** The line and label styles shared by reference lines and bands. */
|
|
104
|
+
export interface ReferenceStyle extends AnnotationTextStyle {
|
|
105
|
+
/** The text drawn with it. */
|
|
106
|
+
label?: string;
|
|
107
|
+
/** `"back"` (the default) or `"front"` of the data shapes. The label draws above the data either way. */
|
|
108
|
+
layer?: "back" | "front";
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
A full-width or full-height line across the plot at one value: give `x`
|
|
112
|
+
(a vertical line) or `y` (a horizontal one), or `x2`/`y2` for the
|
|
113
|
+
secondary axes. On a continuous or time axis the value widens the axis
|
|
114
|
+
domain to show the line, unless the user set that end of the domain.
|
|
115
|
+
*/
|
|
116
|
+
export interface ReferenceLineConfig extends ReferenceStyle {
|
|
117
|
+
x?: AnnotationValue;
|
|
118
|
+
y?: AnnotationValue;
|
|
119
|
+
x2?: AnnotationValue;
|
|
120
|
+
y2?: AnnotationValue;
|
|
121
|
+
/** How the value is read. Defaults to `"data"`. */
|
|
122
|
+
ref?: AnnotationRef;
|
|
123
|
+
/** Which end of the line the label sits at: `"end"` (the default: the right, or the top) or `"start"`. */
|
|
124
|
+
labelPosition?: "start" | "end";
|
|
125
|
+
/** Line color. Defaults to the chart's text color. */
|
|
126
|
+
stroke?: string;
|
|
127
|
+
/** Line opacity. Defaults to `0.6`. */
|
|
128
|
+
strokeOpacity?: number;
|
|
129
|
+
/** Line width. Defaults to `1`. */
|
|
130
|
+
strokeWidth?: number;
|
|
131
|
+
/** `true` dashes the line ("4 4"); a dash pattern string or numbers sets its own. */
|
|
132
|
+
dash?: boolean | string | number[];
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
135
|
+
A shaded span across the plot between two values: give `x` (a vertical
|
|
136
|
+
band) or `y` (a horizontal one) as `[start, end]`, or `x2`/`y2`. On a
|
|
137
|
+
category axis the band covers each end category's whole slot; on a
|
|
138
|
+
continuous or time axis its ends widen the axis domain, unless the user
|
|
139
|
+
set that end of the domain.
|
|
140
|
+
*/
|
|
141
|
+
export interface ReferenceBandConfig extends ReferenceStyle {
|
|
142
|
+
x?: [AnnotationValue, AnnotationValue];
|
|
143
|
+
y?: [AnnotationValue, AnnotationValue];
|
|
144
|
+
x2?: [AnnotationValue, AnnotationValue];
|
|
145
|
+
y2?: [AnnotationValue, AnnotationValue];
|
|
146
|
+
/** How the values are read. Defaults to `"data"`. */
|
|
147
|
+
ref?: AnnotationRef;
|
|
148
|
+
/** Which corner the label sits in: `"start"` (the default: the top left) or `"end"` (the top right). */
|
|
149
|
+
labelPosition?: "start" | "end";
|
|
150
|
+
/** Band fill. Defaults to the chart's text color. */
|
|
151
|
+
fill?: string;
|
|
152
|
+
/** Band fill opacity. Defaults to `0.08`. */
|
|
153
|
+
fillOpacity?: number;
|
|
154
|
+
/** Edge color; unset, the band has no edges. */
|
|
155
|
+
stroke?: string;
|
|
156
|
+
/** Edge opacity. Defaults to `0.4`. */
|
|
157
|
+
strokeOpacity?: number;
|
|
158
|
+
/** Edge width. Defaults to `1`. */
|
|
159
|
+
strokeWidth?: number;
|
|
160
|
+
}
|
|
161
|
+
export {};
|
|
@@ -20,6 +20,8 @@ export interface LineLabelMeasurement {
|
|
|
20
20
|
labelWidths: LabelWidth[];
|
|
21
21
|
largestLabel: number | undefined;
|
|
22
22
|
xRangeMax: number | undefined;
|
|
23
|
+
/** The room left of the x range for the lines' left-end labels. */
|
|
24
|
+
startLabelSpace?: number;
|
|
23
25
|
}
|
|
24
26
|
/**
|
|
25
27
|
The stable per-draw inputs the joint margin solve reads — exactly the
|
|
@@ -70,6 +72,8 @@ export interface AxisMeasureResult {
|
|
|
70
72
|
xRangeMax: number | undefined;
|
|
71
73
|
labelWidths: LabelWidth[];
|
|
72
74
|
largestLabel: number | undefined;
|
|
75
|
+
/** The room left of the x range for the lines' left-end labels. */
|
|
76
|
+
startLabelSpace: number;
|
|
73
77
|
xTestRange: number[];
|
|
74
78
|
x2TestRange: number[];
|
|
75
79
|
x2Height: number;
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
/**
|
|
2
|
+
A callout's geometry in pixels: its box offset from the anchor and kept
|
|
3
|
+
inside the plot, the connector from the box's edge to the anchor, and the
|
|
4
|
+
arrowhead at the anchor.
|
|
5
|
+
*/
|
|
6
|
+
import type { PlotRect } from "./annotationFrame.js";
|
|
7
|
+
/** A pixel point. */
|
|
8
|
+
export type Point = [number, number];
|
|
9
|
+
/** A pixel rectangle, from its top-left corner. */
|
|
10
|
+
export interface Box {
|
|
11
|
+
x: number;
|
|
12
|
+
y: number;
|
|
13
|
+
width: number;
|
|
14
|
+
height: number;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
A `width` × `height` box centered `dx`/`dy` pixels from the anchor.
|
|
18
|
+
@param anchor The anchor.
|
|
19
|
+
@param size The box's size.
|
|
20
|
+
@param dx The horizontal offset of its center.
|
|
21
|
+
@param dy The vertical offset of its center.
|
|
22
|
+
*/
|
|
23
|
+
export declare function offsetBox(anchor: Point, size: {
|
|
24
|
+
width: number;
|
|
25
|
+
height: number;
|
|
26
|
+
}, dx: number, dy: number): Box;
|
|
27
|
+
/**
|
|
28
|
+
Moves a box the least distance that puts it inside the plot area; a box
|
|
29
|
+
larger than the plot keeps to its top-left corner.
|
|
30
|
+
@param box The box.
|
|
31
|
+
@param plot The plot area.
|
|
32
|
+
*/
|
|
33
|
+
export declare function clampBox(box: Box, plot: PlotRect): Box;
|
|
34
|
+
/**
|
|
35
|
+
Where the connector runs: `from` the point the line from the box's center
|
|
36
|
+
to the anchor leaves the box, `to` the anchor (pulled back toward the box
|
|
37
|
+
by `standoff`). Null when the anchor is inside the box or the connector
|
|
38
|
+
would be shorter than a pixel.
|
|
39
|
+
@param box The callout box.
|
|
40
|
+
@param anchor The anchor.
|
|
41
|
+
@param standoff The gap to leave before the anchor.
|
|
42
|
+
*/
|
|
43
|
+
export declare function connectorEndpoints(box: Box, anchor: Point, standoff?: number): {
|
|
44
|
+
from: Point;
|
|
45
|
+
to: Point;
|
|
46
|
+
} | null;
|
|
47
|
+
/**
|
|
48
|
+
The three corners of an arrowhead `size` pixels long with its tip at
|
|
49
|
+
`tip`, pointing along the line from `from`: the tip, then its base's two
|
|
50
|
+
corners.
|
|
51
|
+
@param from The line's start.
|
|
52
|
+
@param tip The arrow's tip.
|
|
53
|
+
@param size The arrowhead's length (its base is as wide).
|
|
54
|
+
*/
|
|
55
|
+
export declare function arrowheadPoints(from: Point, tip: Point, size: number): [Point, Point, Point];
|
|
56
|
+
/**
|
|
57
|
+
Where a point moves along the line from `from` by `distance` pixels back
|
|
58
|
+
from its end (the arrow's base, where the connector stops).
|
|
59
|
+
@param from The line's start.
|
|
60
|
+
@param to The line's end.
|
|
61
|
+
@param distance How far back from `to`.
|
|
62
|
+
*/
|
|
63
|
+
export declare function pullBack(from: Point, to: Point, distance: number): Point;
|
|
64
|
+
/**
|
|
65
|
+
Where a callout's box goes: centered `dx`/`dy` from the anchor and, when
|
|
66
|
+
`clamp` is on, moved inside the plot area. A box that clamping pushes
|
|
67
|
+
over its own anchor tries the opposite offset instead, and keeps it when
|
|
68
|
+
that leaves the anchor clear.
|
|
69
|
+
@param anchor The anchor.
|
|
70
|
+
@param size The box's size.
|
|
71
|
+
@param offset The box center's offset from the anchor.
|
|
72
|
+
@param plot The plot area.
|
|
73
|
+
@param clamp Whether the box stays inside the plot area.
|
|
74
|
+
*/
|
|
75
|
+
export declare function placeCalloutBox(anchor: Point, size: {
|
|
76
|
+
width: number;
|
|
77
|
+
height: number;
|
|
78
|
+
}, [dx, dy]: Point, plot: PlotRect, clamp?: boolean): Box;
|