Skip to main content

LinearPileupDisplay

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

LinearPileupDisplay - Properties​

property: type​

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

property: configuration​

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

property: showSoftClipping​

// type signature
false
// code
showSoftClipping: false

property: mismatchAlpha​

// type signature
IMaybe<ISimpleType<boolean>>
// code
mismatchAlpha: types.maybe(types.boolean)

property: sortedBy​

// type signature
IType<SortedBy, SortedBy, SortedBy>
// code
sortedBy: types.frozen<SortedBy | undefined>()

LinearPileupDisplay - Getters​

getter: visibleModificationTypes​

// type
any[]

getter: rendererConfig​

// type
{ [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<string, unknown> | ({ [x: string]: any; } & NonEmptyObject & ... & IStateTreeNode<...>); } & IStateTreeNode<...>

getter: mismatchAlphaSetting​

// type
any

LinearPileupDisplay - Methods​

method: renderReady​

// type signature
renderReady: () => boolean

method: renderPropsPre​

// type signature
renderPropsPre: () => any

method: renderProps​

// type signature
renderProps: () => any

method: trackMenuItems​

// type signature
trackMenuItems: () => readonly [...MenuItem[], { readonly label: "Sort by..."; readonly icon: OverridableComponent<SvgIconTypeMap<{}, "svg">> & { muiName: string; }; readonly disabled: boolean; readonly subMenu: readonly [......[]]; }, { ...; }, { ...; }, { ...; }, { ...; }]

LinearPileupDisplay - Actions​

action: setCurrSortBpPerPx​

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

action: updateVisibleModifications​

// type signature
updateVisibleModifications: (uniqueModifications: ModificationType[]) => void

action: setModificationsReady​

// type signature
setModificationsReady: (flag: boolean) => void

action: setSortReady​

// type signature
setSortReady: (flag: boolean) => void

action: clearSelected​

// type signature
clearSelected: () => void

action: toggleSoftClipping​

// type signature
toggleSoftClipping: () => void

action: toggleMismatchAlpha​

// type signature
toggleMismatchAlpha: () => void

action: setSortedBy​

// type signature
setSortedBy: (type: string, tag?: string) => void

action: setFeatureHeight​

overrides base from SharedLinearPileupDisplay to make sortReady false since changing feature height destroys the sort-induced layout

// type signature
setFeatureHeight: (n?: number) => void

action: reload​

// type signature
reload: () => void