Skip to content

Commit

Permalink
docs: correct documentation of domain union with (#7027)
Browse files Browse the repository at this point in the history
  • Loading branch information
domoritz authored Nov 5, 2020
1 parent 8dd5bec commit d6c1157
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 12 deletions.
2 changes: 1 addition & 1 deletion build/vega-lite-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -8117,7 +8117,7 @@
"type": "array"
}
],
"description": "Customized domain values to be union with the field's values.\n\n1) `domain` for _quantitative_ fields can take one of the following forms:\n\n- a two-element array with minimum and maximum values. - an array with more than two entries, for [Piecewise quantitative scales](https://vega.github.io/vega-lite/docs/scale.html#piecewise). (Alternatively, the `domainMid` property can be set for a diverging scale.) - a string value `\"unaggregated\"`, if the input field is aggregated, to indicate that the domain should include the raw data values prior to the aggregation.\n\n2) `domain` for _temporal_ fields can be a two-element array minimum and maximum values, in the form of either timestamps or the [DateTime definition objects](https://vega.github.io/vega-lite/docs/types.html#datetime).\n\n3) `domain` for _ordinal_ and _nominal_ fields can be an array that lists valid input values."
"description": "Customized domain values to be union with the field's values or explicitly defined domain. Should be an array of valid scale domain values."
}
},
"required": [
Expand Down
13 changes: 2 additions & 11 deletions src/scale.ts
Original file line number Diff line number Diff line change
Expand Up @@ -429,17 +429,8 @@ export function isSelectionDomain(domain: Domain): domain is SelectionExtent {

export interface DomainUnionWith {
/**
* Customized domain values to be union with the field's values.
*
* 1) `domain` for _quantitative_ fields can take one of the following forms:
*
* - a two-element array with minimum and maximum values.
* - an array with more than two entries, for [Piecewise quantitative scales](https://vega.github.io/vega-lite/docs/scale.html#piecewise). (Alternatively, the `domainMid` property can be set for a diverging scale.)
* - a string value `"unaggregated"`, if the input field is aggregated, to indicate that the domain should include the raw data values prior to the aggregation.
*
* 2) `domain` for _temporal_ fields can be a two-element array minimum and maximum values, in the form of either timestamps or the [DateTime definition objects](https://vega.github.io/vega-lite/docs/types.html#datetime).
*
* 3) `domain` for _ordinal_ and _nominal_ fields can be an array that lists valid input values.
* Customized domain values to be union with the field's values or explicitly defined domain.
* Should be an array of valid scale domain values.
*/
unionWith: number[] | string[] | boolean[] | DateTime[];
}
Expand Down

0 comments on commit d6c1157

Please sign in to comment.