Skip to main content

FeatureDensityMixin

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​

FeatureDensityMixin - Properties​

property: userBpPerPxLimit​

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

property: userByteSizeLimit​

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

FeatureDensityMixin - Getters​

getter: currentBytesRequested​

// type
number

getter: currentFeatureScreenDensity​

// type
number

getter: maxFeatureScreenDensity​

// type
any

getter: featureDensityStatsReady​

// type
boolean

getter: maxAllowableBytes​

// type
number

getter: regionTooLarge​

region is too large if:

  • stats are ready
  • region is greater than 20kb (don't warn when zoomed in less than that)
  • and bytes is greater than max allowed bytes or density greater than max density
// type
boolean

getter: regionTooLargeReason​

only shows a message of bytes requested is defined, the feature density based stats don't produce any helpful message besides to zoom in

// type
string

getter: statsReadyAndRegionNotTooLarge​

// type
boolean

FeatureDensityMixin - Methods​

method: regionCannotBeRenderedText​

// type signature
regionCannotBeRenderedText: (_region: Region) => "" | "Force load to see features"

method: regionCannotBeRendered​

// type signature
regionCannotBeRendered: (_region: Region) => Element

FeatureDensityMixin - Actions​

action: setCurrStatsBpPerPx​

// type signature
setCurrStatsBpPerPx: (n: number) => void

action: setFeatureDensityStatsLimit​

// type signature
setFeatureDensityStatsLimit: (stats?: FeatureDensityStats) => void

action: getFeatureDensityStats​

// type signature
getFeatureDensityStats: () => Promise<FeatureDensityStats>

action: setFeatureDensityStatsP​

// type signature
setFeatureDensityStatsP: (arg: any) => void

action: setFeatureDensityStats​

// type signature
setFeatureDensityStats: (featureDensityStats?: FeatureDensityStats) => void

action: clearFeatureDensityStats​

// type signature
clearFeatureDensityStats: () => void