MarkdownInput

Base class for JS value editors

Extends

• JsInputBase<string>

Constructors

new MarkdownInput()

private new MarkdownInput(caption?): MarkdownInput

Parameters

Parameter	Type
caption?	string

Returns

MarkdownInput

Overrides

JsInputBase . constructor

Source

src/widgets.ts:2254

Properties

Property	Modifier	Type	Default value	Inherited from
_editorRoot	private	HTMLDivElement	...	-
_textToSet?	private	null | string	undefined	-
dart	public	any	undefined	JsInputBase.dart
editor	private	any	undefined	-

Accessors

attachedImages

get attachedImages(): string[]

Returns

string[]

Source

src/widgets.ts:2310

---

caption

get caption(): string

set caption(s): void

Parameters

Parameter	Type
s	string

Returns

string

Source

src/widgets.ts:1322

---

captionLabel

get captionLabel(): HTMLElement

Returns

HTMLElement

Source

src/widgets.ts:1335

---

classList

get classList(): DOMTokenList

Returns

DOMTokenList

Source

src/widgets.ts:1427

---

dataType

get dataType(): string

Data type this input can edit. See Type.

Returns

string

Source

src/widgets.ts:2308

---

enabled

get enabled(): boolean

Whether the input is enabled

set enabled(v): void

Parameters

Parameter	Type
v	boolean

Returns

boolean

Source

src/widgets.ts:1361

---

format

get format(): string

Value format.

set format(s): void

Parameters

Parameter	Type
s	string

Returns

string

Source

src/widgets.ts:1332

---

input

get input(): HTMLElement

Returns the actual input

Returns

HTMLElement

Source

src/widgets.ts:1502

---

inputType

get inputType(): string

Input type identifier (such as "Slider" for the slider input). See InputType.

Returns

string

Source

src/widgets.ts:2306

---

notify

get notify(): boolean

Whether events are thrown on value set

set notify(v): void

Parameters

Parameter	Type
v	boolean

Returns

boolean

Source

src/widgets.ts:1345

---

nullable

get nullable(): boolean

Whether empty values are allowed

set nullable(v): void

Parameters

Parameter	Type
v	boolean

Returns

boolean

Source

src/widgets.ts:1341

---

onChanged

get onChanged(): Observable<T>

Occurs when [value] is changed, either by user or programmatically.

Returns

Observable<T>

Source

src/widgets.ts:1365

---

onInput

get onInput(): Observable<Event>

Occurs when [value] is changed by user.

Returns

Observable<Event>

Source

src/widgets.ts:1368

---

property

get property(): any

Property if associated with

set property(p): void

Parameters

Parameter	Type
p	Property

Returns

any

Source

src/widgets.ts:1328

---

readOnly

get readOnly(): boolean

Whether the input is readonly

set readOnly(v): void

Parameters

Parameter	Type
v	boolean

Returns

boolean

Source

src/widgets.ts:1357

---

root

get root(): HTMLElement

Visual root (typically a div element that contains caption and input)

Returns

HTMLElement

Source

src/widgets.ts:1320

---

stringValue

get stringValue(): string

String representation of the value

set stringValue(value): void

Parameters

Parameter	Type
value	string

Returns

string

Source

src/widgets.ts:1507

---

value

get value(): T

Input value

set value(value): void

Parameters

Parameter	Type
value	T

Returns

T

Source

src/widgets.ts:1504

Methods

addCaption()

addCaption(caption): InputBase<string>

Adds the specified caption

Parameters

Parameter	Type
caption	string

Returns

InputBase<string>

Inherited from

JsInputBase . addCaption

Source

src/widgets.ts:1393

---

addOptions()

addOptions(options): InputBase<string>

Adds the specified options

Parameters

Parameter	Type
options	HTMLElement

Returns

InputBase<string>

Inherited from

JsInputBase . addOptions

Source

src/widgets.ts:1405

---

addPatternMenu()

addPatternMenu(pattern): void

Adds a usage example to the input's hamburger menu

Parameters

