Skip to main content

MultiVariantBaseModel

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​

extends

MultiVariantBaseModel - Properties​

property: type​

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

property: layout​

// type signature
IOptionalIType<IType<Source[], Source[], Source[]>, [undefined]>
// code
layout: types.optional(types.frozen<Source[]>(), [])

property: configuration​

// type signature
AnyConfigurationSchemaType
// code
configuration: ConfigurationReference(configSchema)

property: minorAlleleFrequencyFilter​

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

property: showSidebarLabelsSetting​

// type signature
true
// code
showSidebarLabelsSetting: true

property: renderingMode​

// type signature
IOptionalIType<ISimpleType<string>, [undefined]>
// code
renderingMode: types.optional(types.string, 'alleleCount')

property: rowHeightSetting​

used only if autoHeight is false

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

property: autoHeight​

used only if autoHeight is false

// type signature
true
// code
autoHeight: true

MultiVariantBaseModel - Getters​

getter: preSources​

// type
Source[]

getter: sources​

// type
any[]

getter: rowHeight​

// type
number

getter: totalHeight​

// type
number

MultiVariantBaseModel - Methods​

method: adapterProps​

// type signature
adapterProps: () => any

method: trackMenuItems​

// type signature
trackMenuItems: () => (MenuDivider | MenuSubHeader | NormalMenuItem | CheckboxMenuItem | RadioMenuItem | SubMenuItem | { ...; } | { ...; } | { ...; } | { ...; })[]

MultiVariantBaseModel - Actions​

action: setRowHeight​

// type signature
setRowHeight: (arg: number) => void

action: setHoveredGenotype​

// type signature
setHoveredGenotype: (arg: string) => void

action: setFeatures​

// type signature
setFeatures: (f: Feature[]) => void

action: setLayout​

// type signature
setLayout: (layout: Source[]) => void

action: clearLayout​

// type signature
clearLayout: () => void

action: setSourcesLoading​

// type signature
setSourcesLoading: (str: string) => void

action: setSources​

// type signature
setSources: (sources: Source[]) => void

action: setMafFilter​

// type signature
setMafFilter: (arg: number) => void

action: setShowSidebarLabels​

// type signature
setShowSidebarLabels: (arg: boolean) => void

action: setPhasedMode​

// type signature
setPhasedMode: (arg: string) => void

action: setAutoHeight​

// type signature
setAutoHeight: (arg: boolean) => void

action: setHasPhased​

// type signature
setHasPhased: (arg: boolean) => void

action: setSampleInfo​

// type signature
setSampleInfo: (arg: Record<string, SampleInfo>) => void