Skip to content

Commit

Permalink
add unsorted option on docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ogom committed Sep 13, 2024
1 parent 49d54ca commit f814733
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ These are used to set display properties for a specific dataset.
| [`label`](#general) | `string` | - | `undefined`
| [`labels`](#labels) | `object` | - |
| [`rtl`](#general) | `boolean` | - | `false`
| [`unsorted`](#general) | `boolean` | - | `false`
| [`spacing`](#styling) | `number` | - | `0.5`
| [`sumKeys`](#general) | `string[]` | - | `undefined` |
| [`tree`](#general) | `number[]` \| `object[]` \| `object` | - | **required**
Expand All @@ -97,6 +98,7 @@ All these values, if `undefined`, fallback to the scopes described in [option re
| `key` | Define the key name in data objects to use for value.
| `label` | The label for the dataset which appears in the legend and tooltips.
| `rtl` | If `true`, the treemap elements are rendering from right to left.
| `unsorted` | If `true`, treemap elements are rendered unsorted.
| `sumKeys` | Define multiple keys to add additional sums, on top of the `key` one, for scriptable options use.
| `tree` | Tree data should be provided in `tree` property of dataset. `data` is then automatically build.
| `treeLeafKey` | The name of the key where the object key of leaf node of tree object is stored. Used only when `tree` is an `object`, as hierarchical data.
Expand Down

0 comments on commit f814733

Please sign in to comment.