Skip to main content

LinearReadCloudDisplay

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​

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
AnyConfigurationSchemaType
// 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)

LinearReadCloudDisplay - Getters​

getter: colorBy​

// type
any

getter: filterBy​

// type
any

getter: featureHeightSetting​

// type
any

LinearReadCloudDisplay - Methods​

method: trackMenuItems​

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

method: renderSvg​

// type signature
renderSvg: (opts: { rasterizeLayers?: boolean; }) => Promise<React.ReactNode>

LinearReadCloudDisplay - Actions​

action: reload​

// 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: selectFeature​

// type signature
selectFeature: (chain: ReducedFeature[]) => void

action: setDrawCloud​

// type signature
setDrawCloud: (b: boolean) => void