BaseDisplay
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
Source file
packages/core/pluggableElementTypes/models/BaseDisplayModel.tsx
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; message: string; } & IStateTreeNode<IModelType<{ id: IOptionalIType<ISimpleType<string>, [...]>; type: ISimpleType<...>; rpcDriverName: IMaybe<...>; }, { ...; }, _NotCustomized, _NotC...
getter: DisplayBlurb
// type
any
getter: adapterConfig
// type
any
getter: parentTrack
// 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
// type signature
renderProps: () => any
method: trackMenuItems
// type signature
trackMenuItems: () => MenuItem[]
method: regionCannotBeRendered
// type signature
regionCannotBeRendered: () => any
BaseDisplay - Actions
action: setMessage
// type signature
setMessage: (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