# SvInspectorView
Auto-generated from the @jbrowse/mobx-state-tree model in the source — see the [developer guide](https://jbrowse.org/jb2/docs/developer_guide/) for concepts. Provided by the `sv-inspector` plugin. [View source](https://github.com/GMOD/jbrowse-components/blob/main/plugins/sv-inspector/src/SvInspectorView/model.ts).
## Example usage
```js
{
type: 'SvInspectorView',
assembly: 'hg38',
uri: 'https://example.com/sv.vcf.gz',
fileType: 'VCF',
}
```
Shows a file of structural variants as a table beside a circular view that
draws them as chords. The model holds a
[SpreadsheetView](../spreadsheetview) and a
[CircularView](../circularview) side by side, without extending either.
Each section ends with the members a composed model contributes, linked to the page that documents them.
## Properties
| Member | Description |
| --- | --- |
| **id**
id: ElementId | |
| **type**
type: types.literal('SvInspectorView') | |
| **height**
height: types.stripDefault(types.number, defaultHeight) | height of the whole view in pixels |
| **onlyDisplayRelevantRegionsInCircularView**
onlyDisplayRelevantRegionsInCircularView: types.stripDefault( types.boolean, false, ) | draw only the chromosomes the visible rows touch |
| **spreadsheetWidthFraction**
spreadsheetWidthFraction: types.stripDefault(types.number, 0.66) | share of the view's width given to the spreadsheet |
| **spreadsheetView**
spreadsheetView: types.optional(SpreadsheetModel, () => SpreadsheetModel.create({ type: 'SpreadsheetView', hideVerticalResizeHandle: true, }), ) | |
| **circularView**
circularView: types.optional(CircularModel, () => CircularModel.create({ type: 'CircularView', hideVerticalResizeHandle: true, disableImportForm: true, }), ) | |
| **launch**
launch: types.frozen< LaunchInput<SvInspectorViewCommands> | undefined >() | transient launch keys, forwarded to the sheet on attach and cleared; author them directly on the view |
2 inherited properties from one model:
From [BaseViewModel](../baseviewmodel): [`displayName`](../baseviewmodel#property-displayname), [`minimized`](../baseviewmodel#property-minimized)
## Volatiles
| Member | Description |
| --- | --- |
| **SpreadsheetViewReactComponent**
ViewComponentType | |
| **CircularViewReactComponent**
ViewComponentType | |
2 inherited volatiles from one model:
From [BaseViewModel](../baseviewmodel): [`width`](../baseviewmodel#volatile-width), [`bodyMounted`](../baseviewmodel#volatile-bodymounted)
## Getters
| Member | Description |
| --- | --- |
| **pendingLaunch**
LaunchInput<SvInspectorViewCommands & { unknown?: Record<string, unknown> | undefined; malformed?: Record<string, unknown> | undefined; legacyInit?: boolean | undefined; } & IStateTreeNode<IType<LaunchInput<SvInspectorViewCommands> | undefined, LaunchInput<SvInspectorViewCommands> | undefined, LaunchInput<SvInspectorViewCommands> | undefined>>> | undefined | |
| **currentAssembly**
(ModelInstanceTypeProps<…> & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & { getCanonicalRefName2(refName: string): string; isValidRefName(refName: string): boolean; } & { isCircularRefName(refName: string): boolean; getRefNamePosition(refName: string): number | undefined; getAliasesForRefName(refName: string): string[]; getRefNameMapForAdapter(adapterConf: AdapterConf, options: BaseOptions): Promise<…>; getRefNameMismatch(adapterCacheKey: string): RefNameMismatch | undefined; } & IStateTreeNode<…>) | undefined | |
| **assemblyName**
string | undefined | |
| **showCircularView**
boolean | false while the sheet shows its import form |
| **showLoading**
boolean | both halves' loading state; the circle counts only while shown |
| **ownViews**
((ModelInstanceTypeProps<…> & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & IStateTreeNode<…>) | (ModelInstanceTypeProps<…> & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & {…} & { afterCreate(): void; beforeDestroy(): void; afterAttach(): void; } & { tracksMenuItem(): MenuItem; } & { readonly legendSpec: LegendSpec; legendSpecIn(palette?: JBrowsePalette | undefined): LegendSpec; menuItems(): MenuItem[]; } & IStateTreeNode<…>))[] | an unshown circle never initializes, so it would read as loading forever |
| **features**
SimpleFeatureSerialized[] | the records of the rows the sheet's filters leave |
| **allFeatures**
SimpleFeatureSerialized[] | every record of the sheet, which the chord track holds; filters narrow it through visibleChordIds rather than rebuilding the track |
| **visibleChordIds**
string[] | undefined | undefined while no filter narrows the sheet |
| **canonicalFeatureRefNameSet**
Set<string> | every canonical refName the visible features' chords land on, both ends included |
| **circularDisplayedRegions**
BasicRegion[] | undefined | never narrowed to nothing, which would draw an empty circle |
| **effectiveSpreadsheetWidthFraction**
number | |
| **subviewWidths**
{ spreadsheet: number; circular: number; } | |
| **highlightedChordIds**
string[] | undefined | the records of the selected record's event, which the circle keeps at full strength while it dims the rest |
| **variantTrackId**
string | |
| **featuresCircularTrackConfiguration**
{ type: string; trackId: string; name: string; adapter: { type: string; features: SimpleFeatureSerialized[]; }; assemblyNames: string[]; displays: { type: string; displayId: string; onChordClick: string; color: { field: string; }; opacity: number; }[]; } | undefined | |
3 inherited getters from one model:
From [BaseViewModel](../baseviewmodel): [`rendersDisplays`](../baseviewmodel#getter-rendersdisplays), [`effectiveBodyMounted`](../baseviewmodel#getter-effectivebodymounted), [`ownTracks`](../baseviewmodel#getter-owntracks)
## Methods
| Member | Description |
| --- | --- |
| **menuItems**
() => { label: string; icon: OverridableComponent<SvgIconTypeMap<{}, "svg">> & { muiName: string; }; onClick: () => void; }[] | |
## Actions
| Member | Description |
| --- | --- |
| **setHeight**
(newHeight: number) => number | |
| **setOnlyDisplayRelevantRegionsInCircularView**
(val: boolean) => void | |
| **resizeSpreadsheetWidth**
(distance: number) => void | accumulates onto the fraction, not the rounded spreadsheetView.width, so the divider doesn't creep a pixel per drag frame |
| **setLaunch**
(launch?: LaunchInput<SvInspectorViewCommands> | undefined) => void | |
| **resizeHeight**
(distance: number) => number | |
4 inherited actions from one model:
From [BaseViewModel](../baseviewmodel): [`setDisplayName`](../baseviewmodel#action-setdisplayname), [`setWidth`](../baseviewmodel#action-setwidth), [`setBodyMounted`](../baseviewmodel#action-setbodymounted), [`setMinimized`](../baseviewmodel#action-setminimized)