Skip to main content

Namespace: input

ui.input

Functions

bigInt

bigInt(name, options?): InputBase<BigInt>

Parameters

NameType
namestring
options?IInputInitOptions<BigInt>

Returns

InputBase<BigInt>

Defined in

ui.ts:846


bool

bool(name, options?): InputBase<boolean>

Parameters

NameType
namestring
options?IInputInitOptions<boolean>

Returns

InputBase<boolean>

Defined in

ui.ts:886


choice

choice<T>(name, options?): ChoiceInput<T>

Type parameters

Name
T

Parameters

NameType
namestring
options?IChoiceInputInitOptions<T>

Returns

ChoiceInput<T>

Defined in

ui.ts:858


code

code(name, options?): CodeInput

Parameters

NameType
namestring
options?CodeConfig

Returns

CodeInput

Defined in

ui.ts:946


color

color(name, options?): InputBase<string>

Parameters

NameType
namestring
options?IInputInitOptions<string>

Returns

InputBase<string>

Defined in

ui.ts:922


column

column(name, options?): InputBase<Column>

Parameters

NameType
namestring
options?IColumnInputInitOptions<Column<any>>

Returns

InputBase<Column>

Defined in

ui.ts:906


columns

columns(name, options?): InputBase<Column[]>

Parameters

NameType
namestring
options?IColumnsInputInitOptions<Column<any>[]>

Returns

InputBase<Column[]>

Defined in

ui.ts:910


date

date(name, options?): DateInput

Parameters

NameType
namestring
options?IInputInitOptions<Dayjs>

Returns

DateInput

Defined in

ui.ts:878


file

file(name, options?): InputBase<FileInfo>

Parameters

NameType
namestring
options?IInputInitOptions<FileInfo>

Returns

InputBase<FileInfo>

Defined in

ui.ts:894


float

float(name, options?): InputBase<number>

Parameters

NameType
namestring
options?INumberInputInitOptions<number>

Returns

InputBase<number>

Defined in

ui.ts:874


forInputType

forInputType(inputType): InputBase

Parameters

NameType
inputTypestring | InputType

Returns

InputBase

Defined in

ui.ts:820


forProperty

forProperty(property, source?, options?): InputBase

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

Parameters

NameTypeDefault value
propertyPropertyundefined
sourceanynull
options?IInputInitOptions<any>undefined

Returns

InputBase

Defined in

ui.ts:811


form

form(source, props, options?): HTMLElement

Returns a form for the specified properties, bound to the specified object

Parameters

NameType
sourceany
propsProperty[]
options?IInputInitOptions<any>

Returns

HTMLElement

Defined in

ui.ts:829


grid

grid(items, properties): ItemsGrid

Parameters

NameType
itemsany[]
propertiesProperty[]

Returns

ItemsGrid

Defined in

ui.ts:824


image

image(name, options?): InputBase<string>

Parameters

NameType
namestring
options?IInputInitOptions<string>

Returns

InputBase<string>

Defined in

ui.ts:938


int

int(name, options?): InputBase<number>

Parameters

NameType
namestring
options?INumberInputInitOptions<number>

Returns

InputBase<number>

Defined in

ui.ts:842


list

list(name, options?): InputBase<any[]>

Parameters

NameType
namestring
options?IInputInitOptions<any[]>

Returns

InputBase<any[]>

Defined in

ui.ts:898


map

map(name, options?): InputBase<Map<string, string>>

Parameters

NameType
namestring
options?IInputInitOptions<Map<string, string>>

Returns

InputBase<Map<string, string>>

Defined in

ui.ts:882


markdown

markdown(name): Promise<MarkdownInput>

Parameters

NameType
namestring

Returns

Promise<MarkdownInput>

Defined in

ui.ts:942


molecule

molecule(name, options?): InputBase<string>

Parameters

NameType
namestring
options?IInputInitOptions<string>

Returns

InputBase<string>

Defined in

ui.ts:902


multiChoice

multiChoice<T>(name, options?): InputBase<T[]>

Type parameters

Name
T

Parameters

NameType
namestring
options?IMultiChoiceInputInitOptions<T>

Returns

InputBase<T[]>

Defined in

ui.ts:862


qNum

qNum(name, options?): InputBase<number>

Parameters

NameType
namestring
options?IInputInitOptions<any>

Returns

InputBase<number>

Defined in

ui.ts:850


radio

radio(name, options?): InputBase<string>

Parameters

NameType
namestring
options?IChoiceInputInitOptions<string>

Returns

InputBase<string>

Defined in

ui.ts:926


search(name, options?): InputBase<string>

Parameters

NameType
namestring
options?IStringInputInitOptions<string>

Returns

InputBase<string>

Defined in

ui.ts:870


slider

slider(name, options?): InputBase<number>

Parameters

NameType
namestring
options?INumberInputInitOptions<number>

Returns

InputBase<number>

Defined in

ui.ts:854


string

string(name, options?): InputBase<string>

Parameters

NameType
namestring
options?IStringInputInitOptions<string>

Returns

InputBase<string>

Defined in

ui.ts:866


table

table(name, options?): InputBase<DataFrame>

Parameters

NameType
namestring
options?IChoiceInputInitOptions<DataFrame[]>

Returns

InputBase<DataFrame>

Defined in

ui.ts:914


tags

tags(name, config?): TagsInput

Parameters

NameType
namestring
config?TagsInputConfig

Returns

TagsInput

Defined in

ui.ts:950


textArea

textArea(name, options?): InputBase<string>

Parameters

NameType
namestring
options?ITextAreaInputInitOptions<string>

Returns

InputBase<string>

Defined in

ui.ts:918


toggle

toggle(name, options?): InputBase<boolean>

Parameters

NameType
namestring
options?IInputInitOptions<boolean>

Returns

InputBase<boolean>

Defined in

ui.ts:890


user

user(name, options?): InputBase<User[]>

Parameters

NameType
namestring
options?IInputInitOptions<User[]>

Returns

InputBase<User[]>

Defined in

ui.ts:930


userGroups

userGroups(name, options?): InputBase<User[]>

Parameters

NameType
namestring
options?IInputInitOptions<User[]>

Returns

InputBase<User[]>

Defined in

ui.ts:934