Skip to main content

Interface: LatLonDisplayProps

Component props for LatLonDisplay.

Hierarchy​

  • ComponentProps

    ↳ LatLonDisplayProps

Properties​

blankPrefixWhenNaN​

• Optional blankPrefixWhenNaN: boolean

Whether to format prefix text as an underscore when the coordinate value is equal to NaN. Defaults to false.

Defined in​

src/garminsdk/components/common/LatLonDisplay.tsx:34

children​

• Optional children: DisplayChildren[]

The children of the display component.

Inherited from​

ComponentProps.children

Defined in​

src/sdk/components/FSComponent.ts:122

class​

• Optional class: string | SubscribableSet<string>

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

Defined in​

src/garminsdk/components/common/LatLonDisplay.tsx:37

format​

• format: LatLonDisplayFormat | Subscribable<LatLonDisplayFormat>

The format to use to display the coordinates.

Defined in​

src/garminsdk/components/common/LatLonDisplay.tsx:28

ref​

• Optional ref: NodeReference<any>

A reference to the display component.

Inherited from​

ComponentProps.ref

Defined in​

src/sdk/components/FSComponent.ts:125

splitPrefix​

• Optional splitPrefix: boolean

Whether to split the prefix into a separate span element within the div.g-latlon-coord. Defaults to false.

Defined in​

src/garminsdk/components/common/LatLonDisplay.tsx:31

value​

• value: null | LatLonInterface | Subscribable<null | LatLonInterface>

The location for which to display coordinates.

Defined in​

src/garminsdk/components/common/LatLonDisplay.tsx:25