Skip to main content

LinearVariantDisplay

Note: this document is automatically generated from @jbrowse/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​

Similar to feature display, but provides custom widget on feature click. Does not include gene glyph options since variants are not genes. extends

LinearVariantDisplay - Properties​

property: type​

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

property: configuration​

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

property: minorAlleleFrequencyFilterSetting​

Minor allele frequency filter threshold (0-0.5) When undefined, falls back to config value

// type signature
IMaybe<ISimpleType<number>>
// code
minorAlleleFrequencyFilterSetting: types.maybe(types.number)

LinearVariantDisplay - Getters​

getter: minorAlleleFrequencyFilter​

Gets the minor allele frequency filter threshold Falls back to config value if setting is not defined

// type
any

getter: featureWidgetType​

// type
{
  type: string
  id: string
}

getter: activeFilters​

Override to add MAF filter to active filters

// type
string[]

LinearVariantDisplay - Methods​

method: filterMenuItems​

// type signature
filterMenuItems: () => any[]

LinearVariantDisplay - Actions​

action: setMafFilter​

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