Class: PageLinkField

A field for displaying a link to navigate to another page

Hierarchy

• DisplayField<string>

  ↳ PageLinkField

Constructors

constructor

• new PageLinkField(page, options): PageLinkField

Parameters

Name	Type
page	AbstractFmcPage<any>
options	PageLinkFieldOptions

Returns

PageLinkField

Inherit Doc

Overrides

DisplayField.constructor

Defined in

src/sdk/fmc/components/PageLinkField.ts:21

Properties

isDisabled

• isDisabled: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Inherited from

DisplayField.isDisabled

Defined in

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

---

options

• Protected options: DisplayFieldOptions<string>

Inherited from

DisplayField.options

Defined in

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

---

page

• Protected Readonly page: AbstractFmcPage<any>

Inherited from

DisplayField.page

Defined in

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

---

value

• Protected value: null | string = null

Inherited from

DisplayField.value

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

Inherited from

DisplayField.rawValue

Defined in

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

Methods

bind

▸ bind(subscribable): DisplayField<string>

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

Parameters

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

Returns

DisplayField<string>

the created binding (usually not needed)

Inherited from

DisplayField.bind

Defined in

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

---

getOptions

▸ getOptions(): DisplayFieldOptions<string>

Returns the component's options

Returns

DisplayFieldOptions<string>

The options.

Inherited from

DisplayField.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

DisplayField.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

DisplayField.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

Inherited from

DisplayField.onHandleSelectKey

Defined in

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

---

render

▸ render(): FmcFormatterOutput

Renders the FMC component into an FmcRenderTemplateRow

Returns

FmcFormatterOutput

Inherited from

DisplayField.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 | string	undefined	the new input value
shouldInvalidate	boolean	false	whether or not to invalidate the page

Returns

void

Inherited from

DisplayField.takeValue

Defined in

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

---

createLink

▸ createLink(page, label, route, disabled?, params?): PageLinkField

Creates an PageLinkField

Parameters

Name	Type	Default value	Description
page	AbstractFmcPage<any>	undefined	the parent FmcPage
label	string	undefined	the label to display
route	string	undefined	the route to navigate to (will disable link when empty)
disabled	boolean	false	whether the link is disabled
params?	Record<string, unknown>	undefined	Parameters for the route

Returns

PageLinkField

the PageLinkField

Defined in

src/sdk/fmc/components/PageLinkField.ts:42