Skip to main content

Interface: UiWaypointDisplayProps

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Waypoint/UiWaypointDisplay.tsx:14

Component props for UiWaypointDisplay.

Extends​

  • ComponentProps

Extended by​

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

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

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

hideRightInfo?​

optional hideRightInfo: boolean | Subscribable<boolean>

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

Whether to the hide the information displayed on the right side of the display. Defaults to false.

nullIdent?​

optional nullIdent: string | Subscribable<string>

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

The string to display in place of the ident when the displayed waypoint is null. Defaults to the empty string.

nullName?​

optional nullName: string | Subscribable<string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Waypoint/UiWaypointDisplay.tsx:22

The string to display in place of the name when the displayed waypoint is null. Defaults to the empty string.

ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

ComponentProps.ref

waypoint​

waypoint: null | FacilityWaypoint<Facility> | Subscribable<null | FacilityWaypoint<Facility>>

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

The waypoint to display.