Skip to main content

Interface: G3XNavDataBarProps

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/CnsDataBar/CnsDataBarFields/G3XNavDataBar.tsx:19

Component props for G3XNavDataBar.

Extends

  • ComponentProps

Properties

bus

bus: EventBus

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/CnsDataBar/CnsDataBarFields/G3XNavDataBar.tsx:21

The event bus.


children?

optional children: DisplayChildren[]

Defined in: src/sdk/components/FSComponent.ts:122

The children of the display component.

Inherited from

ComponentProps.children


class?

optional class: string | ToggleableClassNameRecord | SubscribableSet<string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/CnsDataBar/CnsDataBarFields/G3XNavDataBar.tsx:50

CSS class(es) to add to the data bar's root element.


dataBarSettingManager

dataBarSettingManager: UserSettingManager<NavDataBarSettingTypes>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/CnsDataBar/CnsDataBarFields/G3XNavDataBar.tsx:30

A user setting manager for the settings that control the data bar's field types.


fieldRenderer

fieldRenderer: NavDataFieldRenderer

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/CnsDataBar/CnsDataBarFields/G3XNavDataBar.tsx:27

A navigation data field renderer.


isEditingActive

isEditingActive: Subscribable<boolean>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/CnsDataBar/CnsDataBarFields/G3XNavDataBar.tsx:39

Whether data field editing is active. While editing is active, the fields are rendered and act as touchscreen buttons which the user can press.


modelFactory

modelFactory: NavDataBarFieldModelFactory

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/CnsDataBar/CnsDataBarFields/G3XNavDataBar.tsx:24

A navigation data bar field model factory.


onEditPressed()?

optional onEditPressed: (index) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/CnsDataBar/CnsDataBarFields/G3XNavDataBar.tsx:44

A callback function to execute when a data field is pressed during editing.

Parameters

ParameterType
indexnumber

Returns

void


ref?

optional ref: NodeReference<any>

Defined in: src/sdk/components/FSComponent.ts:125

A reference to the display component.

Inherited from

ComponentProps.ref


updateFreq

updateFreq: number

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/CnsDataBar/CnsDataBarFields/G3XNavDataBar.tsx:47

The update frequency of the data fields, in hertz.


visibleDataFieldCount

visibleDataFieldCount: Subscribable<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/CnsDataBar/CnsDataBarFields/G3XNavDataBar.tsx:33

The number of data fields that are visible.