Skip to main content

LinearBasicDisplay

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​

used by FeatureTrack, has simple settings like "show/hide feature labels", etc.

extends

LinearBasicDisplay - Properties​

property: type​

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

property: trackShowLabels​

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

property: trackShowDescriptions​

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

property: trackDisplayMode​

// type signature
IMaybe<ISimpleType<string>>
// code
trackDisplayMode: types.maybe(types.string)

property: trackMaxHeight​

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

property: trackSubfeatureLabels​

// type signature
IMaybe<ISimpleType<string>>
// code
trackSubfeatureLabels: types.maybe(types.string)

property: trackGeneGlyphMode​

// type signature
IMaybe<ISimpleType<string>>
// code
trackGeneGlyphMode: types.maybe(types.string)

property: configuration​

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

property: jexlFilters​

// type signature
IMaybe<IArrayType<ISimpleType<string>>>
// code
jexlFilters: types.maybe(types.array(types.string))

LinearBasicDisplay - Getters​

getter: activeFilters​

// type
any

getter: rendererTypeName​

// type
any

getter: showLabels​

// type
any

getter: showDescriptions​

// type
any

getter: maxHeight​

// type
any

getter: displayMode​

// type
any

getter: subfeatureLabels​

// type
any

getter: geneGlyphMode​

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

Override featureUnderMouse to return the volatile feature which is fetched asynchronously via CoreGetFeatureDetails

// type
Feature

LinearBasicDisplay - Methods​

method: renderProps​

// type signature
renderProps: () => { config: { [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<string, unknown> | ({ [x: string]: any; } & NonEmptyObject & ... & IStateTreeNode<...>); } & IStateTreeNode<...>; filters: SerializableFilterChain; sequenceAdapter: any; }

method: renderingProps​

// type signature
renderingProps: () => { onFeatureClick(_: unknown, featureId?: string): Promise<void>; onFeatureContextMenu(_: unknown, featureId?: string): Promise<void>; displayModel: { id: string; type: string; rpcDriverName: string; } & NonEmptyObject & { ...; } & IStateTreeNode<...>; }

method: trackMenuItems​

// type signature
trackMenuItems: () => MenuItem[]

LinearBasicDisplay - Actions​

action: setJexlFilters​

// type signature
setJexlFilters: (f?: string[]) => void

action: setFeatureUnderMouse​

// type signature
setFeatureUnderMouse: (feat?: Feature) => void

action: toggleShowLabels​

// type signature
toggleShowLabels: () => void

action: toggleShowDescriptions​

// type signature
toggleShowDescriptions: () => void

action: setSubfeatureLabels​

// type signature
setSubfeatureLabels: (val: string) => void

action: setDisplayMode​

// type signature
setDisplayMode: (val: string) => void

action: setMaxHeight​

// type signature
setMaxHeight: (val?: number) => void

action: setGeneGlyphMode​

// type signature
setGeneGlyphMode: (val: string) => void