diff --git a/examples/specs/normalized/test_invalid_break_paths_and_keep_path_domains_normalized.vl.json b/examples/specs/normalized/test_invalid_break_paths_and_show_path_domains_normalized.vl.json
similarity index 97%
rename from examples/specs/normalized/test_invalid_break_paths_and_keep_path_domains_normalized.vl.json
rename to examples/specs/normalized/test_invalid_break_paths_and_show_path_domains_normalized.vl.json
index b413b3f6c4..6584d12dd4 100644
--- a/examples/specs/normalized/test_invalid_break_paths_and_keep_path_domains_normalized.vl.json
+++ b/examples/specs/normalized/test_invalid_break_paths_and_show_path_domains_normalized.vl.json
@@ -14,7 +14,7 @@
]
},
"config": {
- "mark": {"invalid": "break-paths-and-keep-path-domains", "tooltip": true}
+ "mark": {"invalid": "break-paths-and-show-path-domains", "tooltip": true}
},
"vconcat": [
{
@@ -122,4 +122,4 @@
]
}
]
-}
\ No newline at end of file
+}
diff --git a/examples/specs/normalized/test_invalid_break_paths_keep_domains_normalized.vl.json b/examples/specs/normalized/test_invalid_break_paths_show_domains_normalized.vl.json
similarity index 97%
rename from examples/specs/normalized/test_invalid_break_paths_keep_domains_normalized.vl.json
rename to examples/specs/normalized/test_invalid_break_paths_show_domains_normalized.vl.json
index af866e78a7..bf8082942d 100644
--- a/examples/specs/normalized/test_invalid_break_paths_keep_domains_normalized.vl.json
+++ b/examples/specs/normalized/test_invalid_break_paths_show_domains_normalized.vl.json
@@ -13,7 +13,7 @@
{"a": 10, "b": null}
]
},
- "config": {"mark": {"invalid": "break-paths-keep-domains", "tooltip": true}},
+ "config": {"mark": {"invalid": "break-paths-show-domains", "tooltip": true}},
"vconcat": [
{
"title": "Quantitative X",
@@ -120,4 +120,4 @@
]
}
]
-}
\ No newline at end of file
+}
diff --git a/examples/specs/test_invalid_break_paths_and_keep_path_domains.vl.json b/examples/specs/test_invalid_break_paths_and_show_path_domains.vl.json
similarity index 97%
rename from examples/specs/test_invalid_break_paths_and_keep_path_domains.vl.json
rename to examples/specs/test_invalid_break_paths_and_show_path_domains.vl.json
index b3e4f93e57..6201b9c877 100644
--- a/examples/specs/test_invalid_break_paths_and_keep_path_domains.vl.json
+++ b/examples/specs/test_invalid_break_paths_and_show_path_domains.vl.json
@@ -14,7 +14,7 @@
]
},
"config": {
- "mark": {"invalid": "break-paths-and-keep-path-domains", "tooltip": true}
+ "mark": {"invalid": "break-paths-and-show-path-domains", "tooltip": true}
},
"vconcat": [{
"title": "Quantitative X",
diff --git a/examples/specs/test_invalid_break_paths_keep_domains.vl.json b/examples/specs/test_invalid_break_paths_show_domains.vl.json
similarity index 97%
rename from examples/specs/test_invalid_break_paths_keep_domains.vl.json
rename to examples/specs/test_invalid_break_paths_show_domains.vl.json
index 6b37dd2125..5c8fae98dd 100644
--- a/examples/specs/test_invalid_break_paths_keep_domains.vl.json
+++ b/examples/specs/test_invalid_break_paths_show_domains.vl.json
@@ -14,7 +14,7 @@
]
},
"config": {
- "mark": {"invalid": "break-paths-keep-domains", "tooltip": true}
+ "mark": {"invalid": "break-paths-show-domains", "tooltip": true}
},
"vconcat": [{
"title": "Quantitative X",
diff --git a/site/docs/invaliddata.md b/site/docs/invaliddata.md
index 6dfd1220a9..db70054a19 100644
--- a/site/docs/invaliddata.md
+++ b/site/docs/invaliddata.md
@@ -64,7 +64,7 @@ Break path marks (for line, area, trail) at invalid values. For non-path marks,
-#### `"break-paths-keep-domains"`
+#### `"break-paths-show-domains"`
This option is like `"break-paths"`, except that all _scale_ domains will instead _include_ these filtered data points.
@@ -78,9 +78,9 @@ Include all data points in the marks and scale domains. Each scale will use the
-#### `break-paths-and-keep-path-domains` (Default)
+#### `break-paths-and-show-path-domains` (Default)
-For historical reasons, Vega-Lite 5 currently uses `"break-paths-and-keep-path-domains"` as the default invalid data mode (to avoid breaking changes). This is equivalent to `"break-path-keep-domains"` for path-based marks (line/area/trail) and `"filter"` for other marks.
+For historical reasons, Vega-Lite 5 currently uses `"break-paths-and-show-path-domains"` as the default invalid data mode (to avoid breaking changes). This is equivalent to `"break-path-keep-domains"` for path-based marks (line/area/trail) and `"filter"` for other marks.
diff --git a/src/compile/invalid/ScaleInvalidDataMode.ts b/src/compile/invalid/ScaleInvalidDataMode.ts
index 1ce523925e..52a33b5c7a 100644
--- a/src/compile/invalid/ScaleInvalidDataMode.ts
+++ b/src/compile/invalid/ScaleInvalidDataMode.ts
@@ -8,9 +8,9 @@ import {getMarkPropOrConfig} from '../common';
import {normalizeInvalidDataMode} from './normalizeInvalidDataMode';
export type ScaleInvalidDataMode =
- // remove 'break-paths-and-keep-path-domains' from MarkInvalidDataMode
+ // remove 'break-paths-and-show-path-domains' from MarkInvalidDataMode
// because it is a macro for '"filter"' or `"break-path-keep-domains`
- | Omit
+ | Omit
// Add always-valid because at scale level, categorical scales can handle any values and thus is always valid.
| 'always-valid';
@@ -47,5 +47,5 @@ export function getScaleInvalidDataMode({
return invalidMode;
}
export function shouldBreakPath(mode: ScaleInvalidDataMode): boolean {
- return mode === 'break-paths-filter-domains' || mode === 'break-paths-keep-domains';
+ return mode === 'break-paths-filter-domains' || mode === 'break-paths-show-domains';
}
diff --git a/src/compile/invalid/datasources.ts b/src/compile/invalid/datasources.ts
index 36c3fd34be..75f1b00e7b 100644
--- a/src/compile/invalid/datasources.ts
+++ b/src/compile/invalid/datasources.ts
@@ -27,7 +27,7 @@ export function getDataSourcesForHandlingInvalidValues({
marks: 'exclude-invalid-values',
scales: 'exclude-invalid-values'
};
- case 'break-paths-keep-domains':
+ case 'break-paths-show-domains':
return {
// Path-based marks use pre-filter data so we know to skip these invalid points in the path.
// For non-path based marks, we skip by not showing them at all.
@@ -39,7 +39,7 @@ export function getDataSourcesForHandlingInvalidValues({
// For non-path marks, we can use the filtered data for both marks and scales.
return {
marks: isPath ? 'include-invalid-values' : 'exclude-invalid-values',
- // Unlike 'break-paths-keep-domains', 'break-paths-filter-domains' uses post-filter data to feed scale.
+ // Unlike 'break-paths-show-domains', 'break-paths-filter-domains' uses post-filter data to feed scale.
scales: 'exclude-invalid-values'
};
case 'show':
diff --git a/src/compile/invalid/normalizeInvalidDataMode.ts b/src/compile/invalid/normalizeInvalidDataMode.ts
index 4a92185818..5f0d95628a 100644
--- a/src/compile/invalid/normalizeInvalidDataMode.ts
+++ b/src/compile/invalid/normalizeInvalidDataMode.ts
@@ -1,13 +1,13 @@
import {MarkInvalidDataMode} from '../../invalid';
-type NormalizedMarkInvalidDataMode = Exclude;
+type NormalizedMarkInvalidDataMode = Exclude;
export function normalizeInvalidDataMode(
mode: MarkInvalidDataMode | null | undefined,
{isPath}: {isPath: boolean}
): NormalizedMarkInvalidDataMode {
- if (mode === undefined || mode === 'break-paths-and-keep-path-domains') {
- return isPath ? 'break-paths-keep-domains' : 'filter';
+ if (mode === undefined || mode === 'break-paths-and-show-path-domains') {
+ return isPath ? 'break-paths-show-domains' : 'filter';
} else if (mode === null) {
return 'show';
}
diff --git a/src/invalid.ts b/src/invalid.ts
index b827542b0f..453f5af289 100644
--- a/src/invalid.ts
+++ b/src/invalid.ts
@@ -17,7 +17,7 @@ export interface MarkInvalidMixins {
* Break path marks (for line, area, trail) at invalid values. For non-path marks, this is equivalent to `"filter"`.
* All *scale* domains will *exclude* these filtered data points.
*
- * - `"break-paths-keep-domains"` —
+ * - `"break-paths-show-domains"` —
* Break paths (for line, area, trail) at invalid values. Hide invalid values for non-path marks.
* All *scale* domains will *include* these filtered data points.
*
@@ -25,7 +25,7 @@ export interface MarkInvalidMixins {
* Show all data points in the marks and scale domains. Each scale will use the output for invalid values defined in `config.scale.invalid`
* or, if unspecified, by default invalid values will produce the same visual values as zero (if the scale includes zero) or the minimum value (if the scale does not include zero).
*
- * - `"break-paths-and-keep-path-domains"` (default) —
+ * - `"break-paths-and-show-path-domains"` (default) —
* This is equivalent to `"break-path-keep-domains"` for path-based marks (line/area/trail)
* and `"filter"` for other marks.
*
@@ -39,8 +39,8 @@ export interface MarkInvalidMixins {
export type MarkInvalidDataMode =
| 'filter'
| 'break-paths-filter-domains'
- | 'break-paths-keep-domains'
- | 'break-paths-and-keep-path-domains'
+ | 'break-paths-show-domains'
+ | 'break-paths-and-show-path-domains'
| 'show';
/**
diff --git a/src/mark.ts b/src/mark.ts
index a8bd718cab..8809e325f1 100644
--- a/src/mark.ts
+++ b/src/mark.ts
@@ -338,7 +338,7 @@ export const VL_ONLY_MARK_SPECIFIC_CONFIG_PROPERTY_INDEX: {
export const defaultMarkConfig: MarkConfig = {
color: '#4c78a8',
- invalid: 'break-paths-and-keep-path-domains',
+ invalid: 'break-paths-and-show-path-domains',
timeUnitBandSize: 1
};
diff --git a/test/compile/invalid/ChannelInvalidDataMode.test.ts b/test/compile/invalid/ChannelInvalidDataMode.test.ts
index 8a6a4af535..7153b46c07 100644
--- a/test/compile/invalid/ChannelInvalidDataMode.test.ts
+++ b/test/compile/invalid/ChannelInvalidDataMode.test.ts
@@ -8,9 +8,9 @@ describe('compile / invalid / ChannelInvalidDataMode / getChannelInvalidDataMode
const ALL_MARK_INVALID_MODE: MarkInvalidDataMode[] = [
'filter',
'break-paths-filter-domains',
- 'break-paths-keep-domains',
+ 'break-paths-show-domains',
'show',
- 'break-paths-and-keep-path-domains'
+ 'break-paths-and-show-path-domains'
];
describe.each([...PRIMITIVE_MARKS])('For all marks (%s)', mark => {
@@ -133,7 +133,7 @@ describe('compile / invalid / ChannelInvalidDataMode / getChannelInvalidDataMode
});
describe.each(SCALE_CHANNELS)('for all scale channel (%s)', channel => {
- const OTHER_MODES: MarkInvalidDataMode[] = ['break-paths-filter-domains', 'break-paths-keep-domains', 'filter'];
+ const OTHER_MODES: MarkInvalidDataMode[] = ['break-paths-filter-domains', 'break-paths-show-domains', 'filter'];
it.each(OTHER_MODES)('should return the mode (%s)', mode => {
expect(
@@ -160,7 +160,7 @@ describe('compile / invalid / ChannelInvalidDataMode / getChannelInvalidDataMode
it('should return the mode (%s)', () => {
expect(
getScaleInvalidDataMode({
- markDef: {type: mark, invalid: 'break-paths-and-keep-path-domains'},
+ markDef: {type: mark, invalid: 'break-paths-and-show-path-domains'},
scaleChannel: channel,
scaleType: 'linear',
isCountAggregate: false,
@@ -172,7 +172,7 @@ describe('compile / invalid / ChannelInvalidDataMode / getChannelInvalidDataMode
}
}
})
- ).toBe('break-paths-keep-domains');
+ ).toBe('break-paths-show-domains');
});
});
});
@@ -182,7 +182,7 @@ describe('compile / invalid / ChannelInvalidDataMode / getChannelInvalidDataMode
it('should return the mode (%s)', () => {
expect(
getScaleInvalidDataMode({
- markDef: {type: mark, invalid: 'break-paths-and-keep-path-domains'},
+ markDef: {type: mark, invalid: 'break-paths-and-show-path-domains'},
scaleChannel: channel,
scaleType: 'linear',
isCountAggregate: false,
@@ -194,7 +194,7 @@ describe('compile / invalid / ChannelInvalidDataMode / getChannelInvalidDataMode
}
}
})
- ).toBe('break-paths-keep-domains');
+ ).toBe('break-paths-show-domains');
});
});
});
diff --git a/test/compile/mark/text.test.ts b/test/compile/mark/text.test.ts
index 286002bbdf..2da1adf086 100644
--- a/test/compile/mark/text.test.ts
+++ b/test/compile/mark/text.test.ts
@@ -215,7 +215,7 @@ describe('Mark: Text', () => {
},
data: {url: 'data/cars.json'},
config: {
- mark: {invalid: 'break-paths-keep-domains'}
+ mark: {invalid: 'break-paths-show-domains'}
}
};
const model = parseModelWithScale(spec);
diff --git a/test/compile/selection/layers.test.ts b/test/compile/selection/layers.test.ts
index 244c92e8f6..c1d072e143 100644
--- a/test/compile/selection/layers.test.ts
+++ b/test/compile/selection/layers.test.ts
@@ -43,7 +43,7 @@ describe('Layered Selections', () => {
}
}
],
- config: {mark: {tooltip: null, invalid: 'break-paths-keep-domains'}}
+ config: {mark: {tooltip: null, invalid: 'break-paths-show-domains'}}
});
layers.parse();
diff --git a/test/compile/selection/timeunit.test.ts b/test/compile/selection/timeunit.test.ts
index 24c94360fc..5ab2dee4c8 100644
--- a/test/compile/selection/timeunit.test.ts
+++ b/test/compile/selection/timeunit.test.ts
@@ -110,7 +110,7 @@ describe('Selection time unit', () => {
y: {field: 'price', type: 'quantitative'}
}
},
- {mark: {invalid: 'break-paths-keep-domains'}}
+ {mark: {invalid: 'break-paths-show-domains'}}
);
const data0 = getData(model).filter(d => d.name === 'data_0')[0].transform;
const data1 = getData(model).filter(d => d.name === 'data_1')[0].transform;