Skip to main content

LinearComparativeDisplay

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​

plugins/linear-comparative-view/src/LinearComparativeDisplay/stateModelFactory.ts

extends

LinearComparativeDisplay - Properties​

property: type​

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

property: configuration​

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

property: height​

// type signature
number
// code
height: 100

LinearComparativeDisplay - Getters​

getter: renderProps​

// type
() => { rpcDriverName: string; displayModel: { id: string; type: "LinearComparativeDisplay"; rpcDriverName: string; configuration: { [x: string]: any; } & NonEmptyObject & { ...; } & IStateTreeNode<...>; height: number; } & ... 5 more ... & IStateTreeNode<...>; highResolutionScaling: number; }

LinearComparativeDisplay - Actions​

action: setLoading​

controlled by a reaction

// type signature
setLoading: (abortController: AbortController) => void

action: setMessage​

controlled by a reaction

// type signature
setMessage: (messageText: string) => void

action: setRendered​

controlled by a reaction

// type signature
setRendered: (args?: { features: Feature[]; }) => void

action: setError​

controlled by a reaction

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