Documentation
Preparing search index...
@saltcorn/data
base-plugin/viewtemplates/list
list
Variable list
list
:
{
configCheck
:
(
view
:
any
,
)
=>
Promise
<
{
errors
:
string
[]
;
warnings
:
string
[]
}
>
;
configuration_workflow
:
(
req
:
object
)
=>
Workflow
;
connectedObjects
:
(
configuration
:
any
)
=>
Promise
<
ConnectedObjects
>
;
createBasicView
:
(
__namedParameters
:
{
all_views_created
:
any
;
table
:
any
;
template_table
:
any
;
template_view
:
any
;
viewname
:
any
;
}
,
)
=>
Promise
<
any
>
;
default_state_form
:
(
opts
:
object
)
=>
boolean
;
description
:
string
;
get_state_fields
:
(
table_id
:
string
,
viewname
:
any
,
opts
:
{
columns
:
object
[]
}
,
)
=>
Function
;
initial_config
:
Function
;
name
:
string
;
on_delete
:
(
table_id
:
any
,
viewname
:
string
,
opts
:
{
default_state
:
any
}
,
)
=>
Promise
<
void
>
;
queries
:
(
__namedParameters
:
{
configuration
:
{
columns
:
any
;
default_state
:
any
;
layout
:
any
}
;
exttable_name
:
any
;
name
:
any
;
req
:
any
;
table_id
:
any
;
}
,
)
=>
{
getRowQuery
(
id
:
any
)
:
Promise
<
Row
|
null
>
;
listQuery
(
state
:
any
,
stateHash
:
any
,
)
:
Promise
<
{
rowCount
:
number
|
undefined
;
rows
:
Row
[]
}
>
;
}
;
routes
:
{
run_action
:
(
table_id
:
number
,
viewname
:
any
,
optsOne
:
{
columns
:
object
[]
;
layout
:
any
}
,
body
:
object
,
optsTwo
:
{
req
:
object
;
res
:
any
}
,
__namedParameters
:
{
getRowQuery
:
any
}
,
)
=>
Promise
<
object
>
;
}
;
run
:
(
table_id
:
string
|
number
,
viewname
:
string
,
opts
:
{
columns
:
object
[]
;
create_view_display
:
string
;
create_view_label
?:
string
;
create_view_location
?:
string
;
default_state
?:
object
;
view_to_create
?:
string
;
}
,
stateWithId
?:
object
,
extraOpts
:
object
,
__namedParameters
:
{
listQuery
:
any
}
,
)
=>
Promise
<
any
>
;
view_quantity
:
string
;
getStringsForI18n
(
opts
:
{
columns
:
any
;
create_view_label
:
any
}
)
:
string
[]
;
}
Type Declaration
configCheck
:
(
view
:
any
)
=>
Promise
<
{
errors
:
string
[]
;
warnings
:
string
[]
}
>
configuration_workflow
:
(
req
:
object
)
=>
Workflow
connectedObjects
:
(
configuration
:
any
)
=>
Promise
<
ConnectedObjects
>
createBasicView
:
(
__namedParameters
:
{
all_views_created
:
any
;
table
:
any
;
template_table
:
any
;
template_view
:
any
;
viewname
:
any
;
}
,
)
=>
Promise
<
any
>
default_state_form
:
(
opts
:
object
)
=>
boolean
description
:
string
get_state_fields
:
(
table_id
:
string
,
viewname
:
any
,
opts
:
{
columns
:
object
[]
}
)
=>
Function
initial_config
:
Function
name
:
string
on_delete
:
(
table_id
:
any
,
viewname
:
string
,
opts
:
{
default_state
:
any
}
)
=>
Promise
<
void
>
queries
:
(
__namedParameters
:
{
configuration
:
{
columns
:
any
;
default_state
:
any
;
layout
:
any
}
;
exttable_name
:
any
;
name
:
any
;
req
:
any
;
table_id
:
any
;
}
,
)
=>
{
getRowQuery
(
id
:
any
)
:
Promise
<
Row
|
null
>
;
listQuery
(
state
:
any
,
stateHash
:
any
,
)
:
Promise
<
{
rowCount
:
number
|
undefined
;
rows
:
Row
[]
}
>
;
}
routes
:
{
run_action
:
(
table_id
:
number
,
viewname
:
any
,
optsOne
:
{
columns
:
object
[]
;
layout
:
any
}
,
body
:
object
,
optsTwo
:
{
req
:
object
;
res
:
any
}
,
__namedParameters
:
{
getRowQuery
:
any
}
,
)
=>
Promise
<
object
>
;
}
run_action
:
(
table_id
:
number
,
viewname
:
any
,
optsOne
:
{
columns
:
object
[]
;
layout
:
any
}
,
body
:
object
,
optsTwo
:
{
req
:
object
;
res
:
any
}
,
__namedParameters
:
{
getRowQuery
:
any
}
,
)
=>
Promise
<
object
>
run
:
(
table_id
:
string
|
number
,
viewname
:
string
,
opts
:
{
columns
:
object
[]
;
create_view_display
:
string
;
create_view_label
?:
string
;
create_view_location
?:
string
;
default_state
?:
object
;
view_to_create
?:
string
;
}
,
stateWithId
?:
object
,
extraOpts
:
object
,
__namedParameters
:
{
listQuery
:
any
}
,
)
=>
Promise
<
any
>
view_quantity
:
string
getStringsForI18n
:
function
getStringsForI18n
(
opts
:
{
columns
:
any
;
create_view_label
:
any
}
)
:
string
[]
Parameters
opts
:
{
columns
:
any
;
create_view_label
:
any
}
Returns
string
[]
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
Documentation
Loading...