Skip to main content

Interface: G3XMapRangeSettingDisplayProps

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XMapRangeSettingDisplay.tsx:11

Component props for G3XMapRangeSettingDisplay.

Extends​

Properties​

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 | SubscribableSet<string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XMapRangeSettingDisplay.tsx:28

CSS class(es) to apply to the display's root element.

displayUnit​

displayUnit: null | Unit<Distance> | Subscribable<null | Unit<Distance>>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XMapRangeSettingDisplay.tsx:19

The displayed unit type.

rangeArray​

rangeArray: Subscribable<readonly NumberUnitInterface<Distance, Unit<Distance>>[]>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XMapRangeSettingDisplay.tsx:16

The map range array.

rangeIndex​

rangeIndex: number | Subscribable<number>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XMapRangeSettingDisplay.tsx:13

The index of the displayed range.

ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

ComponentProps.ref

useBasicUnitFormat?​

optional useBasicUnitFormat: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XMapRangeSettingDisplay.tsx:25

Whether to use basic unit text formatting instead of G3X-style unit text formatting. Ignored if unitFormatter is defined. Defaults to false.