Class: DurationDisplay

Defined in: src/sdk/components/common/DurationDisplay.tsx:91

A component which displays duration values.

Extends

• DisplayComponent<DurationDisplayProps>

Constructors

Constructor

new DurationDisplay(props): DurationDisplay

Defined in: src/sdk/components/common/DurationDisplay.tsx:119

Parameters

Parameter	Type
props	DurationDisplayProps

Returns

DurationDisplay

Inherit Doc

Overrides

DisplayComponent.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.context

---

contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

---

props

props: DurationDisplayProps & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

---

DEFAULT_OPTIONS

readonly static DEFAULT_OPTIONS: Readonly<DurationDisplayOptions>

Defined in: src/sdk/components/common/DurationDisplay.tsx:93

Default formatting options.

Methods

destroy()

destroy(): void

Defined in: src/sdk/components/common/DurationDisplay.tsx:267

Destroys this component.

Returns

void

Overrides

DisplayComponent.destroy

---

getContext()

protected getContext(context): never

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

Gets a context data subscription from the context collection.

Parameters

Parameter	Type	Description
context	never	The context to get the subscription for.

Returns

never

The requested context.

Throws

An error if no data for the specified context type could be found.

Inherited from

DisplayComponent.getContext

---

onAfterRender()

onAfterRender(): void

Defined in: src/sdk/components/common/DurationDisplay.tsx:135

A callback that is called after the component is rendered.

Returns

void

Overrides

DisplayComponent.onAfterRender

---

onBeforeRender()

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

---

render()

render(): VNode

Defined in: src/sdk/components/common/DurationDisplay.tsx:260

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render