@formstack/forms-renderer
Preparing search index...
IFormApi
Interface IFormApi
interface
IFormApi
{
applyTheme
(
theme
:
any
)
:
void
;
empty
()
:
Promise
<
void
>
;
getField
(
fieldId
:
any
)
:
TFieldApiUnion
;
getFieldBy
(
predicate
:
(
field
:
IFieldApi
)
=>
boolean
)
:
TFieldApiUnion
;
getFieldByInternalLabel
(
internalLabel
:
string
)
:
TFieldApiUnion
;
getFields
(
predicate
?:
(
field
:
IFieldDto
)
=>
boolean
)
:
IFieldApi
[]
;
getFieldsByTableHeaderId
(
headerId
:
string
)
:
TFieldApiUnion
[]
;
getFieldsByTableId
(
tableId
:
string
)
:
TFieldApiUnion
[]
;
getFieldsByTableInternalLabel
(
internalLabel
:
string
)
:
TFieldApiUnion
[]
;
getPagingContext
()
:
IPagingContext
;
getSection
(
sectionId
:
any
)
:
ISectionApi
;
getSections
(
predicate
?:
(
section
:
any
)
=>
boolean
)
:
any
[]
;
getSubmissionJSON
()
:
IValidateFormSubmissionDto
;
isRendered
()
:
boolean
;
isWithErrors
()
:
boolean
;
notifyFormEventListeners
(
type
:
FormEvents
,
data
:
any
)
:
Promise
<
any
>
;
registerFormEventListener
(
listener
:
IFormEventListener
)
:
void
;
reset
()
:
Promise
<
void
>
;
setValues
(
values
:
{
[
fieldId
:
string
]:
IFieldValueUnion
}
)
:
Promise
<
void
>
;
unregisterFormEventListener
(
listener
:
IFormEventListener
)
:
void
;
}
Hierarchy (
View Summary
)
IAbstractFieldParent
IFormApi
Index
Methods
apply
Theme
empty
get
Field
get
Field
By
get
Field
By
Internal
Label
get
Fields
get
Fields
By
Table
Header
Id
get
Fields
By
Table
Id
get
Fields
By
Table
Internal
Label
get
Paging
Context
get
Section
get
Sections
get
SubmissionJSON
is
Rendered
is
With
Errors
notify
Form
Event
Listeners
register
Form
Event
Listener
reset
set
Values
unregister
Form
Event
Listener
Methods
apply
Theme
applyTheme
(
theme
:
any
)
:
void
Parameters
theme
:
any
Returns
void
empty
empty
()
:
Promise
<
void
>
Returns
Promise
<
void
>
get
Field
getField
(
fieldId
:
any
)
:
TFieldApiUnion
Parameters
fieldId
:
any
Returns
TFieldApiUnion
get
Field
By
getFieldBy
(
predicate
:
(
field
:
IFieldApi
)
=>
boolean
)
:
TFieldApiUnion
Parameters
predicate
:
(
field
:
IFieldApi
)
=>
boolean
Returns
TFieldApiUnion
get
Field
By
Internal
Label
getFieldByInternalLabel
(
internalLabel
:
string
)
:
TFieldApiUnion
Parameters
internalLabel
:
string
Returns
TFieldApiUnion
get
Fields
getFields
(
predicate
?:
(
field
:
IFieldDto
)
=>
boolean
)
:
IFieldApi
[]
Parameters
Optional
predicate
:
(
field
:
IFieldDto
)
=>
boolean
Returns
IFieldApi
[]
get
Fields
By
Table
Header
Id
getFieldsByTableHeaderId
(
headerId
:
string
)
:
TFieldApiUnion
[]
Parameters
headerId
:
string
Returns
TFieldApiUnion
[]
get
Fields
By
Table
Id
getFieldsByTableId
(
tableId
:
string
)
:
TFieldApiUnion
[]
Parameters
tableId
:
string
Returns
TFieldApiUnion
[]
get
Fields
By
Table
Internal
Label
getFieldsByTableInternalLabel
(
internalLabel
:
string
)
:
TFieldApiUnion
[]
Parameters
internalLabel
:
string
Returns
TFieldApiUnion
[]
get
Paging
Context
getPagingContext
()
:
IPagingContext
Returns
IPagingContext
get
Section
getSection
(
sectionId
:
any
)
:
ISectionApi
Parameters
sectionId
:
any
Returns
ISectionApi
get
Sections
getSections
(
predicate
?:
(
section
:
any
)
=>
boolean
)
:
any
[]
Parameters
Optional
predicate
:
(
section
:
any
)
=>
boolean
Returns
any
[]
get
SubmissionJSON
getSubmissionJSON
()
:
IValidateFormSubmissionDto
Returns
IValidateFormSubmissionDto
is
Rendered
isRendered
()
:
boolean
Returns
boolean
is
With
Errors
isWithErrors
()
:
boolean
Returns
boolean
notify
Form
Event
Listeners
notifyFormEventListeners
(
type
:
FormEvents
,
data
:
any
)
:
Promise
<
any
>
Parameters
type
:
FormEvents
data
:
any
Returns
Promise
<
any
>
register
Form
Event
Listener
registerFormEventListener
(
listener
:
IFormEventListener
)
:
void
Parameters
listener
:
IFormEventListener
Returns
void
reset
reset
()
:
Promise
<
void
>
Returns
Promise
<
void
>
set
Values
setValues
(
values
:
{
[
fieldId
:
string
]:
IFieldValueUnion
}
)
:
Promise
<
void
>
Parameters
values
:
{
[
fieldId
:
string
]:
IFieldValueUnion
}
Returns
Promise
<
void
>
unregister
Form
Event
Listener
unregisterFormEventListener
(
listener
:
IFormEventListener
)
:
void
Parameters
listener
:
IFormEventListener
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
apply
Theme
empty
get
Field
get
Field
By
get
Field
By
Internal
Label
get
Fields
get
Fields
By
Table
Header
Id
get
Fields
By
Table
Id
get
Fields
By
Table
Internal
Label
get
Paging
Context
get
Section
get
Sections
get
SubmissionJSON
is
Rendered
is
With
Errors
notify
Form
Event
Listeners
register
Form
Event
Listener
reset
set
Values
unregister
Form
Event
Listener
@formstack/forms-renderer
Loading...