Skip to main content

Interface: CasDisplay2Props

Defined in: src/garminsdk/components/cas/CasDisplay2.tsx:48

Component props for CasDisplay2.

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

Defined in: src/garminsdk/components/cas/CasDisplay2.tsx:65

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

disableAutoScrollToNewMessage?​

optional disableAutoScrollToNewMessage: boolean

Defined in: src/garminsdk/components/cas/CasDisplay2.tsx:62

Whether to disable automatic scrolling to new unacknowledged warning and caution messages. Defaults to false.

maxMessageCount​

maxMessageCount: number | Subscribable<number>

Defined in: src/garminsdk/components/cas/CasDisplay2.tsx:53

The maximum number of messages that can be displayed simultaneously.

maxUnscrollableWarningCount?​

optional maxUnscrollableWarningCount: number | Subscribable<number>

Defined in: src/garminsdk/components/cas/CasDisplay2.tsx:56

The maximum number of warning messages that are always displayed and cannot be scrolled. Defaults to 0.

messages​

messages: SubscribableArray<CasActiveMessage>

Defined in: src/garminsdk/components/cas/CasDisplay2.tsx:50

The messages to display.

ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

ComponentProps.ref

scrollState?​

optional scrollState: MutableSubscribable<any, Readonly<CasDisplay2ScrollState>>

Defined in: src/garminsdk/components/cas/CasDisplay2.tsx:59

A mutable subscribable to which to write the scroll state of the display.