Skip to main content

Interface: GarminChartDisplayProps

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

Component props for GarminChartDisplay.

Extends​

Properties​

chartStatus?​

optional chartStatus: MutableSubscribable<any, GarminChartDisplayChartStatus>

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

A mutable subscribable to which to write the current status of the chart selected for display.

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/garminsdk/components/charts/GarminChartDisplay.tsx:94

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

createChartImageSupplier()?​

optional createChartImageSupplier: () => ChartImageSupplier

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

A function that creates a new chart image supplier for the display to use. If not defined, then the display will create an instance of ChartView by default.

Returns​

ChartImageSupplier

A new chart image supplier for the display to use.

disableChartCompositingLayer?​

optional disableChartCompositingLayer: boolean

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

Whether to disable the creation of a Coherent compositing layer for the image element that renders the chart. Defaults to false.

displayMode​

displayMode: Subscribable<string>

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

The display mode to use. The display mode affects the URL used to the display the selected chart.

maxZoomLevel?​

optional maxZoomLevel: number | Subscribable<number>

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

The maximum zoom level allowed by the display. A zoom level of zero scales the displayed chart such that the displayed width of the chart equals the width of the display. Every unit increase in zoom level increases the scaling applied to the displayed chart by a factor of 2. Defaults to 3.

panOverscroll?​

optional panOverscroll: Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">>>

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

The amount by which a chart is allowed to be temporarily panned past the normal panning boundaries, as [left, top, right, bottom] in pixels. Defaults to [0, 0, 0, 0].

ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

ComponentProps.ref

selectedChart​

selectedChart: Subscribable<null | Readonly<GarminChartDisplaySelection>>

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

The selected chart to display, or null to not display any chart.

size​

size: Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">>>

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

The size of the display, as [width, height] in pixels.