# variants

Auto-generated from exported functions tagged `#api` in the source. See
[imports and re-exports](https://jbrowse.org/jb2/docs/developer_guides/imports_and_reexports) for how to
import these from a plugin.

## variantTables

A region of a multi-sample VCF as the multi-sample variant display fetches,
filters and paints it, as tables: `variants`, each record the display
keeps, with its lane color; `cells`, each sample's (or under
`unit: 'haplotype'` each haplotype's) cell at each record, with its
genotype, its `dosage` and the fill the display paints it; `rows`, the
rows the cells name; and `legend` and
`ramps`, the key the display shows. Under `referenceDrawingMode: 'skip'`, the default,
a reference call draws no cell. For a host that draws them itself, such as
R through V8. The adapters must be registered on `pluginManager`
(`registerVariantAdapters`).

```js
// type signature
(pluginManager: PluginManager, { adapterConfig, region, display, byteLimit, }: VariantTablesArgs) => Promise<…>
```

[Source code](https://github.com/GMOD/jbrowse-components/blob/main/plugins/variants/src/tables.ts)