Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Remove x2/y2 channels for overlaying line and point #8472

Merged
merged 3 commits into from Oct 12, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Binary file added examples/compiled/area_overlay_with_y2.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions examples/compiled/area_overlay_with_y2.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
166 changes: 166 additions & 0 deletions examples/compiled/area_overlay_with_y2.vg.json
@@ -0,0 +1,166 @@
{
"$schema": "https://vega.github.io/schema/vega/v5.json",
"description": "Google's stock price over time.",
"background": "white",
"padding": 5,
"width": 200,
"height": 200,
"style": "cell",
"data": [
{
"name": "source_0",
"url": "data/stocks.csv",
"format": {"type": "csv", "parse": {"date": "date"}},
"transform": [{"type": "filter", "expr": "datum.symbol==='GOOG'"}]
},
{
"name": "data_0",
"source": "source_0",
"transform": [
{
"type": "filter",
"expr": "(isDate(datum[\"date\"]) || (isValid(datum[\"date\"]) && isFinite(+datum[\"date\"]))) && isValid(datum[\"price\"]) && isFinite(+datum[\"price\"])"
}
]
}
],
"marks": [
{
"name": "layer_0_marks",
"type": "area",
"style": ["area"],
"sort": {"field": "datum[\"date\"]"},
"from": {"data": "source_0"},
"encode": {
"update": {
"opacity": {"value": 0.7},
"orient": {"value": "vertical"},
"fill": {"value": "#4c78a8"},
"description": {
"signal": "\"date: \" + (timeFormat(datum[\"date\"], '%b %d, %Y')) + \"; price: \" + (format(datum[\"price\"], \"\"))"
},
"x": {"scale": "x", "field": "date"},
"y": {"scale": "y", "field": "price"},
"y2": {"scale": "y", "value": 0},
"defined": {
"signal": "isValid(datum[\"date\"]) && isFinite(+datum[\"date\"]) && isValid(datum[\"price\"]) && isFinite(+datum[\"price\"])"
}
}
}
},
{
"name": "layer_1_marks",
"type": "line",
"style": ["line"],
"sort": {"field": "datum[\"date\"]"},
"from": {"data": "source_0"},
"encode": {
"update": {
"stroke": {"value": "#4c78a8"},
"description": {
"signal": "\"date: \" + (timeFormat(datum[\"date\"], '%b %d, %Y')) + \"; price: \" + (format(datum[\"price\"], \"\"))"
},
"x": {"scale": "x", "field": "date"},
"y": {"scale": "y", "field": "price"},
"defined": {
"signal": "isValid(datum[\"date\"]) && isFinite(+datum[\"date\"]) && isValid(datum[\"price\"]) && isFinite(+datum[\"price\"])"
}
}
}
},
{
"name": "layer_2_marks",
"type": "symbol",
"style": ["point"],
"from": {"data": "data_0"},
"encode": {
"update": {
"opacity": {"value": 1},
"fill": {"value": "#4c78a8"},
"ariaRoleDescription": {"value": "point"},
"description": {
"signal": "\"date: \" + (timeFormat(datum[\"date\"], '%b %d, %Y')) + \"; price: \" + (format(datum[\"price\"], \"\"))"
},
"x": {"scale": "x", "field": "date"},
"y": {"scale": "y", "field": "price"}
}
}
}
],
"scales": [
{
"name": "x",
"type": "time",
"domain": {
"fields": [
{"data": "source_0", "field": "date"},
{"data": "data_0", "field": "date"}
]
},
"range": [0, {"signal": "width"}]
},
{
"name": "y",
"type": "linear",
"domain": {
"fields": [
{"data": "source_0", "field": "price"},
[0],
{"data": "data_0", "field": "price"}
]
},
"range": [{"signal": "height"}, 0],
"nice": true,
"zero": true
}
],
"axes": [
{
"scale": "x",
"orient": "bottom",
"gridScale": "y",
"grid": true,
"tickCount": {"signal": "ceil(width/40)"},
"domain": false,
"labels": false,
"aria": false,
"maxExtent": 0,
"minExtent": 0,
"ticks": false,
"zindex": 0
},
{
"scale": "y",
"orient": "left",
"gridScale": "x",
"grid": true,
"tickCount": {"signal": "ceil(height/40)"},
"domain": false,
"labels": false,
"aria": false,
"maxExtent": 0,
"minExtent": 0,
"ticks": false,
"zindex": 0
},
{
"scale": "x",
"orient": "bottom",
"grid": false,
"title": "date",
"labelFlush": true,
"labelOverlap": true,
"tickCount": {"signal": "ceil(width/40)"},
"zindex": 0
},
{
"scale": "y",
"orient": "left",
"grid": false,
"title": "price",
"labelOverlap": true,
"tickCount": {"signal": "ceil(height/40)"},
"zindex": 0
}
]
}
12 changes: 12 additions & 0 deletions examples/specs/area_overlay_with_y2.vl.json
@@ -0,0 +1,12 @@
{
"$schema": "https://vega.github.io/schema/vega-lite/v5.json",
"description": "Google's stock price over time.",
"data": {"url": "data/stocks.csv"},
"transform": [{"filter": "datum.symbol==='GOOG'"}],
"mark": {"type": "area", "line": true, "point": true},
"encoding": {
"x": {"field": "date", "type": "temporal"},
"y": {"field": "price", "type": "quantitative"},
"y2": {"datum": 0, "type": "quantitative"}
}
}
30 changes: 30 additions & 0 deletions examples/specs/normalized/area_overlay_with_y2_normalized.vl.json
@@ -0,0 +1,30 @@
{
"$schema": "https://vega.github.io/schema/vega-lite/v5.json",
"description": "Google's stock price over time.",
"data": {"url": "data/stocks.csv"},
"transform": [{"filter": "datum.symbol==='GOOG'"}],
"layer": [
{
"mark": {"opacity": 0.7, "type": "area"},
"encoding": {
"x": {"field": "date", "type": "temporal"},
"y": {"field": "price", "type": "quantitative"},
"y2": {"datum": 0, "type": "quantitative"}
}
},
{
"mark": {"type": "line"},
"encoding": {
"x": {"field": "date", "type": "temporal"},
"y": {"field": "price", "type": "quantitative"}
}
},
{
"mark": {"type": "point", "opacity": 1, "filled": true},
"encoding": {
"x": {"field": "date", "type": "temporal"},
"y": {"field": "price", "type": "quantitative"}
}
}
]
}
4 changes: 2 additions & 2 deletions src/normalize/pathoverlay.ts
Expand Up @@ -151,7 +151,7 @@ export class PathOverlayNormalizer implements NonFacetUnitNormalizer<UnitSpecWit
...pick(markDef, ['clip', 'interpolate', 'tension', 'tooltip']),
...lineOverlay
},
encoding: overlayEncoding
encoding: omit(overlayEncoding, ['y2', 'x2'])
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(minor) Probably better to do this above once