Parameter	Type
pattern	any

Returns

void

Inherited from

JsInputBase . addPatternMenu

Source

src/widgets.ts:1411

---

addPostfix()

addPostfix(postfix): InputBase<string>

Adds the specified postfix

Parameters

Parameter	Type
postfix	string

Returns

InputBase<string>

Inherited from

JsInputBase . addPostfix

Source

src/widgets.ts:1399

---

addValidator()

addValidator(validator): void

Adds a validator that accepts a string representation of the edited value and returns null if valid, or error message if invalid

Parameters

Parameter	Type
validator	(value) => null | string

Returns

void

Inherited from

JsInputBase . addValidator

Source

src/widgets.ts:1417

---

fireChanged()

fireChanged(): any

Fires the 'changed' event (value has changed). See also fireInput

Returns

any

Inherited from

JsInputBase . fireChanged

Source

src/widgets.ts:1383

---

fireInput()

fireInput(): any

Fires the 'input' event (user input). See also fireChanged

Returns

any

Inherited from

JsInputBase . fireInput

Source

src/widgets.ts:1388

---

getInput()

getInput(): HTMLElement

Returns

HTMLElement

Overrides

JsInputBase . getInput

Source

src/widgets.ts:2304

---

getStringValue()

getStringValue(): string

Returns

string

Overrides

JsInputBase . getStringValue

Source

src/widgets.ts:2318

---

getValue()

getValue(): string

Returns

string

Overrides

JsInputBase . getValue

Source

src/widgets.ts:2322

---

init()

init(): any

Returns

any

Inherited from

JsInputBase . init

Source

src/widgets.ts:1378

---

load()

load(s): any

Loads the value. Used in dialog history. See also load

Parameters

Parameter	Type
s	any

Returns

any

Inherited from

JsInputBase . load

Source

src/widgets.ts:1376

---

save()

save(): any

Saves the value. Used in dialog history. See also load

Returns

any

Inherited from

JsInputBase . save

Source

src/widgets.ts:1371

---

setStringValue()

setStringValue(value): void

Parameters

Parameter	Type
value	string

Returns

void

Overrides

JsInputBase . setStringValue

Source

src/widgets.ts:2326

---

setTooltip()

setTooltip(msg, tooltipCheck): InputBase<string>

Sets the tooltip

Parameters

Parameter	Type	Default value
msg	string	undefined
tooltipCheck	null | () => boolean	null

Returns

InputBase<string>

Inherited from

JsInputBase . setTooltip

Source

src/widgets.ts:1422

---

setValue()

setValue(value): void

Parameters

Parameter	Type
value	any

Returns

void

Overrides

JsInputBase . setValue

Source

src/widgets.ts:2330

---

validate()

validate(): boolean

Performs immediate validation of the input and returns the result.

Returns

boolean

True if the input is valid; otherwise, false.

Inherited from

JsInputBase . validate

Source

src/widgets.ts:1434

---

create()

static create(caption?, options?): MarkdownInput

Parameters

Parameter	Type
caption?	string
options?	MarkdownConfig

Returns

MarkdownInput

Source

src/widgets.ts:2260

---

forColumn()

static forColumn<T>(column): InputBase<null | T>

Creates input for the specified column

Type parameters

Type parameter	Value
T	any

Parameters

Parameter	Type
column	Column<T, T>

Returns

InputBase<null | T>

Inherited from

JsInputBase . forColumn

Source

src/widgets.ts:1307

---

forInputType()

static forInputType(inputType): InputBase<any>

Creates input for the specified input type

Parameters

Parameter	Type
inputType	string | InputType

Returns

InputBase<any>

Inherited from

JsInputBase . forInputType

Source

src/widgets.ts:1302

---

forProperty()

static forProperty(property, source): InputBase<any>

Creates input for the specified property, and optionally binds it to the specified object

Parameters

Parameter	Type	Default value
property	Property	undefined
source	any	null

Returns

InputBase<any>

Inherited from

JsInputBase . forProperty

Source

src/widgets.ts:1297