@spectrum-charts/vega-spec-builder-s2 0.3.1 → 0.4.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/dist/@types/src/area/areaSpecBuilder.d.ts +1 -1
- package/dist/@types/src/area/areaUtils.d.ts +2 -2
- package/dist/@types/src/axis/axisLabelHoverUtils.d.ts +22 -0
- package/dist/@types/src/axis/axisLabelHoverUtils.d.ts.map +1 -0
- package/dist/@types/src/axis/axisLabelHoverUtils.test.d.ts +2 -0
- package/dist/@types/src/axis/axisLabelHoverUtils.test.d.ts.map +1 -0
- package/dist/@types/src/axis/axisReferenceLineUtils.d.ts +11 -7
- package/dist/@types/src/axis/axisReferenceLineUtils.d.ts.map +1 -1
- package/dist/@types/src/axis/axisSpecBuilder.d.ts +1 -0
- package/dist/@types/src/axis/axisSpecBuilder.d.ts.map +1 -1
- package/dist/@types/src/axis/axisTestUtils.d.ts.map +1 -1
- package/dist/@types/src/axisAnnotation/axisAnnotationUtils.d.ts +1 -1
- package/dist/@types/src/bar/barSpecBuilder.d.ts.map +1 -1
- package/dist/@types/src/bar/barUtils.d.ts +23 -0
- package/dist/@types/src/bar/barUtils.d.ts.map +1 -1
- package/dist/@types/src/bar/dodgedBarUtils.d.ts.map +1 -1
- package/dist/@types/src/bar/dodgedBarUtils.test.d.ts.map +1 -1
- package/dist/@types/src/bar/stackedBarUtils.d.ts.map +1 -1
- package/dist/@types/src/barDirectLabel/barDirectLabelUtils.d.ts.map +1 -1
- package/dist/@types/src/chartInspect/chartInspectUtils.d.ts +53 -0
- package/dist/@types/src/{chartTooltip/chartTooltipUtils.d.ts.map → chartInspect/chartInspectUtils.d.ts.map} +1 -1
- package/dist/@types/src/chartInspect/chartInspectUtils.test.d.ts +2 -0
- package/dist/@types/src/chartInspect/chartInspectUtils.test.d.ts.map +1 -0
- package/dist/@types/src/chartSpecBuilder.d.ts +1 -1
- package/dist/@types/src/chartSpecBuilder.d.ts.map +1 -1
- package/dist/@types/src/data/dataUtils.d.ts +2 -2
- package/dist/@types/src/donut/donutSpecBuilder.d.ts.map +1 -1
- package/dist/@types/src/donut/donutUtils.d.ts +22 -1
- package/dist/@types/src/donut/donutUtils.d.ts.map +1 -1
- package/dist/@types/src/donut/donutUtils.test.d.ts +2 -0
- package/dist/@types/src/donut/donutUtils.test.d.ts.map +1 -0
- package/dist/@types/src/donut/segmentLabelUtils.d.ts.map +1 -1
- package/dist/@types/src/legend/legendHighlightUtils.d.ts +24 -2
- package/dist/@types/src/legend/legendHighlightUtils.d.ts.map +1 -1
- package/dist/@types/src/legend/legendSpecBuilder.d.ts.map +1 -1
- package/dist/@types/src/legend/legendUtils.d.ts +5 -5
- package/dist/@types/src/legend/legendUtils.d.ts.map +1 -1
- package/dist/@types/src/line/directLabelUtils.d.ts +39 -0
- package/dist/@types/src/line/directLabelUtils.d.ts.map +1 -0
- package/dist/@types/src/line/lineDataUtils.d.ts +23 -0
- package/dist/@types/src/line/lineDataUtils.d.ts.map +1 -1
- package/dist/@types/src/line/lineMarkUtils.d.ts +25 -2
- package/dist/@types/src/line/lineMarkUtils.d.ts.map +1 -1
- package/dist/@types/src/line/linePointAnnotation/index.d.ts +2 -0
- package/dist/@types/src/line/linePointAnnotation/index.d.ts.map +1 -0
- package/dist/@types/src/line/linePointAnnotation/linePointAnnotationUtils.d.ts +6 -0
- package/dist/@types/src/line/linePointAnnotation/linePointAnnotationUtils.d.ts.map +1 -0
- package/dist/@types/src/line/linePointAnnotation/linePointAnnotationUtils.test.d.ts +2 -0
- package/dist/@types/src/line/linePointAnnotation/linePointAnnotationUtils.test.d.ts.map +1 -0
- package/dist/@types/src/line/linePointUtils.d.ts +9 -2
- package/dist/@types/src/line/linePointUtils.d.ts.map +1 -1
- package/dist/@types/src/line/lineSpecBuilder.d.ts +5 -1
- package/dist/@types/src/line/lineSpecBuilder.d.ts.map +1 -1
- package/dist/@types/src/line/lineTestUtils.d.ts.map +1 -1
- package/dist/@types/src/line/lineUtils.d.ts +12 -2
- package/dist/@types/src/line/lineUtils.d.ts.map +1 -1
- package/dist/@types/src/lineDirectLabel/lineDirectLabelUtils.d.ts +2 -2
- package/dist/@types/src/lineDirectLabel/lineDirectLabelUtils.d.ts.map +1 -1
- package/dist/@types/src/lineForecast/index.d.ts +2 -0
- package/dist/@types/src/lineForecast/index.d.ts.map +1 -0
- package/dist/@types/src/lineForecast/lineForecastUtils.d.ts +8 -0
- package/dist/@types/src/lineForecast/lineForecastUtils.d.ts.map +1 -0
- package/dist/@types/src/lineForecast/lineForecastUtils.test.d.ts +2 -0
- package/dist/@types/src/lineForecast/lineForecastUtils.test.d.ts.map +1 -0
- package/dist/@types/src/marks/hoverAnimationUtils.d.ts +93 -0
- package/dist/@types/src/marks/hoverAnimationUtils.d.ts.map +1 -0
- package/dist/@types/src/marks/hoverAnimationUtils.test.d.ts +2 -0
- package/dist/@types/src/marks/hoverAnimationUtils.test.d.ts.map +1 -0
- package/dist/@types/src/marks/markUtils.d.ts +17 -12
- package/dist/@types/src/marks/markUtils.d.ts.map +1 -1
- package/dist/@types/src/metricRange/metricRangeUtils.d.ts +1 -1
- package/dist/@types/src/metricRange/metricRangeUtils.d.ts.map +1 -1
- package/dist/@types/src/signal/signalSpecBuilder.d.ts +1 -1
- package/dist/@types/src/signal/signalSpecBuilder.d.ts.map +1 -1
- package/dist/@types/src/specTestUtils.d.ts +20 -0
- package/dist/@types/src/specTestUtils.d.ts.map +1 -1
- package/dist/@types/src/specUtils.d.ts +6 -2
- package/dist/@types/src/specUtils.d.ts.map +1 -1
- package/dist/@types/src/trendline/trendlineTestUtils.d.ts.map +1 -1
- package/dist/@types/src/trendline/trendlineUtils.d.ts +1 -1
- package/dist/@types/src/types/axis/axisAnnotationSpec.types.d.ts +3 -3
- package/dist/@types/src/types/axis/axisSpec.types.d.ts +3 -1
- package/dist/@types/src/types/axis/axisSpec.types.d.ts.map +1 -1
- package/dist/@types/src/types/axis/referenceLineSpec.types.d.ts +5 -0
- package/dist/@types/src/types/axis/referenceLineSpec.types.d.ts.map +1 -1
- package/dist/@types/src/types/chartSpec.types.d.ts +2 -0
- package/dist/@types/src/types/chartSpec.types.d.ts.map +1 -1
- package/dist/@types/src/types/dialogs/chartInspectSpec.types.d.ts +14 -0
- package/dist/@types/src/types/dialogs/{chartTooltipSpec.types.d.ts.map → chartInspectSpec.types.d.ts.map} +1 -1
- package/dist/@types/src/types/dialogs/index.d.ts +1 -1
- package/dist/@types/src/types/legendSpec.types.d.ts +7 -0
- package/dist/@types/src/types/legendSpec.types.d.ts.map +1 -1
- package/dist/@types/src/types/marks/areaSpec.types.d.ts +4 -4
- package/dist/@types/src/types/marks/areaSpec.types.d.ts.map +1 -1
- package/dist/@types/src/types/marks/barSpec.types.d.ts +3 -3
- package/dist/@types/src/types/marks/donutSpec.types.d.ts +3 -3
- package/dist/@types/src/types/marks/lineSpec.types.d.ts +65 -6
- package/dist/@types/src/types/marks/lineSpec.types.d.ts.map +1 -1
- package/dist/@types/src/types/marks/scatterSpec.types.d.ts +3 -3
- package/dist/@types/src/types/marks/supplemental/barDirectLabelSpec.types.d.ts +4 -1
- package/dist/@types/src/types/marks/supplemental/barDirectLabelSpec.types.d.ts.map +1 -1
- package/dist/@types/src/types/marks/supplemental/index.d.ts +2 -0
- package/dist/@types/src/types/marks/supplemental/index.d.ts.map +1 -1
- package/dist/@types/src/types/marks/supplemental/lineDirectLabelSpec.types.d.ts +2 -0
- package/dist/@types/src/types/marks/supplemental/lineDirectLabelSpec.types.d.ts.map +1 -1
- package/dist/@types/src/types/marks/supplemental/lineForecastSpec.types.d.ts +23 -0
- package/dist/@types/src/types/marks/supplemental/lineForecastSpec.types.d.ts.map +1 -0
- package/dist/@types/src/types/marks/supplemental/linePointAnnotationSpec.types.d.ts +19 -0
- package/dist/@types/src/types/marks/supplemental/linePointAnnotationSpec.types.d.ts.map +1 -0
- package/dist/@types/src/types/marks/supplemental/metricRangeSpec.types.d.ts +3 -3
- package/dist/@types/src/types/marks/supplemental/trendlineSpec.types.d.ts +4 -4
- package/dist/@types/src/types/marks/supplemental/trendlineSpec.types.d.ts.map +1 -1
- package/dist/@types/src/types/marks/vennSpec.types.d.ts +3 -3
- package/dist/@types/src/types/specUtil.types.d.ts +9 -3
- package/dist/@types/src/types/specUtil.types.d.ts.map +1 -1
- package/dist/@types/src/vegaEmbedUtils.d.ts +8 -0
- package/dist/@types/src/vegaEmbedUtils.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.LICENSE.txt +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +5 -5
- package/dist/@types/src/chartTooltip/chartTooltipUtils.d.ts +0 -54
- package/dist/@types/src/chartTooltip/chartTooltipUtils.test.d.ts +0 -2
- package/dist/@types/src/chartTooltip/chartTooltipUtils.test.d.ts.map +0 -1
- package/dist/@types/src/types/dialogs/chartTooltipSpec.types.d.ts +0 -14
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@spectrum-charts/vega-spec-builder-s2",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"description": "Vega spec builder for Spectrum 2 charts (S2 always enabled)",
|
|
5
5
|
"browser": "dist/index.js",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -24,10 +24,10 @@
|
|
|
24
24
|
"publish-package": "npm publish --access public --tag alpha --registry https://registry.npmjs.org"
|
|
25
25
|
},
|
|
26
26
|
"dependencies": {
|
|
27
|
-
"@spectrum-charts/constants": "1.
|
|
28
|
-
"@spectrum-charts/locales": "1.
|
|
29
|
-
"@spectrum-charts/themes": "1.
|
|
30
|
-
"@spectrum-charts/utils": "1.
|
|
27
|
+
"@spectrum-charts/constants": "1.47.0",
|
|
28
|
+
"@spectrum-charts/locales": "1.47.0",
|
|
29
|
+
"@spectrum-charts/themes": "1.47.0",
|
|
30
|
+
"@spectrum-charts/utils": "1.47.0",
|
|
31
31
|
"immer": "^10.1.1",
|
|
32
32
|
"vega": "^6.2.0",
|
|
33
33
|
"venn-helper": "^2.3.6"
|
|
@@ -1,54 +0,0 @@
|
|
|
1
|
-
import { Data, FormulaTransform, NumericValueRef, Signal } from 'vega';
|
|
2
|
-
import { AreaSpecOptions, BarSpecOptions, ChartTooltipOptions, ChartTooltipSpecOptions, DonutSpecOptions, LineSpecOptions, ScatterSpecOptions, VennSpecOptions } from '../types';
|
|
3
|
-
type TooltipParentOptions = AreaSpecOptions | BarSpecOptions | DonutSpecOptions | LineSpecOptions | ScatterSpecOptions | VennSpecOptions;
|
|
4
|
-
/**
|
|
5
|
-
* gets all the tooltips
|
|
6
|
-
* @param markOptions
|
|
7
|
-
* @returns
|
|
8
|
-
*/
|
|
9
|
-
export declare const getTooltips: (markOptions: TooltipParentOptions) => ChartTooltipSpecOptions[];
|
|
10
|
-
/**
|
|
11
|
-
* Applies all defaults to ChartTooltipOptions
|
|
12
|
-
* @param chartTooltipOptions
|
|
13
|
-
* @returns ChartTooltipSpecOptions
|
|
14
|
-
*/
|
|
15
|
-
export declare const applyTooltipPropDefaults: ({ highlightBy, targets, ...options }: ChartTooltipOptions, markName: string) => ChartTooltipSpecOptions;
|
|
16
|
-
/**
|
|
17
|
-
* Sets all the data needed for tooltips
|
|
18
|
-
*
|
|
19
|
-
* NOTE: this function mutates the data object so it should only be called from a produce function
|
|
20
|
-
* @param data
|
|
21
|
-
* @param chartTooltipOptions
|
|
22
|
-
*/
|
|
23
|
-
export declare const addTooltipData: (data: Data[], markOptions: TooltipParentOptions, addHighlightedData?: boolean) => void;
|
|
24
|
-
/**
|
|
25
|
-
* Gets the group id transform
|
|
26
|
-
* @param highlightBy
|
|
27
|
-
* @param markName
|
|
28
|
-
* @returns FormulaTransform
|
|
29
|
-
*/
|
|
30
|
-
export declare const getGroupIdTransform: (highlightBy: string[], markName: string) => FormulaTransform;
|
|
31
|
-
export declare const isHighlightedByGroup: (markOptions: TooltipParentOptions) => boolean;
|
|
32
|
-
/**
|
|
33
|
-
* Tooltip highlights by item or dimension
|
|
34
|
-
* @param markOptions
|
|
35
|
-
* @returns
|
|
36
|
-
*/
|
|
37
|
-
export declare const isHighlightedByDimension: (markOptions: TooltipParentOptions) => boolean;
|
|
38
|
-
/**
|
|
39
|
-
* adds the appropriate signals for tooltips
|
|
40
|
-
*
|
|
41
|
-
* NOTE: this function mutates the signals array so it should only be called from a produce function
|
|
42
|
-
* @param signals
|
|
43
|
-
* @param markOptions
|
|
44
|
-
*/
|
|
45
|
-
export declare const addTooltipSignals: (signals: Signal[], markOptions: TooltipParentOptions) => void;
|
|
46
|
-
export declare const addHoveredItemOpacityRules: (opacityRules: ({
|
|
47
|
-
test?: string;
|
|
48
|
-
} & NumericValueRef)[], markOptions: TooltipParentOptions) => void;
|
|
49
|
-
export declare const addHoverdDimenstionAreaOpacityRules: (opacityRules: ({
|
|
50
|
-
test?: string;
|
|
51
|
-
} & NumericValueRef)[], markOptions: TooltipParentOptions) => void;
|
|
52
|
-
export declare const hasTooltipWithDimensionAreaTarget: (chartTooltips: ChartTooltipOptions[]) => boolean;
|
|
53
|
-
export {};
|
|
54
|
-
//# sourceMappingURL=chartTooltipUtils.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"chartTooltipUtils.test.d.ts","sourceRoot":"","sources":["../../../../src/chartTooltip/chartTooltipUtils.test.ts"],"names":[],"mappings":""}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import { PartiallyRequired } from '../specUtil.types';
|
|
2
|
-
export interface ChartTooltipOptions {
|
|
3
|
-
/** The keys in the data that will disable the tooltip if they have truthy values */
|
|
4
|
-
excludeDataKeys?: string[];
|
|
5
|
-
/** Sets which marks should be highlighted when a tooltip is visible */
|
|
6
|
-
highlightBy?: 'series' | 'dimension' | 'item' | string[];
|
|
7
|
-
targets?: ('dimensionArea' | 'item')[];
|
|
8
|
-
}
|
|
9
|
-
type ChartTooltipOptionsWithDefaults = 'highlightBy' | 'targets';
|
|
10
|
-
export interface ChartTooltipSpecOptions extends PartiallyRequired<ChartTooltipOptions, ChartTooltipOptionsWithDefaults> {
|
|
11
|
-
markName: string;
|
|
12
|
-
}
|
|
13
|
-
export {};
|
|
14
|
-
//# sourceMappingURL=chartTooltipSpec.types.d.ts.map
|