overlayEncoding = omit(overlayEncoding , ['y2', 'x2'])); 

above add comment to explain why y2/x2 shouldn't be a part of "overlayEncoding". (Describe an example that we need to trigger this case.)

});
}
if (pointOverlay) {
Expand All @@ -164,7 +164,7 @@ export class PathOverlayNormalizer implements NonFacetUnitNormalizer<UnitSpecWit
...pick(markDef, ['clip', 'tooltip']),
...pointOverlay
},
encoding: overlayEncoding
encoding: omit(overlayEncoding, ['y2', 'x2'])
});
}

Expand Down
42 changes: 42 additions & 0 deletions test/normalize/pathoverlay.test.ts
Expand Up @@ -185,6 +185,48 @@ describe('PathOverlayNormalizer', () => {
});
});

it('correctly normalizes area using y2 with overlay line.', () => {
const spec: TopLevelSpec = {
data: {url: 'data/stocks.csv'},
mark: 'area',
encoding: {
x: {field: 'date', type: 'temporal'},
y: {field: 'price', type: 'quantitative'},
y2: {value: 0, type: 'quantitative'}
},
config: {area: {line: {}, point: {}}}
};
const normalizedSpec = normalize(spec);
expect(normalizedSpec).toEqual({
data: {url: 'data/stocks.csv'},
layer: [
{
mark: {type: 'area', opacity: 0.7},
encoding: {
x: {field: 'date', type: 'temporal'},
y: {field: 'price', type: 'quantitative'},
y2: {value: 0, type: 'quantitative'}
}
},
{
mark: {type: 'line'},
encoding: {
x: {field: 'date', type: 'temporal'},
y: {field: 'price', type: 'quantitative', stack: 'zero'}
}
},
{
mark: {type: 'point', opacity: 1, filled: true},
encoding: {
x: {field: 'date', type: 'temporal'},
y: {field: 'price', type: 'quantitative', stack: 'zero'}
}
}
],
config: {area: {line: {}, point: {}}}
});
});

it('correctly normalizes interpolated area with overlay line', () => {
const spec: TopLevelSpec = {
data: {url: 'data/stocks.csv'},
Expand Down