@d3plus/core 4.11.0 → 4.12.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/internal.js +15 -5
- package/es/src/charts/Alluvial/emit.js +2 -2
- package/es/src/charts/Alluvial/index.js +7 -1
- package/es/src/charts/Alluvial/titles.js +24 -4
- package/es/src/charts/ArcDiagram/emit.js +27 -13
- package/es/src/charts/ArcDiagram/events.js +6 -2
- package/es/src/charts/ArcDiagram/index.js +2 -0
- package/es/src/charts/BarChart/index.js +3 -10
- package/es/src/charts/Calendar/index.js +2 -0
- package/es/src/charts/Candlestick/index.js +4 -10
- package/es/src/charts/Gantt/applyLayout.js +2 -4
- package/es/src/charts/Geomap/flowEmit.js +11 -6
- package/es/src/charts/Hexbin/index.js +2 -0
- package/es/src/charts/Icicle/index.js +3 -1
- package/es/src/charts/Matrix/applyLayout.js +20 -9
- package/es/src/charts/Matrix/index.js +19 -1
- package/es/src/charts/Network/applyLayout.js +36 -5
- package/es/src/charts/Network/bundle.js +5 -4
- package/es/src/charts/Network/emit.js +39 -40
- package/es/src/charts/Network/graph.js +34 -5
- package/es/src/charts/Network/graphFluent.js +5 -3
- package/es/src/charts/Network/index.js +6 -1
- package/es/src/charts/Pack/applyLayout.js +16 -5
- package/es/src/charts/Pack/emit.js +15 -8
- package/es/src/charts/Pack/groupRows.js +61 -0
- package/es/src/charts/Pack/index.js +3 -0
- package/es/src/charts/Pack/neutralPaint.js +20 -0
- package/es/src/charts/Pack/nodeNames.js +35 -0
- package/es/src/charts/ParallelCoordinates/axes.js +22 -22
- package/es/src/charts/ParallelCoordinates/chrome.js +18 -0
- package/es/src/charts/ParallelCoordinates/index.js +3 -1
- package/es/src/charts/ParallelCoordinates/titles.js +17 -9
- package/es/src/charts/Pie/emit.js +9 -1
- package/es/src/charts/Pie/index.js +10 -0
- package/es/src/charts/Plot/areaEnter.js +68 -0
- package/es/src/charts/Plot/draw.js +26 -12
- package/es/src/charts/Plot/index.js +4 -10
- package/es/src/charts/Plot/lineMarkerKeys.js +19 -0
- package/es/src/charts/Plot/plotInit.js +6 -0
- package/es/src/charts/Plot/shapeLabelLegend.js +67 -0
- package/es/src/charts/Plot/sharedHover.js +2 -1
- package/es/src/charts/Plot/sharedTooltip.js +13 -3
- package/es/src/charts/PolarArea/index.js +2 -1
- package/es/src/charts/Priestley/applyLayout.js +11 -7
- package/es/src/charts/Priestley/index.js +0 -2
- package/es/src/charts/Priestley/timeAxis.js +11 -8
- package/es/src/charts/Pyramid/gutter.js +52 -16
- package/es/src/charts/Pyramid/index.js +55 -7
- package/es/src/charts/Pyramid/scene.js +4 -4
- package/es/src/charts/Radar/applyLayout.js +31 -33
- package/es/src/charts/Radar/axisDecorations.js +29 -17
- package/es/src/charts/Radar/curvedLabels.js +43 -2
- package/es/src/charts/Radar/emit.js +30 -15
- package/es/src/charts/Radar/index.js +41 -2
- package/es/src/charts/Radar/points.js +85 -0
- package/es/src/charts/RadialBar/emit.js +6 -1
- package/es/src/charts/RadialBar/index.js +10 -0
- package/es/src/charts/RadialMatrix/applyLayout.js +115 -31
- package/es/src/charts/RadialMatrix/index.js +15 -2
- package/es/src/charts/Rings/applyLayout.js +11 -150
- package/es/src/charts/Rings/emit.js +80 -40
- package/es/src/charts/Rings/index.js +27 -4
- package/es/src/charts/Rings/ringsCurves.js +156 -0
- package/es/src/charts/Rings/ringsParallel.js +20 -3
- package/es/src/charts/Rings/ringsPlacement.js +152 -0
- package/es/src/charts/Rings/ringsSizing.js +61 -38
- package/es/src/charts/Sankey/applyLayout.js +18 -4
- package/es/src/charts/Sankey/index.js +7 -1
- package/es/src/charts/Sunburst/emit.js +9 -1
- package/es/src/charts/Sunburst/index.js +13 -1
- package/es/src/charts/Tree/applyLayout.js +44 -14
- package/es/src/charts/Tree/emit.js +5 -5
- package/es/src/charts/Tree/index.js +10 -12
- package/es/src/charts/Tree/keys.js +33 -0
- package/es/src/charts/Tree/nodeLabel.js +15 -0
- package/es/src/charts/Treemap/emitGroupHeaders.js +3 -5
- package/es/src/charts/definition/makeChart.js +6 -2
- package/es/src/charts/drawSteps/minimap.js +4 -20
- package/es/src/charts/drawSteps/zoomActions.js +36 -0
- package/es/src/charts/drawSteps/zoomControls.js +31 -18
- package/es/src/charts/drawSteps/zoomControlsMarkup.js +23 -4
- package/es/src/charts/drawSteps/zoomDrag.js +188 -0
- package/es/src/charts/drawSteps/zoomFit.js +69 -0
- package/es/src/charts/events/click.legend.js +4 -2
- package/es/src/charts/events/click.shape.js +5 -3
- package/es/src/charts/events/mouseenter.js +6 -16
- package/es/src/charts/events/mouseleave.js +9 -2
- package/es/src/charts/events/mousemove.legend.js +28 -32
- package/es/src/charts/events/mousemove.shape.js +44 -44
- package/es/src/charts/features/axes.js +15 -4
- package/es/src/charts/features/axesFinal.js +7 -2
- package/es/src/charts/features/axesMeasure.js +26 -8
- package/es/src/charts/features/axisTooltip.js +138 -0
- package/es/src/charts/features/centerLabel.js +177 -0
- package/es/src/charts/features/colorScaleBivariate.js +83 -0
- package/es/src/charts/features/colorScaleBucket.js +18 -0
- package/es/src/charts/features/colorScaleHover.js +30 -5
- package/es/src/charts/features/colorScaleLimit.js +73 -0
- package/es/src/charts/features/colorScaleTooltip.js +77 -0
- package/es/src/charts/features/colorScaleTop.js +61 -0
- package/es/src/charts/features/curvedArrows.js +33 -0
- package/es/src/charts/features/depthKey.js +26 -0
- package/es/src/charts/features/edgeArrows.js +61 -2
- package/es/src/charts/features/featuresColorScale.js +57 -16
- package/es/src/charts/features/hoverTicks.js +41 -0
- package/es/src/charts/features/idleQueue.js +72 -0
- package/es/src/charts/features/linkInteraction.js +59 -7
- package/es/src/charts/features/networkMeasures.js +241 -0
- package/es/src/charts/features/nodeStats.js +309 -0
- package/es/src/charts/features/plotEndLabels.js +28 -7
- package/es/src/charts/features/plotPaint.js +9 -2
- package/es/src/charts/features/shapeEmit.js +7 -1
- package/es/src/charts/features/textHalo.js +3 -2
- package/es/src/charts/partition/chartFields.js +12 -3
- package/es/src/charts/partition/interaction.js +10 -5
- package/es/src/charts/pipeline/insetPlacement.js +8 -3
- package/es/src/charts/polar/chrome.js +81 -9
- package/es/src/charts/polar/config.js +4 -0
- package/es/src/charts/polar/wedgeLayout.js +2 -1
- package/es/src/charts/viz/Viz.js +24 -15
- package/es/src/charts/viz/VizBase.js +39 -4
- package/es/src/charts/viz/backgroundInk.js +10 -0
- package/es/src/charts/viz/emphasis.js +14 -0
- package/es/src/charts/viz/fillStroke.js +10 -0
- package/es/src/charts/viz/interactionOpacity.js +115 -32
- package/es/src/charts/viz/reportDrawError.js +15 -0
- package/es/src/charts/viz/setCursor.js +29 -0
- package/es/src/charts/viz/tooltipEnabled.js +38 -0
- package/es/src/charts/viz/userClick.js +34 -0
- package/es/src/charts/viz/vizDataPolling.js +0 -1
- package/es/src/charts/viz/vizDefaults.js +13 -34
- package/es/src/charts/viz/vizFields.js +6 -1
- package/es/src/charts/viz/vizRender.js +35 -5
- package/es/src/charts/viz/vizVisibility.js +12 -2
- package/es/src/components/Axis/Axis.js +29 -2
- package/es/src/components/Axis/axisBreak.js +29 -7
- package/es/src/components/Axis/axisDefaults.js +11 -0
- package/es/src/components/Axis/axisLabelKinds.js +36 -0
- package/es/src/components/Axis/axisLabelLineHeight.js +19 -0
- package/es/src/components/Axis/axisLabelRoom.js +37 -0
- package/es/src/components/Axis/axisLabelSize.js +171 -0
- package/es/src/components/Axis/axisLabelThinning.js +98 -4
- package/es/src/components/Axis/axisLayout.js +71 -46
- package/es/src/components/Axis/axisLayoutLabels.js +82 -140
- package/es/src/components/Axis/axisLayoutScale.js +9 -10
- package/es/src/components/Axis/axisLimit.js +27 -0
- package/es/src/components/Axis/axisMaxSize.js +39 -0
- package/es/src/components/Axis/axisRender.js +20 -8
- package/es/src/components/Axis/axisRounding.js +16 -1
- package/es/src/components/Axis/axisScene.js +11 -2
- package/es/src/components/Axis/axisTitle.js +53 -0
- package/es/src/components/Axis/axisTooltipTargets.js +128 -0
- package/es/src/components/ColorScale/ColorScale.js +62 -18
- package/es/src/components/ColorScale/bivariateRender.js +353 -0
- package/es/src/components/ColorScale/bivariateScale.js +150 -0
- package/es/src/components/ColorScale/colorScaleRender.js +32 -2
- package/es/src/components/ColorScale/colorScaleSwatchTooltips.js +77 -0
- package/es/src/components/Legend/Legend.js +10 -2
- package/es/src/components/Legend/legendCut.js +108 -0
- package/es/src/components/Legend/legendRender.js +38 -13
- package/es/src/components/TextBox.js +5 -2
- package/es/src/components/Timeline/timelineRender.js +2 -1
- package/es/src/components/textBoxScene.js +3 -0
- package/es/src/components/textEllipsis.js +7 -0
- package/es/src/components/tooltipDom.js +8 -5
- package/es/src/fluent.js +48 -0
- package/es/src/utils/BaseClass.js +7 -2
- package/es/src/utils/configValue.js +9 -0
- package/package.json +10 -10
- package/types/index.d.ts +1 -1
- package/types/internal.d.ts +22 -5
- package/types/src/charts/Alluvial/titles.d.ts +16 -3
- package/types/src/charts/ArcDiagram/emit.d.ts +3 -2
- package/types/src/charts/ArcDiagram/events.d.ts +2 -1
- package/types/src/charts/Geomap/flowEmit.d.ts +3 -2
- package/types/src/charts/Matrix/applyLayout.d.ts +4 -2
- package/types/src/charts/Network/applyLayout.d.ts +11 -0
- package/types/src/charts/Network/bundle.d.ts +3 -1
- package/types/src/charts/Network/graph.d.ts +12 -4
- package/types/src/charts/Pack/applyLayout.d.ts +2 -0
- package/types/src/charts/Pack/groupRows.d.ts +46 -0
- package/types/src/charts/Pack/index.d.ts +3 -0
- package/types/src/charts/Pack/neutralPaint.d.ts +14 -0
- package/types/src/charts/Pack/nodeNames.d.ts +23 -0
- package/types/src/charts/ParallelCoordinates/chrome.d.ts +12 -0
- package/types/src/charts/ParallelCoordinates/index.d.ts +1 -0
- package/types/src/charts/ParallelCoordinates/titles.d.ts +7 -2
- package/types/src/charts/Plot/areaEnter.d.ts +34 -0
- package/types/src/charts/Plot/index.d.ts +4 -10
- package/types/src/charts/Plot/lineMarkerKeys.d.ts +11 -0
- package/types/src/charts/Plot/shapeLabelLegend.d.ts +19 -0
- package/types/src/charts/Plot/sharedTooltip.d.ts +7 -1
- package/types/src/charts/Priestley/timeAxis.d.ts +7 -4
- package/types/src/charts/Pyramid/gutter.d.ts +28 -6
- package/types/src/charts/Pyramid/scene.d.ts +1 -1
- package/types/src/charts/Radar/applyLayout.d.ts +2 -3
- package/types/src/charts/Radar/axisDecorations.d.ts +5 -2
- package/types/src/charts/Radar/curvedLabels.d.ts +35 -0
- package/types/src/charts/Radar/emit.d.ts +5 -2
- package/types/src/charts/Radar/index.d.ts +7 -2
- package/types/src/charts/Radar/points.d.ts +50 -0
- package/types/src/charts/RadialMatrix/applyLayout.d.ts +6 -4
- package/types/src/charts/Rings/emit.d.ts +24 -2
- package/types/src/charts/Rings/index.d.ts +4 -2
- package/types/src/charts/Rings/ringsCurves.d.ts +50 -0
- package/types/src/charts/Rings/ringsGraph.d.ts +29 -5
- package/types/src/charts/Rings/ringsParallel.d.ts +4 -2
- package/types/src/charts/Rings/ringsPlacement.d.ts +47 -0
- package/types/src/charts/Rings/ringsSizing.d.ts +36 -9
- package/types/src/charts/Tree/applyLayout.d.ts +20 -0
- package/types/src/charts/Tree/keys.d.ts +25 -0
- package/types/src/charts/Tree/nodeLabel.d.ts +11 -0
- package/types/src/charts/definition/ChartDefinition.d.ts +13 -0
- package/types/src/charts/definition/makeChart.d.ts +2 -2
- package/types/src/charts/drawSteps/zoomActions.d.ts +30 -0
- package/types/src/charts/drawSteps/zoomControls.d.ts +15 -0
- package/types/src/charts/drawSteps/zoomControlsMarkup.d.ts +16 -1
- package/types/src/charts/drawSteps/zoomDrag.d.ts +71 -0
- package/types/src/charts/drawSteps/zoomFit.d.ts +30 -0
- package/types/src/charts/features/axisTooltip.d.ts +49 -0
- package/types/src/charts/features/centerLabel.d.ts +75 -0
- package/types/src/charts/features/colorScaleBivariate.d.ts +50 -0
- package/types/src/charts/features/colorScaleBucket.d.ts +10 -0
- package/types/src/charts/features/colorScaleHover.d.ts +13 -3
- package/types/src/charts/features/colorScaleLimit.d.ts +60 -0
- package/types/src/charts/features/colorScaleTooltip.d.ts +43 -0
- package/types/src/charts/features/colorScaleTop.d.ts +30 -0
- package/types/src/charts/features/curvedArrows.d.ts +14 -0
- package/types/src/charts/features/depthKey.d.ts +19 -0
- package/types/src/charts/features/edgeArrows.d.ts +29 -2
- package/types/src/charts/features/hoverTicks.d.ts +30 -0
- package/types/src/charts/features/idleQueue.d.ts +46 -0
- package/types/src/charts/features/linkInteraction.d.ts +13 -4
- package/types/src/charts/features/networkMeasures.d.ts +53 -0
- package/types/src/charts/features/nodeStats.d.ts +93 -0
- package/types/src/charts/features/plotEndLabels.d.ts +14 -1
- package/types/src/charts/features/textHalo.d.ts +4 -3
- package/types/src/charts/partition/chartFields.d.ts +6 -1
- package/types/src/charts/pipeline/insetPlacement.d.ts +6 -0
- package/types/src/charts/polar/chrome.d.ts +19 -6
- package/types/src/charts/viz/Viz.d.ts +10 -3
- package/types/src/charts/viz/VizBase.d.ts +31 -2
- package/types/src/charts/viz/backgroundInk.d.ts +8 -0
- package/types/src/charts/viz/emphasis.d.ts +17 -0
- package/types/src/charts/viz/fillStroke.d.ts +7 -0
- package/types/src/charts/viz/reportDrawError.d.ts +12 -0
- package/types/src/charts/viz/setCursor.d.ts +26 -0
- package/types/src/charts/viz/tooltipEnabled.d.ts +31 -0
- package/types/src/charts/viz/userClick.d.ts +35 -0
- package/types/src/charts/viz/vizFields.d.ts +5 -0
- package/types/src/charts/viz/vizTypes.d.ts +16 -0
- package/types/src/charts/viz/vizVisibility.d.ts +7 -0
- package/types/src/components/Axis/Axis.d.ts +33 -3
- package/types/src/components/Axis/axisBreak.d.ts +19 -3
- package/types/src/components/Axis/axisDefaults.d.ts +12 -0
- package/types/src/components/Axis/axisLabelKinds.d.ts +22 -0
- package/types/src/components/Axis/axisLabelLineHeight.d.ts +27 -0
- package/types/src/components/Axis/axisLabelRoom.d.ts +17 -0
- package/types/src/components/Axis/axisLabelSize.d.ts +82 -0
- package/types/src/components/Axis/axisLabelThinning.d.ts +38 -2
- package/types/src/components/Axis/axisLayout.d.ts +9 -2
- package/types/src/components/Axis/axisLayoutLabels.d.ts +28 -33
- package/types/src/components/Axis/axisLayoutScale.d.ts +3 -1
- package/types/src/components/Axis/axisLimit.d.ts +18 -0
- package/types/src/components/Axis/axisMaxSize.d.ts +48 -0
- package/types/src/components/Axis/axisRounding.d.ts +8 -0
- package/types/src/components/Axis/axisTitle.d.ts +30 -0
- package/types/src/components/Axis/axisTooltipTargets.d.ts +82 -0
- package/types/src/components/ColorScale/ColorScale.d.ts +21 -11
- package/types/src/components/ColorScale/bivariateRender.d.ts +53 -0
- package/types/src/components/ColorScale/bivariateScale.d.ts +92 -0
- package/types/src/components/ColorScale/colorScaleSwatchTooltips.d.ts +48 -0
- package/types/src/components/Legend/Legend.d.ts +5 -0
- package/types/src/components/Legend/legendCut.d.ts +31 -0
- package/types/src/components/Legend/legendRender.d.ts +6 -1
- package/types/src/components/TextBox.d.ts +4 -0
- package/types/src/components/textEllipsis.d.ts +6 -0
- package/types/src/fluent.d.ts +18 -0
- package/types/src/shapes/emitLabels.d.ts +1 -1
- package/types/src/utils/D3plusConfig.d.ts +485 -609
- package/types/src/utils/configValue.d.ts +8 -0
- package/types/src/utils/index.d.ts +1 -1
- package/types/umd-entry.d.ts +4 -0
- package/umd/d3plus-core.full.js +22930 -17936
- package/umd/d3plus-core.full.min.js +2 -2
- package/umd/d3plus-core.js +21240 -16404
- package/umd/d3plus-core.min.js +2 -2
|
@@ -35,6 +35,27 @@ export default class Axis extends BaseClass {
|
|
|
35
35
|
when its range is fixed.
|
|
36
36
|
*/
|
|
37
37
|
_labelOverflow: [number, number];
|
|
38
|
+
/**
|
|
39
|
+
Whether the `maxSize` is the chart's own default limit (see
|
|
40
|
+
`defaultMaxSize`), which lets one line of labels and the title take
|
|
41
|
+
more than it.
|
|
42
|
+
*/
|
|
43
|
+
_softMaxSize: boolean;
|
|
44
|
+
/**
|
|
45
|
+
Whether a vertical axis hides labels to give the ones it shows more
|
|
46
|
+
lines (see `thinForLines`): a bucketed ColorScale's.
|
|
47
|
+
*/
|
|
48
|
+
_thinForLines: boolean;
|
|
49
|
+
/** Whether the last layout pass left the title out to fit `maxSize` (see `measureAxis`). */
|
|
50
|
+
_dropTitle: boolean;
|
|
51
|
+
/**
|
|
52
|
+
How the last layout pass fit `maxSize`: how many shown labels it left
|
|
53
|
+
out, and the room the labels had (see `limitLabels`).
|
|
54
|
+
*/
|
|
55
|
+
_limited?: {
|
|
56
|
+
dropped: number;
|
|
57
|
+
room: number;
|
|
58
|
+
};
|
|
38
59
|
_position: {
|
|
39
60
|
horizontal: boolean;
|
|
40
61
|
width: string;
|
|
@@ -51,6 +72,12 @@ export default class Axis extends BaseClass {
|
|
|
51
72
|
}[];
|
|
52
73
|
_d3Scale: D3Scale | null;
|
|
53
74
|
_d3ScaleNegative: D3Scale | null;
|
|
75
|
+
/**
|
|
76
|
+
Whether the domain is handed over last value first, as a Plot hands its
|
|
77
|
+
y axes theirs (they run bottom to top). Tick tooltips count a
|
|
78
|
+
categorical axis's labels from the domain's start (see `tickRank`).
|
|
79
|
+
*/
|
|
80
|
+
_domainEndFirst: boolean;
|
|
54
81
|
/** The active baseline break, set by the layout pass (see `baselineBreak`). */
|
|
55
82
|
_baselineBreak: AxisBaselineBreak | null;
|
|
56
83
|
/** Every active break (baseline and explicit), set by the layout pass. */
|
|
@@ -130,8 +157,11 @@ export default class Axis extends BaseClass {
|
|
|
130
157
|
barConfig(_: Record<string, unknown>): this;
|
|
131
158
|
/**
|
|
132
159
|
Style of the breaks set with `break`: `space` (pixels of axis each break
|
|
133
|
-
occupies), `
|
|
134
|
-
|
|
160
|
+
occupies), `spaceMin` (the least `space` a break shrinks to when the
|
|
161
|
+
axis is too short to hold `space` and leave twice that for the data;
|
|
162
|
+
by default such a break is dropped), `gap` (pixels between its two
|
|
163
|
+
marks, where the axis line is not drawn; it shrinks with the break),
|
|
164
|
+
`size` (length of each mark, drawn outward from the axis
|
|
135
165
|
line on the tick side so it never reaches into the plot), `angle`
|
|
136
166
|
(degrees each mark tilts from perpendicular), `lines` (whether a Plot
|
|
137
167
|
runs a line across the plot from each mark, default `true`),
|
|
@@ -264,5 +294,5 @@ export interface AxisLayout {
|
|
|
264
294
|
margin: Record<string, number>;
|
|
265
295
|
}
|
|
266
296
|
export declare function computeAxisLayout(axis: Axis): AxisLayout;
|
|
267
|
-
export { measureAxis } from "./
|
|
297
|
+
export { measureAxis } from "./axisLimit.js";
|
|
268
298
|
export type { AxisLayoutResult } from "./axisLayout.js";
|
|
@@ -26,6 +26,11 @@ export interface AxisBreak {
|
|
|
26
26
|
baseline: boolean;
|
|
27
27
|
/** Whether shapes crossing the break get a gap cut across them (see `mask`). */
|
|
28
28
|
mask: boolean;
|
|
29
|
+
/**
|
|
30
|
+
The share of its `space` an explicit break takes when shrunk to fit the
|
|
31
|
+
axis (see `fitBreakSpace`); its gap shrinks by the same share.
|
|
32
|
+
*/
|
|
33
|
+
fit?: number;
|
|
29
34
|
}
|
|
30
35
|
/** The style of a break glyph, read from `breakConfig`/`baselineBreakConfig`. */
|
|
31
36
|
export interface BreakStyle {
|
|
@@ -55,11 +60,19 @@ export declare const baselineBreakStyle: (axis: Axis) => BreakStyle;
|
|
|
55
60
|
and only when the range is long enough to hold it.
|
|
56
61
|
*/
|
|
57
62
|
export declare function resolveBaselineBreak(axis: Axis, range: number[]): AxisBaselineBreak | null;
|
|
63
|
+
/**
|
|
64
|
+
The pixels each of `count` explicit breaks takes on an axis `length`
|
|
65
|
+
pixels long: `space`, or less when the axis can't hold that and still
|
|
66
|
+
leave twice a break's room for the data, down to `spaceMin`. `null` when
|
|
67
|
+
even `spaceMin` doesn't fit, and the breaks are dropped.
|
|
68
|
+
*/
|
|
69
|
+
export declare function fitBreakSpace(length: number, count: number, space: number, spaceMin?: number): number | null;
|
|
58
70
|
/**
|
|
59
71
|
Replaces a linear axis's scale with a broken one when it has a baseline
|
|
60
72
|
break or any `break` ranges inside its domain, and records the resolved
|
|
61
|
-
breaks on `axis._breaks`. Explicit breaks
|
|
62
|
-
|
|
73
|
+
breaks on `axis._breaks`. Explicit breaks shrink when the range can't
|
|
74
|
+
hold them and still leave twice a break's space for the data (down to
|
|
75
|
+
`breakConfig.spaceMin`), and are dropped below that.
|
|
63
76
|
*/
|
|
64
77
|
export declare function applyAxisBreaks(axis: Axis, range: number[]): void;
|
|
65
78
|
/**
|
|
@@ -68,7 +81,10 @@ export declare function applyAxisBreaks(axis: Axis, range: number[]): void;
|
|
|
68
81
|
"baseline, break, edge, …".
|
|
69
82
|
*/
|
|
70
83
|
export declare function breakTickValues(breaks: AxisBreak[], values: unknown[], addBaseline?: boolean): unknown[];
|
|
71
|
-
/**
|
|
84
|
+
/**
|
|
85
|
+
The pixel gap (`[from, to]`, ascending) a break leaves in the axis line,
|
|
86
|
+
shrunk with a break shrunk to fit the axis.
|
|
87
|
+
*/
|
|
72
88
|
export declare function breakGap(axis: Axis, brk: AxisBreak): [number, number];
|
|
73
89
|
/**
|
|
74
90
|
The axis's domain bar: a single line, or — on a broken axis — the bar
|
|
@@ -5,6 +5,18 @@ export declare function axisBarConfig(axis: Axis): Record<string, unknown>;
|
|
|
5
5
|
export declare function axisBreakConfig(axis: Axis): Record<string, unknown>;
|
|
6
6
|
/** The default `gridConfig`. */
|
|
7
7
|
export declare function axisGridConfig(axis: Axis): Record<string, unknown>;
|
|
8
|
+
/** How a cut tick label ends: as a TextBox line does, or nothing when no text fits. */
|
|
9
|
+
export declare const axisLabelEllipsis: (d: unknown) => string;
|
|
10
|
+
/**
|
|
11
|
+
The ellipsis a cut tick label is measured and painted with: the label
|
|
12
|
+
config's `ellipsis` (a string standing in for the cut line, as TextBox
|
|
13
|
+
reads one), else `axisLabelEllipsis`.
|
|
14
|
+
*/
|
|
15
|
+
export declare function labelEllipsis(shapeConfig?: {
|
|
16
|
+
labelConfig?: {
|
|
17
|
+
ellipsis?: unknown;
|
|
18
|
+
};
|
|
19
|
+
}): (text: string, line: number) => string;
|
|
8
20
|
/** The default `shapeConfig` (tick marks and their labels). */
|
|
9
21
|
export declare function axisShapeConfig(axis: Axis): Record<string, unknown>;
|
|
10
22
|
/** The default `titleConfig`. */
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
Which kind of labels an axis draws: one per category or value read in
|
|
3
|
+
sequence, and how much room each label of an uneven axis has.
|
|
4
|
+
*/
|
|
5
|
+
import type Axis from "./Axis.js";
|
|
6
|
+
/**
|
|
7
|
+
Each label's own share of an axis whose labels sit unevenly, such as one
|
|
8
|
+
label per variable-width bar (see `Plot/barWidth.ts`): reaching halfway to
|
|
9
|
+
the nearer of its neighbors on either side, so labels wrapped within their
|
|
10
|
+
shares never meet, while one between far-off neighbors keeps the room
|
|
11
|
+
they leave it. A lone label spans the whole range.
|
|
12
|
+
*/
|
|
13
|
+
export declare function ownLabelSpaces(positions: number[], rangeOuter: number[]): number[];
|
|
14
|
+
/**
|
|
15
|
+
Whether a horizontal axis's labels are values read in sequence (dates, or
|
|
16
|
+
numbers on a category axis) that are drawn whole on one line: thinned
|
|
17
|
+
rather than wrapped or cut short, since any one of them reads alone.
|
|
18
|
+
Labels naming categories wrap or rotate instead (see `rotatesLabels`).
|
|
19
|
+
*/
|
|
20
|
+
export declare function wholeLineLabels(axis: Axis, labels: unknown[]): boolean;
|
|
21
|
+
/** Whether a scale places one tick per category (every value labeled in turn). */
|
|
22
|
+
export declare function isDiscreteScale(scale: string): boolean;
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
The line height axis labels are measured and painted with, so a label
|
|
3
|
+
measured as N lines paints as N lines in the room measured for it.
|
|
4
|
+
*/
|
|
5
|
+
type Accessor<T> = T | ((d: unknown, i: number) => T);
|
|
6
|
+
/** The parts of an axis's `shapeConfig` that set its labels' line height. */
|
|
7
|
+
export interface LabelLineHeightConfig {
|
|
8
|
+
labelConfig?: {
|
|
9
|
+
fontSize?: Accessor<number>;
|
|
10
|
+
lineHeight?: Accessor<number>;
|
|
11
|
+
};
|
|
12
|
+
lineHeight?: Accessor<number>;
|
|
13
|
+
}
|
|
14
|
+
/** How many times its font size a label's line height is by default (TextBox's default). */
|
|
15
|
+
export declare const LABEL_LINE_HEIGHT = 1.2;
|
|
16
|
+
/**
|
|
17
|
+
The line height of the axis label for tick `d`: the label config's
|
|
18
|
+
`lineHeight` when set, else the shape config's, else 1.2 times the
|
|
19
|
+
label's `fontSize`, as the label's TextBox draws it by default.
|
|
20
|
+
@param shapeConfig The axis's `shapeConfig`.
|
|
21
|
+
@param d The tick value.
|
|
22
|
+
@param i The tick's index.
|
|
23
|
+
@param fontSize The label's font size, read from the label config when
|
|
24
|
+
not given.
|
|
25
|
+
*/
|
|
26
|
+
export declare function labelLineHeight(shapeConfig: LabelLineHeightConfig | undefined, d: unknown, i: number, fontSize?: number): number;
|
|
27
|
+
export {};
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { AxisTextDatum } from "./axisLayoutLabels.js";
|
|
2
|
+
/** A label's wrapped lines and size, as `measure` gives them. */
|
|
3
|
+
type Wrapped = Pick<AxisTextDatum, "lines" | "widths" | "width" | "height" | "cut">;
|
|
4
|
+
/**
|
|
5
|
+
A vertical axis paints its flat labels in a box as wide as the widest
|
|
6
|
+
one (see `buildTickData`), narrower than the room they were measured
|
|
7
|
+
in. Where a cut label's line breaks decides where it is cut, so each
|
|
8
|
+
label that doesn't fit is wrapped again in that box (by `measure`, which
|
|
9
|
+
wraps a label within its `room`) until the widest label holds; a label
|
|
10
|
+
that fits wraps the same in any box as wide as it, and a label whose
|
|
11
|
+
first word no longer fits is cut short in it (see `cutLabel`). Records
|
|
12
|
+
the box on each label as its `room`.
|
|
13
|
+
@param textData The axis's measured labels.
|
|
14
|
+
@param measure Wraps a label within its `room`.
|
|
15
|
+
*/
|
|
16
|
+
export declare function fitLabelRoom(textData: AxisTextDatum[], measure: (t: AxisTextDatum) => Wrapped): void;
|
|
17
|
+
export {};
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
import type { TextWrapGenerator, TextWrapResult } from "@d3plus/text";
|
|
2
|
+
import type Axis from "./Axis.js";
|
|
3
|
+
import type { AxisTextDatum } from "./axisLayoutLabels.js";
|
|
4
|
+
export interface LabelLayoutCtx {
|
|
5
|
+
horizontal: boolean;
|
|
6
|
+
hBuff: number;
|
|
7
|
+
p: number;
|
|
8
|
+
tickFormat: (d: unknown) => string;
|
|
9
|
+
/** Whether each label is measured on a single line (see `wholeLineLabels`). */
|
|
10
|
+
wholeLine?: boolean;
|
|
11
|
+
/**
|
|
12
|
+
Whether each label wraps within its own share of the axis (see
|
|
13
|
+
`ownLabelSpaces`) rather than the widest share any label has.
|
|
14
|
+
*/
|
|
15
|
+
ownSpace?: boolean;
|
|
16
|
+
/** The width slanted labels wrap at (see `slantedLineWidth`). */
|
|
17
|
+
slantWidth?: number;
|
|
18
|
+
/** Whether the labels keep within the axis's `maxSize` (see `strictMaxSize`). */
|
|
19
|
+
strict?: boolean;
|
|
20
|
+
/**
|
|
21
|
+
Whether a flat label too long for its share stays within it, cut short
|
|
22
|
+
(see `cutLabel`), rather than being measured across the axis.
|
|
23
|
+
*/
|
|
24
|
+
keepShare?: boolean;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
Cuts a label short to fit `width`: for a label whose first word is wider
|
|
28
|
+
than its room, which wraps to nothing. The word is cut to as many
|
|
29
|
+
characters as fit with the ellipsis after them (the wrap's own, else
|
|
30
|
+
`axisLabelEllipsis`), on one line; with no room for even one, the label
|
|
31
|
+
has no lines.
|
|
32
|
+
*/
|
|
33
|
+
export declare function cutLabel(wrap: TextWrapGenerator, text: string, width: number): TextWrapResult;
|
|
34
|
+
/**
|
|
35
|
+
Measures a flat label whose first word is wider than its room (`space`),
|
|
36
|
+
which wraps to nothing there. On a horizontal axis, where `space` is the
|
|
37
|
+
label's share of the axis: across the whole axis (`across` wide) instead,
|
|
38
|
+
so the overlap pass thins the labels out, or when it is too wide for that
|
|
39
|
+
as well, cut short within its share (see `cutLabel`). Labels in their own
|
|
40
|
+
shares are cut only when none fits whole (`keepShare`, see
|
|
41
|
+
`fitOwnSpaces`). On a vertical axis, where `space` is how far labels
|
|
42
|
+
reach out from the axis, the label is cut short within it (`keepShare`).
|
|
43
|
+
*/
|
|
44
|
+
export declare function longWordLabel(wrap: TextWrapGenerator, text: string, space: number, across: number, ctx: Pick<LabelLayoutCtx, "keepShare" | "ownSpace">): {
|
|
45
|
+
res: TextWrapResult;
|
|
46
|
+
cut: boolean;
|
|
47
|
+
};
|
|
48
|
+
/**
|
|
49
|
+
Wraps a slanted label onto fewer lines, each as long as the lines left
|
|
50
|
+
leave room for, until it reaches no further out from the axis than
|
|
51
|
+
`depth`. A label's every line adds its height to how far it reaches,
|
|
52
|
+
across the slant, so giving one up lets the others run further out. A
|
|
53
|
+
wrap that leaves no lines (a word too long for the line) doesn't count:
|
|
54
|
+
the next, longer line is tried, and a label cut short is measured with
|
|
55
|
+
the ellipsis its TextBox ends it with (the wrap's own, else
|
|
56
|
+
`axisLabelEllipsis`). `width` caps how long a line may be; `res` is the
|
|
57
|
+
label as first wrapped.
|
|
58
|
+
*/
|
|
59
|
+
export declare function slantWithin(wrap: TextWrapGenerator, text: string, res: TextWrapResult, slant: {
|
|
60
|
+
angle: number;
|
|
61
|
+
horizontal: boolean;
|
|
62
|
+
depth: number;
|
|
63
|
+
width: number;
|
|
64
|
+
}): TextWrapResult;
|
|
65
|
+
/** How far labels may reach out from the axis, past its ticks and margins. */
|
|
66
|
+
export declare function labelRoom(axis: Axis, horizontal: boolean, hBuff: number, p: number): number;
|
|
67
|
+
/** A label's wrapped lines and measured size (see `calculateLabelSize`). */
|
|
68
|
+
export type LabelSize = {
|
|
69
|
+
lines: string[];
|
|
70
|
+
widths: number[];
|
|
71
|
+
width: number;
|
|
72
|
+
height: number;
|
|
73
|
+
fits: boolean;
|
|
74
|
+
/** Whether the label is cut short mid-word to fit (see `cutLabel`). */
|
|
75
|
+
cut: boolean;
|
|
76
|
+
};
|
|
77
|
+
/**
|
|
78
|
+
Wraps + measures a single label, returning its sized text result. Given a
|
|
79
|
+
`cache`, a label whose text, font, and space match one measured before
|
|
80
|
+
reuses that measurement.
|
|
81
|
+
*/
|
|
82
|
+
export declare function calculateLabelSize(axis: Axis, datum: AxisTextDatum, ctx: LabelLayoutCtx, cache?: Map<string, LabelSize>): LabelSize;
|
|
@@ -20,9 +20,45 @@ export declare function labelExtent(datum: Pick<AxisTextDatum, "angle" | "slant"
|
|
|
20
20
|
scale's `range`, each tick at its slot's center: one bar each, for one
|
|
21
21
|
label per bar), so where two narrow neighbors can't both fit, the
|
|
22
22
|
narrower bar's label is the one hidden; every other label stays as it
|
|
23
|
-
is.
|
|
23
|
+
is. A label with none shown beside it widens no further than the ends
|
|
24
|
+
of the axis (`bounds`, the scale's `range` by default) allow, centered
|
|
25
|
+
on its tick. When no label fits whole, each is drawn in its own share
|
|
26
|
+
instead, cut short if need be. `resize` measures a label again at a
|
|
27
|
+
given width, within that width when `keepShare`.
|
|
24
28
|
*/
|
|
25
|
-
export declare function fitOwnSpaces(textData: AxisTextDatum[], spaces: number[], range: number[], resize: (datum: AxisTextDatum, space: number) => AxisTextDatum): void;
|
|
29
|
+
export declare function fitOwnSpaces(textData: AxisTextDatum[], spaces: number[], range: number[], resize: (datum: AxisTextDatum, space: number, keepShare?: boolean) => AxisTextDatum, bounds?: number[]): void;
|
|
30
|
+
/**
|
|
31
|
+
The widest a label centered on its tick at `position` can be without
|
|
32
|
+
reaching past either end of `bounds` (0 for a tick outside them).
|
|
33
|
+
*/
|
|
34
|
+
export declare function roomAround(position: number, bounds: number[]): number;
|
|
35
|
+
/**
|
|
36
|
+
Measures each label left shown along a vertical axis again in the room
|
|
37
|
+
the hidden labels beside it leave: up to its padding short of the
|
|
38
|
+
nearest label shown on either side, and of the ends of the axis
|
|
39
|
+
(`bounds`), centered on its tick. Labels are first measured in room for
|
|
40
|
+
one at every tick, so the ones left shown after thinning could take more
|
|
41
|
+
lines. Only labels that don't fit whole are measured again, and only in
|
|
42
|
+
more room than they had; that room keeps them clear of their neighbors
|
|
43
|
+
and within the axis, so no two shown labels crowd and none reaches
|
|
44
|
+
further past an end than before.
|
|
45
|
+
*/
|
|
46
|
+
export declare function regrowShown(textData: AxisTextDatum[], resize: (datum: AxisTextDatum, space: number) => AxisTextDatum, bounds: number[]): void;
|
|
47
|
+
/**
|
|
48
|
+
Picks which labels a vertical axis shows so that each takes as many
|
|
49
|
+
lines as it can, as a gradient color scale's few labels do: for a
|
|
50
|
+
bucketed color scale, whose every bucket has a label. While some label
|
|
51
|
+
shown is cut short, labels are hidden at an even interval, the first
|
|
52
|
+
and last always kept, until every label shown fits whole, or else as far
|
|
53
|
+
as gives the labels shown the most lines (the fewest any of them has),
|
|
54
|
+
hiding no more labels than that takes. Each label shown is measured in
|
|
55
|
+
the room between the nearest labels shown on either side, up to its
|
|
56
|
+
padding short of them (a label at an end, twice its distance to the one
|
|
57
|
+
beside it), and never less than every label had at first (`floor`):
|
|
58
|
+
one at an end reaching past the end of the axis narrows the axis's
|
|
59
|
+
range, as a gradient's do. `resize` measures a label again in a room.
|
|
60
|
+
*/
|
|
61
|
+
export declare function thinForLines(textData: AxisTextDatum[], resize: (datum: AxisTextDatum, space: number) => AxisTextDatum, floor: number): void;
|
|
26
62
|
/**
|
|
27
63
|
Hides labels on a discrete axis at a regular interval: every label when
|
|
28
64
|
they all fit side by side, otherwise every second label, or third, and so
|
|
@@ -24,14 +24,21 @@ export interface AxisLayoutResult {
|
|
|
24
24
|
Axis-instance shape (the production `Axis` class is the canonical input).
|
|
25
25
|
Pure compute — no DOM, no rendering. Mutates the input to set
|
|
26
26
|
`_d3Scale`/`_outerBounds`/`_margin`/etc. for callers that read those off
|
|
27
|
-
the instance afterward.
|
|
27
|
+
the instance afterward. `measureAxis` (see `axisLimit.ts`) runs it again
|
|
28
|
+
without the title when the labels don't fit `maxSize` beside it.
|
|
28
29
|
*/
|
|
29
|
-
export declare function
|
|
30
|
+
export declare function layoutAxis(axis: Axis): AxisLayoutResult;
|
|
30
31
|
/**
|
|
31
32
|
How far the first and last slanted labels shown reach past the start and
|
|
32
33
|
end of `range`, along the axis (0 when they don't, or aren't slanted).
|
|
33
34
|
*/
|
|
34
35
|
export declare function slantedOverflow(axis: Axis, textData: AxisTextDatum[], range: number[]): [number, number];
|
|
36
|
+
/**
|
|
37
|
+
Whether staggered labels, each row as deep as its labels and the second
|
|
38
|
+
row set out past the first, reach out from the axis no further than
|
|
39
|
+
`room`.
|
|
40
|
+
*/
|
|
41
|
+
export declare function staggerFits(textData: AxisTextDatum[], room: number, horizontal: boolean): boolean;
|
|
35
42
|
/**
|
|
36
43
|
Whether the axis may rotate its labels on its own: one label per category
|
|
37
44
|
naming things rather than numbers or dates, which read in sequence even
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import type Axis from "./Axis.js";
|
|
2
|
+
import type { LabelLayoutCtx } from "./axisLabelSize.js";
|
|
3
|
+
export { isDiscreteScale, ownLabelSpaces, wholeLineLabels, } from "./axisLabelKinds.js";
|
|
2
4
|
/** Resolves a tick's pixel size from the shape config (or a constant). */
|
|
3
5
|
export type TickGet = (d?: {
|
|
4
6
|
tick?: boolean;
|
|
@@ -15,6 +17,7 @@ export interface AxisTextDatum {
|
|
|
15
17
|
fF: string;
|
|
16
18
|
fP: number;
|
|
17
19
|
fS: number;
|
|
20
|
+
/** The label's line height, measured and painted (see `labelLineHeight`). */
|
|
18
21
|
lineHeight: number;
|
|
19
22
|
position: number;
|
|
20
23
|
rotate?: boolean;
|
|
@@ -32,32 +35,31 @@ export interface AxisTextDatum {
|
|
|
32
35
|
cut off, and none broken across lines with a hyphen.
|
|
33
36
|
*/
|
|
34
37
|
fits: boolean;
|
|
38
|
+
/** Whether the label is drawn cut short mid-word (see `cutLabel`). */
|
|
39
|
+
cut?: boolean;
|
|
35
40
|
/** Whether the overlap pass hides the label to make room for its neighbors. */
|
|
36
41
|
truncated?: boolean;
|
|
37
42
|
offset?: number;
|
|
38
|
-
}
|
|
39
|
-
interface LabelLayoutCtx {
|
|
40
|
-
horizontal: boolean;
|
|
41
|
-
hBuff: number;
|
|
42
|
-
p: number;
|
|
43
|
-
tickFormat: (d: unknown) => string;
|
|
44
|
-
/** Whether each label is measured on a single line (see `wholeLineLabels`). */
|
|
45
|
-
wholeLine?: boolean;
|
|
46
43
|
/**
|
|
47
|
-
|
|
48
|
-
`
|
|
44
|
+
The width a flat label on a vertical axis wraps in, and is painted in
|
|
45
|
+
(see `fitLabelRoom`); unset, it wraps in all the room the axis allows.
|
|
49
46
|
*/
|
|
50
|
-
|
|
51
|
-
/** The width slanted labels wrap at (see `slantedLineWidth`). */
|
|
52
|
-
slantWidth?: number;
|
|
47
|
+
room?: number;
|
|
53
48
|
}
|
|
54
|
-
/**
|
|
49
|
+
/**
|
|
50
|
+
Applies the axis title's wrapped height to the orient-side margin, as
|
|
51
|
+
the title TextBox draws it across `range` (see `titleRoom`). Given the
|
|
52
|
+
range it was `measured` across before, it measures again only when the
|
|
53
|
+
range has changed. Returns the range measured across. A title left out
|
|
54
|
+
(see `measureAxis` in `axisLimit.ts`) claims no room.
|
|
55
|
+
*/
|
|
55
56
|
export declare function applyTitleMargin(axis: Axis, ctx: {
|
|
56
57
|
range: number[];
|
|
57
58
|
p: number;
|
|
58
59
|
height: string;
|
|
59
60
|
margin: Record<string, number>;
|
|
60
|
-
|
|
61
|
+
measured?: number[];
|
|
62
|
+
}): number[];
|
|
61
63
|
/** Resolves the tick height/width buffers from the shape config. */
|
|
62
64
|
export declare function computeBuffers(axis: Axis, _ticks: unknown[], tickGet: TickGet, height: string): {
|
|
63
65
|
hBuff: number;
|
|
@@ -71,24 +73,9 @@ export declare function createTextData(axis: Axis, ctx: LabelLayoutCtx & {
|
|
|
71
73
|
labels: unknown[];
|
|
72
74
|
rangeOuter: number[];
|
|
73
75
|
offset?: number;
|
|
76
|
+
/** Whether the labels left shown take the room hidden ones leave (see `regrowShown`). */
|
|
77
|
+
regrow?: boolean;
|
|
74
78
|
}): AxisTextDatum[];
|
|
75
|
-
/**
|
|
76
|
-
Each label's own share of an axis whose labels sit unevenly, such as one
|
|
77
|
-
label per variable-width bar (see `Plot/barWidth.ts`): reaching halfway to
|
|
78
|
-
the nearer of its neighbors on either side, so labels wrapped within their
|
|
79
|
-
shares never meet, while one between far-off neighbors keeps the room
|
|
80
|
-
they leave it. A lone label spans the whole range.
|
|
81
|
-
*/
|
|
82
|
-
export declare function ownLabelSpaces(positions: number[], rangeOuter: number[]): number[];
|
|
83
|
-
/**
|
|
84
|
-
Whether a horizontal axis's labels are values read in sequence (dates, or
|
|
85
|
-
numbers on a category axis) that are drawn whole on one line: thinned
|
|
86
|
-
rather than wrapped or cut short, since any one of them reads alone.
|
|
87
|
-
Labels naming categories wrap or rotate instead (see `rotatesLabels`).
|
|
88
|
-
*/
|
|
89
|
-
export declare function wholeLineLabels(axis: Axis, labels: unknown[]): boolean;
|
|
90
|
-
/** Whether a scale places one tick per category (every value labeled in turn). */
|
|
91
|
-
export declare function isDiscreteScale(scale: string): boolean;
|
|
92
79
|
/**
|
|
93
80
|
How far a measured label reaches out from the axis: its height when it
|
|
94
81
|
lies flat along a horizontal axis, its width when it stands out from the
|
|
@@ -96,6 +83,15 @@ export declare function isDiscreteScale(scale: string): boolean;
|
|
|
96
83
|
padding on a horizontal axis, as its height holds).
|
|
97
84
|
*/
|
|
98
85
|
export declare function labelDepth(t: AxisTextDatum, horizontal: boolean): number;
|
|
86
|
+
/**
|
|
87
|
+
Leaves out each label that reaches further out from the axis than
|
|
88
|
+
`room` (what its strict `maxSize` leaves the labels, see
|
|
89
|
+
`strictMaxSize`), a staggered one by its row's offset too: it is hidden,
|
|
90
|
+
and claims no room. A label with no lines left in that room is hidden
|
|
91
|
+
too. Returns how many of the labels shown it left out for reaching too
|
|
92
|
+
far.
|
|
93
|
+
*/
|
|
94
|
+
export declare function limitLabels(textData: AxisTextDatum[], horizontal: boolean, room: number): number;
|
|
99
95
|
/** Derives `_outerBounds` + axis margins from the measured text data. */
|
|
100
96
|
export declare function computeAxisBounds(axis: Axis, ctx: {
|
|
101
97
|
textData: AxisTextDatum[];
|
|
@@ -110,4 +106,3 @@ export declare function computeAxisBounds(axis: Axis, ctx: {
|
|
|
110
106
|
opposite: string;
|
|
111
107
|
margin: Record<string, number>;
|
|
112
108
|
}): Record<string, number>;
|
|
113
|
-
export {};
|
|
@@ -5,8 +5,10 @@ import type { TickGet } from "./axisLayoutLabels.js";
|
|
|
5
5
|
Builds the tick label formatter (user-supplied or scale-derived). With a
|
|
6
6
|
`rotatedTickFormat`, the formatter reads `axis._labelRotation` on every
|
|
7
7
|
call, so labels measured and painted rotated use that one instead.
|
|
8
|
+
`getLabels` returns the values the axis labels, which decide the
|
|
9
|
+
open-ended labels of an axis rounded "inside".
|
|
8
10
|
*/
|
|
9
|
-
export declare function buildTickFormat(axis: Axis, timeLocaleObj: TimeLocaleDefinition,
|
|
11
|
+
export declare function buildTickFormat(axis: Axis, timeLocaleObj: TimeLocaleDefinition, getLabels: () => unknown[]): (d: unknown) => string;
|
|
10
12
|
/**
|
|
11
13
|
The label lists an axis chooses among, when its `labels` is a list of
|
|
12
14
|
lists (from the most labels to the fewest): the layout labels the first
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
/**
|
|
2
|
+
Lays an axis out within its `maxSize` (see `strictMaxSize`): when the
|
|
3
|
+
labels can't fit beside the title, the title gives way, and when they
|
|
4
|
+
can't fit at all, the labels do. Pure compute, no DOM.
|
|
5
|
+
*/
|
|
6
|
+
import type Axis from "./Axis.js";
|
|
7
|
+
import type { AxisLayoutResult } from "./axisLayout.js";
|
|
8
|
+
/**
|
|
9
|
+
Lays out `axis` (see `layoutAxis`) and returns the layout the paint
|
|
10
|
+
phase draws. A label that reaches further out from the axis than its
|
|
11
|
+
`maxSize` leaves room for is left out (see `limitLabels`). When that
|
|
12
|
+
leaves out any label shown, a title is left out instead if every label
|
|
13
|
+
then fits; otherwise the labels are left out and the title stays, unless
|
|
14
|
+
the title alone takes more than the `maxSize` too. The ticks, the axis
|
|
15
|
+
line and its bar still draw, and the axis claims only the room of what
|
|
16
|
+
it draws.
|
|
17
|
+
*/
|
|
18
|
+
export declare function measureAxis(axis: Axis): AxisLayoutResult;
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import type { AxisConfig } from "../../utils/D3plusConfig.js";
|
|
2
|
+
type MaxSize = AxisConfig["maxSize"];
|
|
3
|
+
/** The limit a `maxSize` sets: a function is called with `size`, a number is the limit itself. */
|
|
4
|
+
export declare function resolveMaxSize(maxSize: MaxSize, size: number): number | undefined;
|
|
5
|
+
/**
|
|
6
|
+
The limit an axis's `maxSize` sets, read against the room the axis has
|
|
7
|
+
across its labels: its height when it lies `horizontal`, else its width.
|
|
8
|
+
*/
|
|
9
|
+
export declare function axisMaxSize(schema: {
|
|
10
|
+
maxSize?: MaxSize;
|
|
11
|
+
width?: number;
|
|
12
|
+
height?: number;
|
|
13
|
+
}, horizontal: boolean): number | undefined;
|
|
14
|
+
/**
|
|
15
|
+
Replaces a function `maxSize` on `axis` with the limit it sets for `size`,
|
|
16
|
+
so an axis drawn at another size than it was measured at keeps the limit
|
|
17
|
+
it was measured with.
|
|
18
|
+
*/
|
|
19
|
+
export declare function pinMaxSize<T extends {
|
|
20
|
+
schema: {
|
|
21
|
+
maxSize?: MaxSize;
|
|
22
|
+
};
|
|
23
|
+
}>(axis: T, size: number): T;
|
|
24
|
+
/**
|
|
25
|
+
Marks the `maxSize` a chart gives `axis` as the chart's own default
|
|
26
|
+
limit, unless one of `configs` (the configs the chart applies to the
|
|
27
|
+
axis, the user's among them) sets a `maxSize`. A default limit wraps the
|
|
28
|
+
labels within it, but lets the axis take more than it to draw one line
|
|
29
|
+
of labels and the title (see `strictMaxSize`).
|
|
30
|
+
*/
|
|
31
|
+
export declare function defaultMaxSize<T extends {
|
|
32
|
+
_softMaxSize?: boolean;
|
|
33
|
+
}>(axis: T, ...configs: unknown[]): T;
|
|
34
|
+
/**
|
|
35
|
+
Whether `axis` keeps all it claims across its labels within its
|
|
36
|
+
`maxSize`, however its labels are laid out (wrapped, slanted, upright or
|
|
37
|
+
staggered), leaving out the labels and title that don't fit: any finite
|
|
38
|
+
`maxSize` but a chart's own default (see `defaultMaxSize`).
|
|
39
|
+
*/
|
|
40
|
+
export declare function strictMaxSize(axis: {
|
|
41
|
+
schema: {
|
|
42
|
+
maxSize?: MaxSize;
|
|
43
|
+
width?: number;
|
|
44
|
+
height?: number;
|
|
45
|
+
};
|
|
46
|
+
_softMaxSize?: boolean;
|
|
47
|
+
}, horizontal: boolean): boolean;
|
|
48
|
+
export {};
|
|
@@ -15,3 +15,11 @@ export declare const roundingScales: string[];
|
|
|
15
15
|
scale's domain rounds as a linear one does.
|
|
16
16
|
*/
|
|
17
17
|
export declare function roundedDomain(initialDomain: number[], rounding: string, scale: string): number[] | undefined;
|
|
18
|
+
/**
|
|
19
|
+
The open end of an axis rounded "inside" that the value `d` labels, if
|
|
20
|
+
any: "min" when `d` is the lowest of the `values` the axis labels and
|
|
21
|
+
the `domain` reaches down to it, "max" when it is the highest and the
|
|
22
|
+
domain reaches up to it. A value beyond the domain has nothing past it,
|
|
23
|
+
so it is not open-ended.
|
|
24
|
+
*/
|
|
25
|
+
export declare function openEnd(d: unknown, values: unknown[], domain: unknown[]): "min" | "max" | undefined;
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
The axis title, configured once for both the measure and the paint, so
|
|
3
|
+
the title claims exactly the room it draws.
|
|
4
|
+
*/
|
|
5
|
+
import type { DataPoint } from "@d3plus/data";
|
|
6
|
+
import TextBox from "../TextBox.js";
|
|
7
|
+
import type Axis from "./Axis.js";
|
|
8
|
+
/**
|
|
9
|
+
Whether the first word of `box`'s text is wider than its line on its
|
|
10
|
+
own, as the wrap measures it. The wrap can't place such a word on any
|
|
11
|
+
line, so the box would draw nothing.
|
|
12
|
+
*/
|
|
13
|
+
export declare function firstWordOverflows(box: TextBox, d: DataPoint, i: number): boolean;
|
|
14
|
+
/**
|
|
15
|
+
Configures `box` as the axis title wrapped across `range`, in a box
|
|
16
|
+
`height` tall: its text, width, rotation, and `titleConfig`. A first
|
|
17
|
+
word too wide for the axis is cut mid-word with the ellipsis
|
|
18
|
+
(`truncateWord`), so the title still draws; any other title cut short
|
|
19
|
+
ends at a word break. A `truncateWord` in `titleConfig` overrides both.
|
|
20
|
+
A title left out (see `measureAxis` in `axisLimit.ts`) has no data, so
|
|
21
|
+
draws nothing.
|
|
22
|
+
*/
|
|
23
|
+
export declare function configureTitle(box: TextBox, axis: Axis, range: number[], height: number): TextBox;
|
|
24
|
+
/**
|
|
25
|
+
The room the axis title claims on the axis's side: its lines as the
|
|
26
|
+
title TextBox wraps them across `range`, within `height`, to the whole
|
|
27
|
+
pixel, plus the axis's padding. A title that draws nothing claims no
|
|
28
|
+
room.
|
|
29
|
+
*/
|
|
30
|
+
export declare function titleRoom(axis: Axis, range: number[], height: number): number;
|