Skip to main content

BaseFeatureWidget

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/BaseFeatureWidget/stateModelFactory.ts

displays data about features, allowing configuration callbacks to modify the contents of what is displayed

see: formatDetails->feature,formatDetails->subfeatures

BaseFeatureWidget - Properties​

property: id​

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

property: type​

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

property: featureData​

// type signature
IType<any, any, any>
// code
featureData: types.frozen()

property: formattedFields​

// type signature
IType<any, any, any>
// code
formattedFields: types.frozen()

property: unformattedFeatureData​

// type signature
IType<any, any, any>
// code
unformattedFeatureData: types.frozen()

property: view​

// type signature
IMaybe<IReferenceType<IAnyType>>
// code
view: types.safeReference(
        pluginManager.pluggableMstType('view', 'stateModel'),
      )

property: track​

// type signature
IMaybe<IReferenceType<IAnyType>>
// code
track: types.safeReference(
        pluginManager.pluggableMstType('track', 'stateModel'),
      )

property: trackId​

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

property: trackType​

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

property: maxDepth​

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

BaseFeatureWidget - Actions​

action: setFeatureData​

// type signature
setFeatureData: (featureData: Record<string, unknown>) => void

action: clearFeatureData​

// type signature
clearFeatureData: () => void

action: setFormattedData​

// type signature
setFormattedData: (feat: Record<string, unknown>) => void

action: setExtra​

// type signature
setExtra: (type?: string, trackId?: string, maxDepth?: number) => void

action: setError​

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