LinearReadCloudDisplay
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
Links
Docs
it is not a block based track, hence not BaseLinearDisplay extends
LinearReadCloudDisplay - Properties
property: type
// type signature
ISimpleType<"LinearReadCloudDisplay">
// code
type: types.literal('LinearReadCloudDisplay')
property: configuration
// type signature
any
// code
configuration: ConfigurationReference(configSchema)
property: drawCloud
// type signature
false
// code
drawCloud: false
property: noSpacing
Whether to remove spacing between stacked features
// type signature
IMaybe<ISimpleType<boolean>>
// code
noSpacing: types.maybe(types.boolean)
property: trackMaxHeight
Maximum height for the layout (prevents infinite stacking)
// type signature
IMaybe<ISimpleType<number>>
// code
trackMaxHeight: types.maybe(types.number)
property: hideSmallIndelsSetting
// type signature
IMaybe<ISimpleType<boolean>>
// code
hideSmallIndelsSetting: types.maybe(types.boolean)
property: hideMismatchesSetting
// type signature
IMaybe<ISimpleType<boolean>>
// code
hideMismatchesSetting: types.maybe(types.boolean)
property: hideLargeIndelsSetting
// type signature
IMaybe<ISimpleType<boolean>>
// code
hideLargeIndelsSetting: types.maybe(types.boolean)
property: showLegend
// type signature
IMaybe<ISimpleType<boolean>>
// code
showLegend: types.maybe(types.boolean)
property: showYScalebar
// type signature
IOptionalIType<ISimpleType<boolean>, [undefined]>
// code
showYScalebar: types.optional(types.boolean, true)
property: showOutline
// type signature
IOptionalIType<ISimpleType<boolean>, [undefined]>
// code
showOutline: types.optional(types.boolean, true)
LinearReadCloudDisplay - Getters
getter: colorBy
Get the color settings (from override or configuration)
// type
any
getter: filterBy
Get the filter settings (from override or configuration)
// type
any
getter: featureHeightSetting
// type
any
getter: hideSmallIndels
// type
any
getter: hideMismatches
// type
any
getter: hideLargeIndels
// type
any
getter: modificationThreshold
// type
any
getter: cloudDomain
Domain for cloud mode scale: [1, maxDistance] Uses 1 as lower bound since it's a log scale
// type
;[number, number]
getter: cloudTicks
Calculate ticks for the y-axis scalebar in cloud mode
// type
CloudTicks
LinearReadCloudDisplay - Methods
method: legendItems
Returns legend items based on current colorBy setting
// type signature
legendItems: () => LegendItem[]
method: svgLegendWidth
Returns the width needed for the SVG legend if showLegend is enabled. Used by SVG export to add extra width for the legend area.
// type signature
svgLegendWidth: () => number
method: renderProps
// type signature
renderProps: () => any
method: trackMenuItems
// type signature
trackMenuItems: () => any[]
method: renderSvg
// type signature
renderSvg: (opts: ExportSvgDisplayOptions) => Promise<React.ReactNode>
LinearReadCloudDisplay - Actions
action: reload
Reload the display (clears error state)
// type signature
reload: () => void
action: setNoSpacing
Set whether to remove spacing between features
// type signature
setNoSpacing: (flag?: boolean) => void
action: setMaxHeight
Set the maximum height for the layout
// type signature
setMaxHeight: (n?: number) => void
action: setLayoutHeight
Set the current layout height
// type signature
setLayoutHeight: (n: number) => void
action: setCloudMaxDistance
Set the max distance for cloud mode scale Only updates if value differs by more than EPSILON to avoid infinite re-renders
// type signature
setCloudMaxDistance: (maxDistance: number) => void
action: setShowYScalebar
// type signature
setShowYScalebar: (show: boolean) => void
action: setShowOutline
// type signature
setShowOutline: (show: boolean) => void
action: selectFeature
// type signature
selectFeature: (chain: ReducedFeature[]) => void
action: setDrawCloud
// type signature
setDrawCloud: (b: boolean) => void
action: setSelectedFeatureId
Set the ID of the selected feature for persistent highlighting
// type signature
setSelectedFeatureId: (id: string) => void
action: setHideSmallIndels
// type signature
setHideSmallIndels: (arg: boolean) => void
action: setHideMismatches
// type signature
setHideMismatches: (arg: boolean) => void
action: setHideLargeIndels
// type signature
setHideLargeIndels: (arg: boolean) => void
action: setShowLegend
// type signature
setShowLegend: (s: boolean) => void