Inspectors¶
Configuration for an inspector. Associative array depending on inspector type.
The only common keys are input, which describes how the inspector will affect the main grid, and appdesk, which defines how it is displayed.
input¶
Associative array:
key: | Key name on which the main grid will be filtered. By default, if query key is not defined, must be the column name on which you want to filter the model. |
---|---|
query: | Optional. Callback function defining how to interact with the main grid query. The function gets two parameters ; the first is the value sent by the inspectors (when items are selected), and the second is the current query. The function must return the transformed query. |
appdesk¶
Associative array. All keys are optional:
label: | Main label of the inspector. |
---|---|
contextChange: | Does the inspector reloads when user selects an other context. |
reloadEvent: | Event name that will reload the inspector? |
vertical: | Is the appdesk vertical or horizontal ? |
inputName: | Key on which selected values are sent. |
Model inspector¶
Associative array:
model: | Model class name |
---|---|
query: | Optional. Additional informations about the query. See query in appdesk configuration. |
data_mapping: | Optional. Defines which data_mapping items are displayed. See data_mapping in appdesk configuration. |
appdesk: | Optional. Additional display information about the appdesk. |
appdesk¶
Associative array:
grid: | Optional. Grids informations. Associative array:
|
---|
Model tree inspector¶
Associative array:
model: | Model class name |
---|---|
query: | Optional. Additional informations about the query. See query in appdesk configuration. |
data_mapping: | Optional. Defines which data_mapping items are displayed. See data_mapping in appdesk configuration. |
appdesk: | Optional. Additional display information about the appdesk. |
models: | Optional. See appdesk tree configuration. |
roots: | Optional. See appdesk tree configuration. |
root_node: | Optional. Add a global root node. Associative array containing dataset values (columns to be displayed). |
appdesk¶
Associative array:
treeGrid: | Optional. Grids informations. Associative array:
|
---|
Date inspector¶
Associative array:
input_begin: | Optional. Default value: date_begin. |
||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
input_end: | Optional. Default value: date_end. |
||||||||||||||||||||||||
label_custom: | Optional. Title used when custom dates can be selected. Default value: “Custom dates”. |
||||||||||||||||||||||||
label_custom_inputs: | |||||||||||||||||||||||||
Optional. Defines how the custom inputs are displayed. There is two placeholders: begin and end. |
|||||||||||||||||||||||||
options: | Optional. Main (root) options for date selector. For each option a key must exists which value is an associative array:
|
Plain data inspector¶
Displays static data. Associative array:
data: | Array of items. Each item is an associative array:
|
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
input: |
|
||||||||||||
appdesk: |
|