Skip to main content

Type Alias: GarminChartDisplaySelection

GarminChartDisplaySelection = object

Defined in: src/garminsdk/components/charts/GarminChartDisplay.tsx:17

Data describing a chart selected to be displayed by a GarminChartDisplay.

Properties​

area​

area: ChartArea | null

Defined in: src/garminsdk/components/charts/GarminChartDisplay.tsx:28

The area of the chart page to display, or null to display the entire page.

geoReferencedArea​

geoReferencedArea: GeoReferencedChartArea | null

Defined in: src/garminsdk/components/charts/GarminChartDisplay.tsx:31

The geo-referenced area of the displayed chart, or null if geo-referencing data are not available.

page​

page: ChartPage

Defined in: src/garminsdk/components/charts/GarminChartDisplay.tsx:19

The chart page to display.

urls​

urls: Partial<Record<string, ChartUrl>>

Defined in: src/garminsdk/components/charts/GarminChartDisplay.tsx:25

A mapping from display modes to the chart URLs to use to render the chart page to display for each display mode. If a URL is not defined for the display's active display mode, then the chart will not be displayed.