# RowTree

Auto-generated from the config schema in the source — see the [config guide](https://jbrowse.org/jb2/docs/config_guide) for concepts. Built into JBrowse core. [View source](https://github.com/GMOD/jbrowse-components/blob/main/packages/display-kit/src/rowTreeConfigSchema.ts).

`rows.tree`, the dendrogram beside the rows: its newick, and where a
clustering run computed it, the locus and settings it ran with. A string is
the newick. The provenance is keyed by the newick, as `rows.sort` is by
`rows.field`: a write of another newick, as a member or whole, emptying it
or filling it included, drops the provenance it does not state, so a
provenance only ever describes the tree beside it. A plot read gives the object whichever form was written.
Whether it draws is `rows.axis.tree`.

## Example usage

```js
{ type: 'LinearVariantDisplay', rows: { tree: '((HG002,HG003),HG004);' } }
```

## Config slots

A setting written to it names members one by one: a member left out stays as it is, and `null` resets one. One that changes `newick`, emptying or filling it included, first clears `provenance`, which name the old values, except those it states. Slot types (`fileLocation`, `frozen`, ...) are explained in the [config slot types reference](https://jbrowse.org/jb2/docs/config_guides/slot_types). Slots a base configuration contributes are listed here too, so this table is the whole surface.

| Slot | Description |
| --- | --- |
| **newick**<br>[`maybeString`](https://jbrowse.org/jb2/docs/config_guides/slot_types#the-maybe-types) | The tree as newick, its leaves the row names. Writing `rows.tree: "(a,b);"` sets this slot. |
| **provenance**<br>[`maybeFrozen`](https://jbrowse.org/jb2/docs/config_guides/slot_types#the-maybe-types) | The locus and settings a clustering run computed the tree from; unset for a tree that arrived as data, which rotates towards `rows.sort`. A write of another `newick` drops it unless it states one. |