Class: DisplayField<T>

An FmcComponent for displaying values according to formats

Type parameters

Name
T

Hierarchy

• FmcComponent<DisplayFieldOptions<T>>

  ↳ DisplayField

  ↳↳ EditableField

  ↳↳ PageLinkField

Constructors

constructor

• new DisplayField<T>(page, options): DisplayField<T>

Type parameters

Name
T

Parameters

Name	Type
page	AbstractFmcPage<any>
options	DisplayFieldOptions<T>

Returns

DisplayField<T>

Inherit Doc

Overrides

FmcComponent.constructor

Defined in

src/sdk/fmc/components/DisplayField.ts:41

Properties

isDisabled

• isDisabled: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Inherited from

FmcComponent.isDisabled

Defined in

src/sdk/fmc/components/FmcComponent.ts:57

---

options

• Protected options: DisplayFieldOptions<T>

Inherited from

FmcComponent.options

Defined in

src/sdk/fmc/components/DisplayField.ts:41

---

page

• Protected Readonly page: AbstractFmcPage<any>

Inherited from

FmcComponent.page

Defined in

src/sdk/fmc/components/FmcComponent.ts:61

---

value

• Protected value: null | T = null

Defined in

src/sdk/fmc/components/DisplayField.ts:30

Accessors

rawValue

• get rawValue(): null | T

Gets the raw value of this display field

Returns

null | T

the value

Defined in

src/sdk/fmc/components/DisplayField.ts:36

Methods

bind

▸ bind(subscribable): DisplayField<T>

Creates and registers a binding on the page, linking this field with a subscribable

Parameters

Name	Type	Description
subscribable	Subscribable<T>	the subscribable to bind to

Returns

DisplayField<T>

the created binding (usually not needed)

Defined in

src/sdk/fmc/components/DisplayField.ts:50

---

getOptions

▸ getOptions(): DisplayFieldOptions<T>

Returns the component's options

Returns

DisplayFieldOptions<T>

The options.

Inherited from

FmcComponent.getOptions

Defined in

src/sdk/fmc/components/FmcComponent.ts:124

---

handleSelectKey

▸ handleSelectKey(event): Promise<string | boolean>

Parameters

Name	Type
event	LineSelectKeyEvent

Returns

Promise<string | boolean>

Inherit Doc

Inherited from

FmcComponent.handleSelectKey

Defined in

src/sdk/fmc/components/FmcComponent.ts:80

---

invalidate

▸ invalidate(): void

Invalidates the component and queues a re-render if one is not already queued

Returns

void

Inherited from

FmcComponent.invalidate

Defined in

src/sdk/fmc/components/FmcComponent.ts:69

---

onHandleSelectKey

▸ onHandleSelectKey(event): Promise<string | boolean>

Parameters

Name	Type
event	LineSelectKeyEvent

Returns

Promise<string | boolean>

Inherit Doc

Overrides

FmcComponent.onHandleSelectKey

Defined in

src/sdk/fmc/components/DisplayField.ts:69

---

render

▸ render(): FmcFormatterOutput

Renders the FMC component into an FmcRenderTemplateRow

Returns

FmcFormatterOutput

Overrides

FmcComponent.render

Defined in

src/sdk/fmc/components/DisplayField.ts:74

---

takeValue

▸ takeValue(value, shouldInvalidate?): void

Takes an input value, displays it and stores it

Parameters

Name	Type	Default value	Description
value	null | T	undefined	the new input value
shouldInvalidate	boolean	false	whether or not to invalidate the page

Returns

void

Defined in

src/sdk/fmc/components/DisplayField.ts:60