Skip to main content

BaseDisplay

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​

BaseDisplay - Properties​

property: id​

// type signature
IOptionalIType<ISimpleType<string>, [undefined]>
// code
id: ElementId

property: type​

// type signature
ISimpleType<string>
// code
type: types.string

property: rpcDriverName​

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

BaseDisplay - Getters​

getter: RenderingComponent​

// type
React.FC<{ model: { id: string; type: string; rpcDriverName: string; } & NonEmptyObject & { rendererTypeName: string; error: unknown; statusMessage: string; } & IStateTreeNode<IModelType<{ id: IOptionalIType<ISimpleType<string>, [...]>; type: ISimpleType<...>; rpcDriverName: IMaybe<...>; }, { ...; }, _NotCustomized,...

getter: DisplayBlurb​

// type
any

getter: adapterConfig​

// type
any

getter: parentTrack​

// type
AbstractTrackModel

getter: parentDisplay​

Returns the parent display if this display is nested within another display (e.g., PileupDisplay inside LinearAlignmentsDisplay)

// type
any

getter: effectiveRpcDriverName​

Returns the effective RPC driver name with hierarchical fallback:

  1. This display's explicit rpcDriverName
  2. Parent display's effectiveRpcDriverName (for nested displays)
  3. Track config's rpcDriverName
// type
any

getter: rendererType​

the pluggable element type object for this display's renderer

// type
RendererType

getter: DisplayMessageComponent​

if a display-level message should be displayed instead, make this return a react component

// type
any

getter: viewMenuActions​

// type
MenuItem[]

BaseDisplay - Methods​

method: renderProps​

the react props that are passed to the Renderer when data is rendered in this display. these are serialized and sent to the worker for server-side rendering

// type signature
renderProps: () => any

method: renderingProps​

props passed to the renderer's React "Rendering" component. these are client-side only and never sent to the worker. includes displayModel and callbacks

// type signature
renderingProps: () => { displayModel: { id: string; type: string; rpcDriverName: string; } & NonEmptyObject & { rendererTypeName: string; error: unknown; statusMessage: string; } & { readonly RenderingComponent: React.FC<...>; ... 4 more ...; readonly effectiveRpcDriverName: any; } & IStateTreeNode<...>; }

method: trackMenuItems​

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

method: regionCannotBeRendered​

// type signature
regionCannotBeRendered: () => any

BaseDisplay - Actions​

action: setStatusMessage​

// type signature
setStatusMessage: (arg?: string) => void

action: setError​

// type signature
setError: (error?: unknown) => void

action: setRpcDriverName​

// type signature
setRpcDriverName: (rpcDriverName: string) => void

action: reload​

base display reload does nothing, see specialized displays for details

// type signature
reload: () => void