Form
Defined in: js-api/src/grid.ts:878
Represents a form that can be user-designed or edited.
Constructors
Constructor
new Form(
dart):Form
Defined in: js-api/src/grid.ts:881
Parameters
| Parameter | Type |
|---|---|
dart | any |
Returns
Form
Properties
| Property | Type | Defined in |
|---|---|---|
dart | any | js-api/src/grid.ts:879 |
Accessors
designMode
Get Signature
get designMode():
boolean
Defined in: js-api/src/grid.ts:895
When in design mode, users can move form controls.
Returns
boolean
Set Signature
set designMode(
x):void
Defined in: js-api/src/grid.ts:896
Parameters
| Parameter | Type |
|---|---|
x | boolean |
Returns
void
editable
Get Signature
get editable():
boolean
Defined in: js-api/src/grid.ts:891
When in editable mode, users can edit field values.
Returns
boolean
Set Signature
set editable(
x):void
Defined in: js-api/src/grid.ts:892
Parameters
| Parameter | Type |
|---|---|
x | boolean |
Returns
void
row
Get Signature
get row():
Row
Defined in: js-api/src/grid.ts:899
Data frame row bound to the form.
Returns
Set Signature
set row(
row):void
Defined in: js-api/src/grid.ts:900
Parameters
| Parameter | Type |
|---|---|
row | Row |
Returns
void
state
Get Signature
get state():
string
Defined in: js-api/src/grid.ts:903
Serialized form content. Use it for persistence purposes.
Returns
string
Set Signature
set state(
s):void
Defined in: js-api/src/grid.ts:904
Parameters
| Parameter | Type |
|---|---|
s | string |
Returns
void
Methods
forDataFrame()
staticforDataFrame(df,options?):Form
Defined in: js-api/src/grid.ts:886
Creates a new grid.
Parameters
| Parameter | Type |
|---|---|
df | DataFrame |
options? | { columns?: string[]; } |
options.columns? | string[] |
Returns
Form