Skip to main content

SvInspectorView

Note: this document is automatically generated from mobx-state-tree objects in our source code. See Core concepts and intro to pluggable elements for more info

Also note: this document represents the state model API for the current released version of jbrowse. If you are not using the current version, please cross reference the markdown files in our repo of the checked out git tag

Source code

GitHub page

Docs​

does not extend, but is a combination of a

extends

SvInspectorView - Properties​

property: id​

// type signature
IOptionalIType<ISimpleType<string>, [undefined]>
// code
id: ElementId

property: type​

// type signature
ISimpleType<"SvInspectorView">
// code
type: types.literal('SvInspectorView')

property: height​

// type signature
IOptionalIType<ISimpleType<number>, [undefined]>
// code
height: types.optional(types.number, defaultHeight)

property: onlyDisplayRelevantRegionsInCircularView​

// type signature
false
// code
onlyDisplayRelevantRegionsInCircularView: false

property: spreadsheetView​

// type signature
IOptionalIType<IModelType<{ id: IOptionalIType<ISimpleType<string>, [undefined]>; displayName: IMaybe<ISimpleType<string>>; minimized: IType<boolean, boolean, boolean>; } & { ...; }, { ...; } & ... 5 more ... & { ...; }, _NotCustomized, ModelSnapshotType<...> | { ...; }>, [...]>
// code
spreadsheetView: types.optional(SpreadsheetModel, () =>
          SpreadsheetModel.create({
            type: 'SpreadsheetView',
            hideVerticalResizeHandle: true,
          }),
        )

property: circularView​

// type signature
IOptionalIType<IModelType<{ id: IOptionalIType<ISimpleType<string>, [undefined]>; displayName: IMaybe<ISimpleType<string>>; minimized: IType<boolean, boolean, boolean>; } & { ...; }, { ...; } & ... 7 more ... & { ...; }, _NotCustomized, _NotCustomized>, [...]>
// code
circularView: types.optional(CircularModel, () =>
          CircularModel.create({
            type: 'CircularView',
            hideVerticalResizeHandle: true,
            hideTrackSelectorButton: true,
            disableImportForm: true,
          }),
        )

SvInspectorView - Getters​

getter: assemblyName​

// type
string

getter: showCircularView​

// type
boolean

getter: features​

// type
SimpleFeatureSerialized[]

getter: featuresAdapterConfigSnapshot​

// type
{
  type: string
  features: any
}

getter: featureRefNames​

// type
any[]

getter: canonicalFeatureRefNameSet​

// type
Set<unknown>

getter: featuresCircularTrackConfiguration​

// type
{ type: string; trackId: string; name: string; adapter: any; assemblyNames: any[]; displays: { type: string; displayId: string; onChordClick: string; renderer: { type: string; }; }[]; }

SvInspectorView - Methods​

method: menuItems​

// type signature
menuItems: () => { label: string; icon: OverridableComponent<SvgIconTypeMap<{}, "svg">> & { muiName: string; }; onClick: () => void; }[]

SvInspectorView - Actions​

action: setWidth​

// type signature
setWidth: (newWidth: number) => void

action: setHeight​

// type signature
setHeight: (newHeight: number) => number

action: setDisplayedRegions​

// type signature
setDisplayedRegions: (regions: Region[]) => void

action: setOnlyDisplayRelevantRegionsInCircularView​

// type signature
setOnlyDisplayRelevantRegionsInCircularView: (val: boolean) => void

action: resizeHeight​

// type signature
resizeHeight: (distance: number) => number