Skip to content

Commit 326f25d

Browse files
committed
Update README
1 parent c01a328 commit 326f25d

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -573,14 +573,14 @@ The following top-level facet constant options are also supported:
573573
* facet.**grid** - if true, draw grid lines for each facet
574574
* facet.**label** - if null, disable default facet axis labels
575575

576-
When top-level faceting is used, faceting can be explicitly enabled or disabled on a mark with the *mark*.**facet** option, which accepts the following values:
576+
Faceting can be explicitly enabled or disabled on a mark with the *mark*.**facet** option, which accepts the following values:
577577

578-
* *auto* (default) - equivalent to *include* when mark data is strictly equal to facet data; else null
578+
* *auto* (default) - automatically determine if this mark should be faceted
579579
* *include* (or true) - draw the subset of the mark’s data in the current facet
580580
* *exclude* - draw the subset of the mark’s data *not* in the current facet
581581
* null (or false) - repeat this mark’s data across all facets (i.e., no faceting)
582582

583-
When the *include* or *exclude* facet mode is chosen, the mark data must be parallel to the facet data: the mark data must have the same length and order as the facet data. If the data are not parallel, then the wrong data may be shown in each facet. The default *auto* therefore requires strict equality (`===`) for safety, and using the facet data as mark data is recommended when using the *exclude* facet mode. (To construct parallel data safely, consider using [*array*.map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map) on the facet data.)
583+
When top-level faceting is used, the default *auto* setting is equivalent to *include* when mark data is strictly equal to facet data; otherwise it is equivalent to null. When the *include* or *exclude* facet mode is chosen, the mark data must be parallel to the top-level facet data: the mark data must have the same length and order as the top-level facet data. If the data are not parallel, then the wrong data may be shown in each facet. The default *auto* therefore requires strict equality (`===`) for safety, and using the facet data as mark data is recommended when using the *exclude* facet mode. (To construct parallel data safely, consider using [*array*.map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map) on the facet data.)
584584

585585
When mark-level faceting is used, the default *auto* setting is equivalent to *include*: the mark will be faceted if a *mark*.**fx** or *mark*.**fy** channel (or both) is specified. The null or false option will disable faceting, while *exclude* draws the subset of the mark’s data *not* in the current facet.
586586

0 commit comments

Comments
 (0)