Skip to content

Commit

Permalink
fix: move __Default value:__ above JSDoc tags (#7746)
Browse files Browse the repository at this point in the history
* move __Default value:__ above JSDoc tags

* commit changes to build artifacts
  • Loading branch information
stevenlandis-rl authored Oct 9, 2021
1 parent c84e581 commit 134dc24
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 39 deletions.
96 changes: 64 additions & 32 deletions build/vega-lite-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The inner radius in pixels of arc marks. `innerRadius` is an alias for `radius2`."
"description": "The inner radius in pixels of arc marks. `innerRadius` is an alias for `radius2`.\n\n__Default value:__ `0`",
"minimum": 0
},
"interpolate": {
"anyOf": [
Expand Down Expand Up @@ -597,7 +598,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The outer radius in pixels of arc marks. `outerRadius` is an alias for `radius`."
"description": "The outer radius in pixels of arc marks. `outerRadius` is an alias for `radius`.\n\n__Default value:__ `0`",
"minimum": 0
},
"padAngle": {
"anyOf": [
Expand Down Expand Up @@ -634,7 +636,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "For arc mark, the primary (outer) radius in pixels.\n\nFor text marks, polar coordinate radial offset, in pixels, of the text from the origin determined by the `x` and `y` properties."
"description": "For arc mark, the primary (outer) radius in pixels.\n\nFor text marks, polar coordinate radial offset, in pixels, of the text from the origin determined by the `x` and `y` properties.\n\n__Default value:__ `min(plot_width, plot_height)/2`",
"minimum": 0
},
"radius2": {
"anyOf": [
Expand All @@ -645,7 +648,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The secondary (inner) radius in pixels of arc marks."
"description": "The secondary (inner) radius in pixels of arc marks.\n\n__Default value:__ `0`",
"minimum": 0
},
"shape": {
"anyOf": [
Expand Down Expand Up @@ -3341,7 +3345,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The inner radius in pixels of arc marks. `innerRadius` is an alias for `radius2`."
"description": "The inner radius in pixels of arc marks. `innerRadius` is an alias for `radius2`.\n\n__Default value:__ `0`",
"minimum": 0
},
"interpolate": {
"anyOf": [
Expand Down Expand Up @@ -3431,7 +3436,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The outer radius in pixels of arc marks. `outerRadius` is an alias for `radius`."
"description": "The outer radius in pixels of arc marks. `outerRadius` is an alias for `radius`.\n\n__Default value:__ `0`",
"minimum": 0
},
"padAngle": {
"anyOf": [
Expand All @@ -3453,7 +3459,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "For arc mark, the primary (outer) radius in pixels.\n\nFor text marks, polar coordinate radial offset, in pixels, of the text from the origin determined by the `x` and `y` properties."
"description": "For arc mark, the primary (outer) radius in pixels.\n\nFor text marks, polar coordinate radial offset, in pixels, of the text from the origin determined by the `x` and `y` properties.\n\n__Default value:__ `min(plot_width, plot_height)/2`",
"minimum": 0
},
"radius2": {
"anyOf": [
Expand All @@ -3464,7 +3471,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The secondary (inner) radius in pixels of arc marks."
"description": "The secondary (inner) radius in pixels of arc marks.\n\n__Default value:__ `0`",
"minimum": 0
},
"shape": {
"anyOf": [
Expand Down Expand Up @@ -14649,7 +14657,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The inner radius in pixels of arc marks. `innerRadius` is an alias for `radius2`."
"description": "The inner radius in pixels of arc marks. `innerRadius` is an alias for `radius2`.\n\n__Default value:__ `0`",
"minimum": 0
},
"interpolate": {
"anyOf": [
Expand Down Expand Up @@ -14739,7 +14748,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The outer radius in pixels of arc marks. `outerRadius` is an alias for `radius`."
"description": "The outer radius in pixels of arc marks. `outerRadius` is an alias for `radius`.\n\n__Default value:__ `0`",
"minimum": 0
},
"padAngle": {
"anyOf": [
Expand Down Expand Up @@ -14776,7 +14786,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "For arc mark, the primary (outer) radius in pixels.\n\nFor text marks, polar coordinate radial offset, in pixels, of the text from the origin determined by the `x` and `y` properties."
"description": "For arc mark, the primary (outer) radius in pixels.\n\nFor text marks, polar coordinate radial offset, in pixels, of the text from the origin determined by the `x` and `y` properties.\n\n__Default value:__ `min(plot_width, plot_height)/2`",
"minimum": 0
},
"radius2": {
"anyOf": [
Expand All @@ -14787,7 +14798,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The secondary (inner) radius in pixels of arc marks."
"description": "The secondary (inner) radius in pixels of arc marks.\n\n__Default value:__ `0`",
"minimum": 0
},
"shape": {
"anyOf": [
Expand Down Expand Up @@ -15774,7 +15786,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The inner radius in pixels of arc marks. `innerRadius` is an alias for `radius2`."
"description": "The inner radius in pixels of arc marks. `innerRadius` is an alias for `radius2`.\n\n__Default value:__ `0`",
"minimum": 0
},
"interpolate": {
"anyOf": [
Expand Down Expand Up @@ -15864,7 +15877,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The outer radius in pixels of arc marks. `outerRadius` is an alias for `radius`."
"description": "The outer radius in pixels of arc marks. `outerRadius` is an alias for `radius`.\n\n__Default value:__ `0`",
"minimum": 0
},
"padAngle": {
"anyOf": [
Expand All @@ -15886,7 +15900,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "For arc mark, the primary (outer) radius in pixels.\n\nFor text marks, polar coordinate radial offset, in pixels, of the text from the origin determined by the `x` and `y` properties."
"description": "For arc mark, the primary (outer) radius in pixels.\n\nFor text marks, polar coordinate radial offset, in pixels, of the text from the origin determined by the `x` and `y` properties.\n\n__Default value:__ `min(plot_width, plot_height)/2`",
"minimum": 0
},
"radius2": {
"anyOf": [
Expand All @@ -15897,7 +15912,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The secondary (inner) radius in pixels of arc marks."
"description": "The secondary (inner) radius in pixels of arc marks.\n\n__Default value:__ `0`",
"minimum": 0
},
"shape": {
"anyOf": [
Expand Down Expand Up @@ -16607,7 +16623,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The inner radius in pixels of arc marks. `innerRadius` is an alias for `radius2`."
"description": "The inner radius in pixels of arc marks. `innerRadius` is an alias for `radius2`.\n\n__Default value:__ `0`",
"minimum": 0
},
"interpolate": {
"anyOf": [
Expand Down Expand Up @@ -16708,7 +16725,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The outer radius in pixels of arc marks. `outerRadius` is an alias for `radius`."
"description": "The outer radius in pixels of arc marks. `outerRadius` is an alias for `radius`.\n\n__Default value:__ `0`",
"minimum": 0
},
"padAngle": {
"anyOf": [
Expand Down Expand Up @@ -16745,7 +16763,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "For arc mark, the primary (outer) radius in pixels.\n\nFor text marks, polar coordinate radial offset, in pixels, of the text from the origin determined by the `x` and `y` properties."
"description": "For arc mark, the primary (outer) radius in pixels.\n\nFor text marks, polar coordinate radial offset, in pixels, of the text from the origin determined by the `x` and `y` properties.\n\n__Default value:__ `min(plot_width, plot_height)/2`",
"minimum": 0
},
"radius2": {
"anyOf": [
Expand All @@ -16756,7 +16775,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The secondary (inner) radius in pixels of arc marks."
"description": "The secondary (inner) radius in pixels of arc marks.\n\n__Default value:__ `0`",
"minimum": 0
},
"radius2Offset": {
"anyOf": [
Expand Down Expand Up @@ -18021,7 +18041,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The inner radius in pixels of arc marks. `innerRadius` is an alias for `radius2`."
"description": "The inner radius in pixels of arc marks. `innerRadius` is an alias for `radius2`.\n\n__Default value:__ `0`",
"minimum": 0
},
"interpolate": {
"anyOf": [
Expand Down Expand Up @@ -18111,7 +18132,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The outer radius in pixels of arc marks. `outerRadius` is an alias for `radius`."
"description": "The outer radius in pixels of arc marks. `outerRadius` is an alias for `radius`.\n\n__Default value:__ `0`",
"minimum": 0
},
"padAngle": {
"anyOf": [
Expand All @@ -18133,7 +18155,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "For arc mark, the primary (outer) radius in pixels.\n\nFor text marks, polar coordinate radial offset, in pixels, of the text from the origin determined by the `x` and `y` properties."
"description": "For arc mark, the primary (outer) radius in pixels.\n\nFor text marks, polar coordinate radial offset, in pixels, of the text from the origin determined by the `x` and `y` properties.\n\n__Default value:__ `min(plot_width, plot_height)/2`",
"minimum": 0
},
"radius2": {
"anyOf": [
Expand All @@ -18144,7 +18167,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The secondary (inner) radius in pixels of arc marks."
"description": "The secondary (inner) radius in pixels of arc marks.\n\n__Default value:__ `0`",
"minimum": 0
},
"radius2Offset": {
"anyOf": [
Expand Down Expand Up @@ -20251,7 +20275,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The inner radius in pixels of arc marks. `innerRadius` is an alias for `radius2`."
"description": "The inner radius in pixels of arc marks. `innerRadius` is an alias for `radius2`.\n\n__Default value:__ `0`",
"minimum": 0
},
"interpolate": {
"anyOf": [
Expand Down Expand Up @@ -20341,7 +20366,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The outer radius in pixels of arc marks. `outerRadius` is an alias for `radius`."
"description": "The outer radius in pixels of arc marks. `outerRadius` is an alias for `radius`.\n\n__Default value:__ `0`",
"minimum": 0
},
"padAngle": {
"anyOf": [
Expand All @@ -20363,7 +20389,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "For arc mark, the primary (outer) radius in pixels.\n\nFor text marks, polar coordinate radial offset, in pixels, of the text from the origin determined by the `x` and `y` properties."
"description": "For arc mark, the primary (outer) radius in pixels.\n\nFor text marks, polar coordinate radial offset, in pixels, of the text from the origin determined by the `x` and `y` properties.\n\n__Default value:__ `min(plot_width, plot_height)/2`",
"minimum": 0
},
"radius2": {
"anyOf": [
Expand All @@ -20374,7 +20401,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The secondary (inner) radius in pixels of arc marks."
"description": "The secondary (inner) radius in pixels of arc marks.\n\n__Default value:__ `0`",
"minimum": 0
},
"shape": {
"anyOf": [
Expand Down Expand Up @@ -27330,7 +27358,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The inner radius in pixels of arc marks. `innerRadius` is an alias for `radius2`."
"description": "The inner radius in pixels of arc marks. `innerRadius` is an alias for `radius2`.\n\n__Default value:__ `0`",
"minimum": 0
},
"interpolate": {
"anyOf": [
Expand Down Expand Up @@ -27420,7 +27449,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The outer radius in pixels of arc marks. `outerRadius` is an alias for `radius`."
"description": "The outer radius in pixels of arc marks. `outerRadius` is an alias for `radius`.\n\n__Default value:__ `0`",
"minimum": 0
},
"padAngle": {
"anyOf": [
Expand All @@ -27442,7 +27472,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "For arc mark, the primary (outer) radius in pixels.\n\nFor text marks, polar coordinate radial offset, in pixels, of the text from the origin determined by the `x` and `y` properties."
"description": "For arc mark, the primary (outer) radius in pixels.\n\nFor text marks, polar coordinate radial offset, in pixels, of the text from the origin determined by the `x` and `y` properties.\n\n__Default value:__ `min(plot_width, plot_height)/2`",
"minimum": 0
},
"radius2": {
"anyOf": [
Expand All @@ -27453,7 +27484,8 @@
"$ref": "#/definitions/ExprRef"
}
],
"description": "The secondary (inner) radius in pixels of arc marks."
"description": "The secondary (inner) radius in pixels of arc marks.\n\n__Default value:__ `0`",
"minimum": 0
},
"shape": {
"anyOf": [
Expand Down
4 changes: 2 additions & 2 deletions site/_data/versions.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
vega: 5.20.2
vega: 5.21.0
vega-lite: 5.1.1
vega-embed: 6.18.2
vega-embed: 6.19.1
vega-tooltip: 0.27.0
9 changes: 4 additions & 5 deletions src/mark.ts
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,8 @@ export interface VLOnlyMarkConfig<ES extends ExprRef | SignalRef> extends ColorM
/**
* The secondary (inner) radius in pixels of arc marks.
*
* @minimum 0
* __Default value:__ `0`
* @minimum 0
*/
radius2?: number | ES; // In Vega, this is called innerRadius
}
Expand Down Expand Up @@ -261,25 +261,24 @@ export interface MarkConfig<ES extends ExprRef | SignalRef>
*
* For text marks, polar coordinate radial offset, in pixels, of the text from the origin determined by the `x` and `y` properties.
*
* @minimum 0
*
* __Default value:__ `min(plot_width, plot_height)/2`
* @minimum 0
*/
radius?: number | ES; // overriding VG

/**
* The inner radius in pixels of arc marks. `innerRadius` is an alias for `radius2`.
*
* @minimum 0
* __Default value:__ `0`
* @minimum 0
*/
innerRadius?: number | ES;

/**
* The outer radius in pixels of arc marks. `outerRadius` is an alias for `radius`.
*
* @minimum 0
* __Default value:__ `0`
* @minimum 0
*/
outerRadius?: number | ES;
}
Expand Down

0 comments on commit 134dc24

Please sign in to comment.