Skip to main content

LinearFeatureDisplay

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​

Base model for feature displays. Provides labels, descriptions, display modes, filters, etc. Does not include gene glyph functionality.

extends

LinearFeatureDisplay - Properties​

property: type​

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

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: configuration​

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

property: jexlFilters​

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

LinearFeatureDisplay - Getters​

getter: activeFilters​

// type
any

getter: rendererTypeName​

// type
any

getter: sequenceAdapter​

// type
any

getter: showLabels​

// type
any

getter: showDescriptions​

// type
any

getter: maxHeight​

// type
any

getter: displayMode​

// type
any

getter: rendererConfig​

// type
{
  showLabels: any
  showDescriptions: any
  displayMode: any
  maxHeight: any
}

getter: featureUnderMouse​

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

// type
any

LinearFeatureDisplay - Methods​

method: renderProps​

// type signature
renderProps: () => {
  config: {
    showLabels: any
    showDescriptions: any
    displayMode: any
    maxHeight: any
  }
  filters: any
  sequenceAdapter: any
}

method: renderingProps​

// type signature
renderingProps: () => { onFeatureClick(_: unknown, featureId?: string): Promise<void>; onFeatureContextMenu(_: unknown, featureId?: string): Promise<void>; displayModel: { [x: string]: any; ... 6 more ...; showTooltips: boolean; } & ... 17 more ... & IStateTreeNode<...>; onMouseMove(_: unknown, featureId?: string): void; onMouseLea...

method: trackMenuItems​

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

LinearFeatureDisplay - 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: setDisplayMode​

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

action: setMaxHeight​

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