Skip to content

Commit

Permalink
Merge pull request #475 from Kitware/upset-docs
Browse files Browse the repository at this point in the history
Update upset.rst to reflect actual options
  • Loading branch information
jeffbaumes committed Feb 13, 2017
2 parents 2339d4b + fb35b63 commit 9b4a891
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions docs/components/upset.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,18 @@ Options
data (:ref:`Table <table>`)
The data table.

fields (Array of String)
A list of fields that will be shown on the LineUp view. The list determines
the order of the fields. If not supplied, all fields from the data are
shown.
id (String)
A field containing a unique identifier for each record.

stacked (Boolean)
Whether to display grouped measures as a stacked bar (default false).
fields (Array of String)
A list of fields that will be shown on the UpSet view. Each value in each field
will be converted to a set membership 0/1 field before being passed to UpSet.

histograms (Boolean)
Whether to display histograms in the headers of each measure (default true).
sets (Array of String)
A list of fields that will be shown on the UpSet view. Each field is assumed to
already be a 0/1 set membership field.

animation (Boolean)
Whether to animate transitions when the scoring metric changes (default
true).
metadata (Array of String)
A list of fields that will be shown as metadata when drilling down to individual
records. Numeric data will also be shown in summary box plots to the right of
each set.

0 comments on commit 9b4a891

Please sign in to comment.