Skip to main content

awe Screen Schema

Generated from screen.xsd. It includes general.xsd.

This Schema defines the way an awe Screen must be structured

55 elements, 447 declared attributes (212 documented).

Elements​

Elements: screen, grid, accordion, accordion-item, pivot-table, tag, video, map, card, link, image, javascript, dialog, side-panel, popover, include, tab, tabcontainer, wizard, wizard-panel, column, row-detail, quick-filter, search, header-tag, group-header, window, resizable, criteria, button, context-button, context-separator, button-action, message, text, info, info-button, info-criteria, avatar, menu-container, frame, view, dependency, dependency-action, dependency-element, widget, widget-parameter, chart, chart-legend, chart-tooltip, x-axis, y-axis, chart-serie, chart-parameter, tag-list

screen​

Type: screenType

Contains: tag (0..n), javascript (0..n), message (0..n)

Contained by: none (document root)

AttributeTypeRequiredDefaultDescription
labelstringnoNot documented yet
templatestringyesNot documented yet
targetstringnoNot documented yet
onloadstringnoNot documented yet
onunloadstringnoNot documented yet
keep-criteriatrue, falsenoNot documented yet
helpstringnoNot documented yet
help-imagestringnoNot documented yet

grid​

Data grid (or tree grid when treegrid is true) that shows the rows returned by a query. It contains the columns, optional group headers, buttons and context menu, and can be editable. Supported by both client engines; the tree grid support of the React engine is partial (see the attributes).

Type: gridType

Contains: group-header (0..n), column (0..n), row-detail (0..n), quick-filter (0..n), search (0..n), button (0..n), context-button (0..n), context-separator (0..n), dependency (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, row-detail, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
idnameEnumyesGrid identifier. It is the key of the grid on the screen and the name of the grid variables sent to the server (for example id-RowTyp). Required.
namenameEnumnoComponent name stored in the screen model. Neither client engine uses it.
stylestringnoCSS classes added to the grid.
multiselecttrue, falsenoAllows selecting several rows and adds a checkbox column to select them. Default: false. In a tree grid the React engine only supports single selection.
checkbox-multiselecttrue, falsenoRead by the model but not implemented by either client engine; use multiselect to get a checkbox column. Default: false.
send-operationstrue, falsenoMakes the grid editable and sends only the rows that were inserted, updated or deleted, with the type of operation of each row in the id-RowTyp parameter, and shows an operation icon column. It takes precedence over editable in the AngularJS engine. Default: false.
editabletrue, falsenoAllows editing rows. In AngularJS the selected row is edited in place with save and cancel buttons; in React a row is edited with a row editor opened by double click. Default: false.
show-totalstrue, falsenoShows a footer row with the summary of each column that has a summary-type. AngularJS only calculates sums, whatever the summary-type; React supports sum, avg, max and min. When the rows are grouped, the footer is the grand total of all the rows. Default: false.
group-bystringnoComma-separated column names that group the rows, one grouping level each, in order; unknown names are ignored. Each group row shows its value, its row count and the aggregates of the columns with a summary-type (sum, avg, max, min) in both engines. A grouped grid loads every row (as load-all) and does not paginate. Ignored on tree grids and on editable, send-operations, move-rows and row-detail grids.
group-selectortrue, falsenoShows a "Group by" control in the toolbar to choose the grouping levels at runtime (visible columns with a label and without summary-type). Like group-by, it makes the grid load every row. Default: false.
group-subtotalstrue, falsenoCloses each group with a subtotal row with the aggregates of the group. Only used when the rows are grouped. Default: true.
enable-filterstrue, falsenoShows a filter for each column. Default: false.
row-numberstrue, falsenoAdds a first column with the row number. Not shown in tree grids. Default: true.
move-rowstrue, falsenoAdds a leading column with a grip to move the rows by dragging them. The Alt+arrow shortcuts to move the selected row are also enabled. Not available in tree grids. Default: false.
treegridtrue, falsenoShows the data as a tree grid instead of a plain grid. The rows are related by the tree-id and tree-parent fields. Default: false.
tree-idstringnoTree grid only. Name of the field that identifies each row. Default: id.
tree-parentstringnoTree grid only. Name of the field with the identifier of the parent row. Default: parent.
tree-leafstringnoTree grid only. Name of the field that tells whether a row is a leaf. Default: isLeaf.
expand-columnstringnoTree grid only. Name of the column that holds the expand and collapse toggle. React only (default: the tree-id field); the AngularJS engine ignores it and shows the toggle in the row header.
icon-expandstringnoTree grid only. Icon of a collapsed node (an icon name of the Icons page: Font Awesome 4 by default, mdi:name or lucide:name). Default: plus-square. Both engines.
icon-collapsestringnoTree grid only. Icon of an expanded node (an icon name of the Icons page: Font Awesome 4 by default, mdi:name or lucide:name). Default: minus-square. Both engines.
icon-loadingloadingIconEnum (14 values)noStyle of the loading indicator shown while the grid loads. skeleton shows placeholder rows with the grid columns on every load; skeleton-dim shows them on the first load and dims the rows on a reload. Default: the awe.application.component.grid-icon-loading property (skeleton). Set another value (spinner...) to disable the skeleton on this grid.
initial-levelintegernoTree grid only. Number of levels expanded after loading: a value of N expands N-1 levels, so 0 and 1 both start collapsed. Both engines; a row that carries an expanded field is expanded or collapsed by it, and only loaded nodes are expanded by the level.
icon-leafstringnoTree grid only. Icon of a node without children (an icon name of the Icons page: Font Awesome 4 by default, mdi:name or lucide:name). Default: dot-circle-o. Both engines.
load-alltrue, falsenoLoads every row at once (max is ignored) and sorts and paginates locally in the client. Default: false.
send-alltrue, falsenoSends the values of all the grid rows to the server instead of only the selected ones; the selected rows are then sent in the id.selected parameter. Default: false.
helpstringnoHelp text of the grid. AngularJS shows it in the column headers; React does not show it for grids.
help-imagestringnoPath of an image shown in the grid help. AngularJS only.
validate-on-savetrue, falsenoWhen false, the row being edited is not validated before it is saved, or before the page is changed. Default: true.
pagination-disabledtrue, falsenoHides the paginator of the grid. Default: false.
pager-valuesstringnoComma separated list of rows-per-page values the user can choose in the paginator (for example 5,25,50,100). Every value must be an integer. Without it AngularJS shows no selector and React offers 10, 20 and 30 plus the max value.
visibletrue, falsenoInitial visibility of the grid. Default: true.
row-heightintegernoMinimum height of each row in pixels. Plain grids in both engines (AngularJS default 27); tree grids ignore it in both.
show-toolbartrue, falsenoShows the grid toolbar, with the Columns dialog (show, hide and reorder columns, saved per user) and the Maximize button. Set it to false to opt out. Default: true.
columns-panelpopover, dialog, side-panelnoHow the toolbar shows the Columns of the grid: popover (anchored to the Columns button, the grid stays in view), dialog (a modal dialog in the middle of the screen) or side-panel (a panel anchored to the right edge). Both engines. Default: the property awe.application.component.grid-columns-panel (popover unless the application changes it).
empty-titlestringnoTitle (locale or text) shown in the empty state of the grid. Default: a translated "No records" title
empty-textstringnoDescription (locale or text) shown in the empty state of the grid. Default: a translated "No records match the search" text
empty-iconstringnoIcon shown in the empty state of the grid (grid without rows). Default: an inbox icon
empty-actionstringnoIdentifier of a button of the grid. The empty state shows a button with its label and icon that runs the button actions
initial-loadenum, query, valuenoHow the component gets its data when the screen is built. query runs the target query, enum reads the target enumerated, and value runs the target and uses the first row to fill the selected value (for a criterion this overrides the value from variable, session, property and value). A grid only loads data with query.
server-actionserverActionEnum (45 values)noServer action used to load or refresh the component data (for example data). Used together with target-action.
target-actionnameEnumnoName of the target (query, enumerated or maintain) that the server action runs.
maxintegernoNumber of rows requested per page. Default: for a grid, the grid.rows.per.page property (30); for a criterion, the awe.application.component.criteria-rows-per-page property (100).
autorefreshintegernoReloads the component data from the server every this many seconds. 0 or empty means no automatic refresh.
autoloadtrue, falsenoWhen true, the component is reloaded from the server as soon as it is created, after the screen is shown. Default: false.

accordion​

Type: accordionType

Contains: accordion-item (0..n), dependency (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
idstringyesNot documented yet
stylestringnoNot documented yet
selectedstringnoNot documented yet
autocollapsetrue, falsenoNot documented yet

accordion-item​

Type: accordionItemType

Contains: grid (0..n), accordion (0..n), pivot-table (0..n), window (0..n), card (0..n), resizable (0..n), tag (0..n), tab (0..n), video (0..n), map (0..n), link (0..n), image (0..n), wizard (0..n), criteria (0..n), button (0..n), avatar (0..n), message (0..n), text (0..n), widget (0..n), chart (0..n), javascript (0..n), include (0..n), dialog (0..n), side-panel (0..n), popover (0..n), info (0..n), info-button (0..n), info-criteria (0..n), menu-container (0..n), frame (0..n), view (0..n), tag-list (0..n)

Contained by: accordion

AttributeTypeRequiredDefaultDescription
idstringyesNot documented yet
labelstringyesNot documented yet
stylestringnoNot documented yet

pivot-table​

Type: pivotTableType

Contains: context-button (0..n), context-separator (0..n), dependency (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
idnameEnumyesNot documented yet
stylestringnoNot documented yet
total-column-placementleft, rightnoNot documented yet
total-row-placementtop, bottomnoNot documented yet
colsstringnoNot documented yet
rowsstringnoNot documented yet
rendererTable, Table Barchart, Heatmap, Row Heatmap, Col HeatmapnoNot documented yet
aggregatorPivotAggregatorEnum (25 values)noNot documented yet
aggregation-fieldstringnoNot documented yet
sort-methodabsolute, naturalnoNot documented yet
decimal-numbersintegernoNot documented yet
thousand-separatorstringnoNot documented yet
decimal-separatorstringnoNot documented yet
initial-loadenum, query, valuenoHow the component gets its data when the screen is built. query runs the target query, enum reads the target enumerated, and value runs the target and uses the first row to fill the selected value (for a criterion this overrides the value from variable, session, property and value). A grid only loads data with query.
server-actionserverActionEnum (45 values)noServer action used to load or refresh the component data (for example data). Used together with target-action.
target-actionnameEnumnoName of the target (query, enumerated or maintain) that the server action runs.
maxintegernoNumber of rows requested per page. Default: for a grid, the grid.rows.per.page property (30); for a criterion, the awe.application.component.criteria-rows-per-page property (100).
autorefreshintegernoReloads the component data from the server every this many seconds. 0 or empty means no automatic refresh.
autoloadtrue, falsenoWhen true, the component is reloaded from the server as soon as it is created, after the screen is shown. Default: false.

tag​

Type: htmlTagType

Contains: grid (0..n), accordion (0..n), pivot-table (0..n), window (0..n), card (0..n), resizable (0..n), tag (0..n), tab (0..n), video (0..n), map (0..n), link (0..n), image (0..n), wizard (0..n), criteria (0..n), button (0..n), avatar (0..n), message (0..n), text (0..n), widget (0..n), chart (0..n), javascript (0..n), include (0..n), dialog (0..n), side-panel (0..n), popover (0..n), info (0..n), info-button (0..n), info-criteria (0..n), menu-container (0..n), frame (0..n), view (0..n), tag-list (0..n)

Contained by: screen, accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, button, info, info-button, avatar, tag-list

AttributeTypeRequiredDefaultDescription
idstringnoNot documented yet
labelstringnoNot documented yet
sourcestringnoNot documented yet
stylestringnoNot documented yet
typestringnoNot documented yet
expandiblehorizontal, verticalnoNot documented yet
iconstringnoIcon shown before the label of the tag (an icon name of the Icons page: Font Awesome 4 by default, mdi:name or lucide:name), decorative. With style="section-title" a heading tag (h2, h3, h4) is the title of a section of a form: the icon and the label in one line, and a separator line above every section title but the first one of its container. Supported by both client engines.

video​

Type: videoType

Contains: grid (0..n), accordion (0..n), pivot-table (0..n), window (0..n), card (0..n), resizable (0..n), tag (0..n), tab (0..n), video (0..n), map (0..n), link (0..n), image (0..n), wizard (0..n), criteria (0..n), button (0..n), avatar (0..n), message (0..n), text (0..n), widget (0..n), chart (0..n), javascript (0..n), include (0..n), dialog (0..n), side-panel (0..n), popover (0..n), info (0..n), info-button (0..n), info-criteria (0..n), menu-container (0..n), frame (0..n), view (0..n), tag-list (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
idstringnoNot documented yet
labelstringnoNot documented yet
sourcestringnoNot documented yet
stylestringnoNot documented yet
typestringnoNot documented yet
expandiblehorizontal, verticalnoNot documented yet
looptrue, falsenoNot documented yet
preloadfull-video, metadata, nonenoNot documented yet
autoplaytrue, falsenoNot documented yet
posterstringnoNot documented yet
srcstringnoNot documented yet
controlstrue, falsenoNot documented yet

map​

Interactive map (Leaflet with OpenStreetMap tiles). Each data row is a marker; clicking a marker selects its row and launches the dependencies.

Type: mapType

Contains: dependency (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
idstringnoNot documented yet
labelstringnoNot documented yet
sourcestringnoNot documented yet
stylestringnoNot documented yet
typestringnoNot documented yet
expandiblehorizontal, verticalnoNot documented yet
initial-loadenum, query, valuenoHow the component gets its data when the screen is built. query runs the target query, enum reads the target enumerated, and value runs the target and uses the first row to fill the selected value (for a criterion this overrides the value from variable, session, property and value). A grid only loads data with query.
server-actionserverActionEnum (45 values)noServer action used to load or refresh the component data (for example data). Used together with target-action.
target-actionnameEnumnoName of the target (query, enumerated or maintain) that the server action runs.
maxintegernoNumber of rows requested per page. Default: for a grid, the grid.rows.per.page property (30); for a criterion, the awe.application.component.criteria-rows-per-page property (100).
autorefreshintegernoReloads the component data from the server every this many seconds. 0 or empty means no automatic refresh.
autoloadtrue, falsenoWhen true, the component is reloaded from the server as soon as it is created, after the screen is shown. Default: false.
latitudestringnoName of the data column that holds the marker latitude. Default: latitude.
longitudestringnoName of the data column that holds the marker longitude. Default: longitude.
marker-labelstringnoName of the data column shown in the popup of a marker.
zoomintegernoInitial zoom level of the map.
center-latitudedecimalnoLatitude of the initial map center. Without a center, the map fits the markers.
center-longitudedecimalnoLongitude of the initial map center. Without a center, the map fits the markers.

card​

Metric tile: a title, a big value with its unit, an icon, a change (delta) with its trend and caption, a description, a footer and an optional progress towards a target. Its attributes are static values; with initial-load the first row of the target query fills it, and the query fields (named as the attributes in camelCase: title, value, unit, delta, deltaUnit, trend, caption, tone...) override them. Its children (a chart, a grid, buttons...) are shown in its body, below the value. It refreshes with reload, filter and dependencies like any component. Supported by both client engines.

Type: cardType

Contains: grid (0..n), accordion (0..n), pivot-table (0..n), window (0..n), card (0..n), resizable (0..n), tag (0..n), tab (0..n), video (0..n), map (0..n), link (0..n), image (0..n), wizard (0..n), criteria (0..n), button (0..n), avatar (0..n), message (0..n), text (0..n), widget (0..n), chart (0..n), javascript (0..n), include (0..n), dialog (0..n), side-panel (0..n), popover (0..n), info (0..n), info-button (0..n), info-criteria (0..n), menu-container (0..n), frame (0..n), view (0..n), tag-list (0..n), dependency (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
idnameEnumyesIdentifier of the card, unique in the screen. Actions (filter) and dependencies address the card with it.
stylestringnoCSS classes of the card, separated by spaces (for example awe-card-wide to take two columns of an awe-card-grid). The query never overrides it.
initial-loadenum, query, valuenoHow the component gets its data when the screen is built. query runs the target query, enum reads the target enumerated, and value runs the target and uses the first row to fill the selected value (for a criterion this overrides the value from variable, session, property and value). A grid only loads data with query.
server-actionserverActionEnum (45 values)noServer action used to load or refresh the component data (for example data). Used together with target-action.
target-actionnameEnumnoName of the target (query, enumerated or maintain) that the server action runs.
maxintegernoNumber of rows requested per page. Default: for a grid, the grid.rows.per.page property (30); for a criterion, the awe.application.component.criteria-rows-per-page property (100).
autorefreshintegernoReloads the component data from the server every this many seconds. 0 or empty means no automatic refresh.
autoloadtrue, falsenoWhen true, the component is reloaded from the server as soon as it is created, after the screen is shown. Default: false.
titlestringnoTitle of the card (a locale key or a text). label is used when there is no title.
labelstringnoTitle of the card when it has no title (a locale key or a text).
subtitlestringnoSecondary text below the title.
iconstringnoIcon shown in a tile at the top right (an icon name of the Icons page: Font Awesome 4 by default, mdi:name or lucide:name). With an icon the delta is shown in the footer; without it, in the header.
icon-tonesuccess, warning, danger, info, neutralnoColour of the icon tile and of the progress bar: success, warning, danger, info or neutral. Default: the primary colour.
chipstringnoStatus chip shown at the top right, before the icon or the delta (a locale key or a text), as a tag with a dot. The query can return it as a field to change the status.
chip-tonesuccess, warning, danger, info, neutralnoTone of the status chip: success, warning, danger, info or neutral. Default: neutral.
valuestringnoMain value. A number is formatted in the language of the user with number-decimals.
unitstringnoUnit or suffix of the value and of the target (%, €, ms...).
number-decimalsintegernoDecimals of the value and of the target when they are numbers. Default: the decimals they have, up to 2. The delta always keeps up to 2 decimals.
deltastringnoChange of the value (for example 4.2), shown as a tag with the trend arrow and its text.
delta-unitstringnoUnit of the change. Default: %.
trendup, down, flatnoDirection of the change: up, down or flat. Default: the sign of the delta (negative down, zero flat, positive up). When it is set, the delta is shown without sign.
good-trendup, downnoDirection that is good news: up (default) or down (error rate, costs, response time). The trend in this direction is shown as success, the opposite as danger and flat as neutral.
tonesuccess, warning, danger, info, neutralnoTone of the change, used as is instead of the one derived from trend and good-trend: success, warning, danger, info or neutral.
captionstringnoText next to the change (for example vs. last month).
targetstringnoTarget of the value. When it is a number, a progress bar shows the value against it.
progress-stylebar, gaugenoHow the progress towards the target is drawn: bar (default) or gauge (a half circle with the percent).
sparklinestringnoSeries of numbers drawn as a sparkline below the value, as a JSON array (for example [93.1,93.8,92.6]). The query can return it as a field.
sparkline-typeline, bar, areanoType of the sparkline: line, area (default) or bar.
descriptionstringnoParagraph below the value and the body.
footerstringnoMuted text at the bottom left of the card.

Type: linkType

Contains: grid (0..n), accordion (0..n), pivot-table (0..n), window (0..n), card (0..n), resizable (0..n), tag (0..n), tab (0..n), video (0..n), map (0..n), link (0..n), image (0..n), wizard (0..n), criteria (0..n), button (0..n), avatar (0..n), message (0..n), text (0..n), widget (0..n), chart (0..n), javascript (0..n), include (0..n), dialog (0..n), side-panel (0..n), popover (0..n), info (0..n), info-button (0..n), info-criteria (0..n), menu-container (0..n), frame (0..n), view (0..n), tag-list (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
idstringnoNot documented yet
labelstringnoNot documented yet
sourcestringnoNot documented yet
stylestringnoNot documented yet
typestringnoNot documented yet
expandiblehorizontal, verticalnoNot documented yet
urlstringnoNot documented yet
iconstringnoIcon (an icon name of the Icons page: Font Awesome 4 by default, mdi:name or lucide:name).
helpstringnoNot documented yet
help-imagestringnoNot documented yet

image​

Type: imageType

Contains: grid (0..n), accordion (0..n), pivot-table (0..n), window (0..n), card (0..n), resizable (0..n), tag (0..n), tab (0..n), video (0..n), map (0..n), link (0..n), image (0..n), wizard (0..n), criteria (0..n), button (0..n), avatar (0..n), message (0..n), text (0..n), widget (0..n), chart (0..n), javascript (0..n), include (0..n), dialog (0..n), side-panel (0..n), popover (0..n), info (0..n), info-button (0..n), info-criteria (0..n), menu-container (0..n), frame (0..n), view (0..n), tag-list (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
idstringnoNot documented yet
labelstringnoNot documented yet
sourcestringnoNot documented yet
stylestringnoNot documented yet
typestringnoNot documented yet
expandiblehorizontal, verticalnoNot documented yet
urlstringnoNot documented yet
alternate-urlstringnoNot documented yet
helpstringnoNot documented yet
help-imagestringnoNot documented yet

javascript​

Deprecated in AWE 5.0 and removed in 6.0: no client engine renders it.

Type: javascriptType

Contains: no child elements

Contained by: screen, accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
idstringyesNot documented yet

dialog​

Type: dialogType

Contains: grid (0..n), accordion (0..n), pivot-table (0..n), window (0..n), card (0..n), resizable (0..n), tag (0..n), tab (0..n), video (0..n), map (0..n), link (0..n), image (0..n), wizard (0..n), criteria (0..n), button (0..n), avatar (0..n), message (0..n), text (0..n), widget (0..n), chart (0..n), javascript (0..n), include (0..n), dialog (0..n), side-panel (0..n), popover (0..n), info (0..n), info-button (0..n), info-criteria (0..n), menu-container (0..n), frame (0..n), view (0..n), tag-list (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
idstringnoNot documented yet
labelstringnoNot documented yet
sourcestringnoNot documented yet
stylestringnoNot documented yet
typestringnoNot documented yet
expandiblehorizontal, verticalnoNot documented yet
modaltrue, falsenoNot documented yet
iconstringnoIcon (an icon name of the Icons page: Font Awesome 4 by default, mdi:name or lucide:name).
helpstringnoNot documented yet
help-imagestringnoNot documented yet
on-closeaccept, rejectnoNot documented yet
deferredtrue, falsenoWhen true, the initial load of the dialog components does not run with the screen: it runs when the dialog is opened for the first time. Default false.

side-panel​

Panel anchored to the left or right edge of the screen, with a header, a scrollable body and an optional footer (a child with style modal-footer). It is opened and closed as a dialog (button-action type dialog, close and close-cancel), it closes with its close button, a click outside or Esc, and it keeps the focus inside while it is open. Supported by both client engines.

Type: sidePanelType

Contains: grid (0..n), accordion (0..n), pivot-table (0..n), window (0..n), card (0..n), resizable (0..n), tag (0..n), tab (0..n), video (0..n), map (0..n), link (0..n), image (0..n), wizard (0..n), criteria (0..n), button (0..n), avatar (0..n), message (0..n), text (0..n), widget (0..n), chart (0..n), javascript (0..n), include (0..n), dialog (0..n), side-panel (0..n), popover (0..n), info (0..n), info-button (0..n), info-criteria (0..n), menu-container (0..n), frame (0..n), view (0..n), tag-list (0..n), header-tag (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
idstringnoNot documented yet
labelstringnoNot documented yet
sourcestringnoNot documented yet
stylestringnoNot documented yet
typestringnoNot documented yet
expandiblehorizontal, verticalnoNot documented yet
modaltrue, falsenoNot documented yet
iconstringnoIcon (an icon name of the Icons page: Font Awesome 4 by default, mdi:name or lucide:name).
helpstringnoNot documented yet
help-imagestringnoNot documented yet
on-closeaccept, rejectnoNot documented yet
deferredtrue, falsenoWhen true, the initial load of the dialog components does not run with the screen: it runs when the dialog is opened for the first time. Default false.
positionleft, rightnoEdge of the screen the panel is anchored to. Default: right.
max-widthstringnoMaximum width of the panel as a CSS length (480px, 30rem, 50vw...). The panel takes the width of the screen up to this maximum. Default: 40rem.
header-gridstringnoIdentity header: id of a grid of the screen. While exactly one row of that grid is selected, the header of the panel shows that row (a large avatar, a title, a muted subtitle and the header-tag children) instead of the label and the icon; with no row or several rows selected it shows the label and the icon. The header follows the selected row while the panel is open, and the title is the accessible name of the panel. Without it the header does not change. Supported by both client engines.
header-title-fieldstringnoField of the selected row of header-grid with the title of the identity header (for example the full name).
header-subtitle-fieldstringnoField of the selected row of header-grid with the subtitle of the identity header, shown muted under the title. Not shown when empty.
header-avatar-fieldstringnoField of the selected row of header-grid the avatar of the identity header is built from: its initials (the first letter of its first and last words), as the avatar-field of a grid column. Decorative. No avatar when it is empty.
header-avatar-tone-fieldstringnoField of the selected row of header-grid with the tone of the avatar: primary, info, success, warning, danger or neutral (any other value, or none, is neutral).

popover​

Floating container anchored to the control named in anchor, opened on the side of it set in position (bottom, top, left or right), with a header, a body and an optional footer (a child with style modal-footer). It is opened and closed as a dialog (button-action type dialog, close and close-cancel), it closes with its close button, a click outside or Esc, and it keeps the focus inside while it is open. Supported by both client engines.

Type: popoverType

Contains: grid (0..n), accordion (0..n), pivot-table (0..n), window (0..n), card (0..n), resizable (0..n), tag (0..n), tab (0..n), video (0..n), map (0..n), link (0..n), image (0..n), wizard (0..n), criteria (0..n), button (0..n), avatar (0..n), message (0..n), text (0..n), widget (0..n), chart (0..n), javascript (0..n), include (0..n), dialog (0..n), side-panel (0..n), popover (0..n), info (0..n), info-button (0..n), info-criteria (0..n), menu-container (0..n), frame (0..n), view (0..n), tag-list (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
idstringnoNot documented yet
labelstringnoNot documented yet
sourcestringnoNot documented yet
stylestringnoNot documented yet
typestringnoNot documented yet
expandiblehorizontal, verticalnoNot documented yet
modaltrue, falsenoNot documented yet
iconstringnoIcon (an icon name of the Icons page: Font Awesome 4 by default, mdi:name or lucide:name).
helpstringnoNot documented yet
help-imagestringnoNot documented yet
on-closeaccept, rejectnoNot documented yet
deferredtrue, falsenoWhen true, the initial load of the dialog components does not run with the screen: it runs when the dialog is opened for the first time. Default false.
anchorstringyesId of the control of the screen the popover is anchored to.
positionbottom, top, left, rightnoSide of the anchor where the popover opens: bottom, top, left or right. Default: bottom.
max-widthstringnoMaximum width of the popover as a CSS length (320px, 20rem, 30vw...). Default: 20rem.

include​

Type: includeType

Contains: no child elements

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, row-detail, window, resizable, button, info, info-button, avatar, tag-list

AttributeTypeRequiredDefaultDescription
target-screenstringyesNot documented yet
target-sourcestringnoNot documented yet

tab​

Type: tabType

Contains: tabcontainer (0..n), dependency (0..n), context-button (0..n), context-separator (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
idnameEnumyesNot documented yet
initial-loadenum, query, valueyesNot documented yet
target-actionnameEnumyesNot documented yet
stylestringnoNot documented yet
maximizetrue, falsenoNot documented yet
orientationhorizontal, verticalnoNot documented yet

tabcontainer​

Type: tabcontainerType

Contains: grid (0..n), accordion (0..n), pivot-table (0..n), window (0..n), card (0..n), resizable (0..n), tag (0..n), tab (0..n), video (0..n), map (0..n), link (0..n), image (0..n), wizard (0..n), criteria (0..n), button (0..n), avatar (0..n), message (0..n), text (0..n), widget (0..n), chart (0..n), javascript (0..n), include (0..n), dialog (0..n), side-panel (0..n), popover (0..n), info (0..n), info-button (0..n), info-criteria (0..n), menu-container (0..n), frame (0..n), view (0..n), tag-list (0..n)

Contained by: tab

AttributeTypeRequiredDefaultDescription
idstringnoNot documented yet
labelstringnoNot documented yet
sourcestringnoNot documented yet
stylestringnoNot documented yet
typestringnoNot documented yet
expandiblehorizontal, verticalnoNot documented yet
deferredtrue, falsenoWhen true, the initial load of the tab page components does not run with the screen: it runs when the tab page is selected for the first time. Default false.

wizard​

Type: wizardType

Contains: wizard-panel (0..n), dependency (0..n), context-button (0..n), context-separator (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
idnameEnumyesNot documented yet
initial-loadenum, query, valueyesNot documented yet
target-actionnameEnumyesNot documented yet
labelstringnoNot documented yet
stylestringnoNot documented yet
orientationhorizontal, verticalnoNot documented yet

wizard-panel​

Type: elementType

Contains: grid (0..n), accordion (0..n), pivot-table (0..n), window (0..n), card (0..n), resizable (0..n), tag (0..n), tab (0..n), video (0..n), map (0..n), link (0..n), image (0..n), wizard (0..n), criteria (0..n), button (0..n), avatar (0..n), message (0..n), text (0..n), widget (0..n), chart (0..n), javascript (0..n), include (0..n), dialog (0..n), side-panel (0..n), popover (0..n), info (0..n), info-button (0..n), info-criteria (0..n), menu-container (0..n), frame (0..n), view (0..n), tag-list (0..n)

Contained by: wizard

AttributeTypeRequiredDefaultDescription
idstringnoNot documented yet
labelstringnoNot documented yet
sourcestringnoNot documented yet
stylestringnoNot documented yet
typestringnoNot documented yet
expandiblehorizontal, verticalnoNot documented yet

column​

Column of a grid. It names the field of the data list to show and sets how the cell is shown or edited. It can also be placed inside a group-header.

Type: columnType

Contains: dependency (0..n), button-action (0..n)

Contained by: grid, group-header

AttributeTypeRequiredDefaultDescription
namenameEnumyesName of the field of the data list shown in the column. It is also the column identifier. Required.
stylestringnoCSS class applied to the column. AngularJS applies it to the header and the cells; in React plain text cells ignore it and only column components use it.
labelstringnoColumn header text. It is a localization key that is translated.
valuestringnoStatic value of the column. Cell values normally come from the query, so no client engine uses it for plain cells.
componentcolumnComponentType (24 values)noComponent used to show or edit the cell value. Without it the cell shows plain text. The link component only exists in React; progress, image, icon, text-view, button, formatted-text and sparkline are display components. In React the editors of text, textarea, date, time, filtered-calendar, select-multiple, suggest and suggest-multiple only appear while a row is being edited; otherwise the cell is plain text.
iconstringnoIcon shown in the cell (an icon name of the Icons page: Font Awesome 4 by default, mdi:name or lucide:name). Used by text-view and button columns; an icon or unit sent in the cell data overrides it.
titlestringnoTooltip of the buttons of a button column (a locale key); a title sent in the cell data overrides it. A cell button without label shows only its icon and the title is its accessible name. Supported by both client engines.
unitstringnoUnit text shown to the right of the cell value (text-view, numeric and text cells). A unit sent in the cell data overrides it.
typestring, integer, float, date, booleannoType of the data of the column, used when printing so exported cells get the right format. It is not used for sorting or filtering. An invalid value makes the report fail.
server-actionserverActionEnum (45 values)noServer action that loads the options of the column component (for example the values of a select).
target-actionnameEnumnoQuery or enumerated that provides the options of the column component (select, suggest, radio and button-radio columns).
initial-loadenum, query, valuenoHow the options of the column component are loaded when the screen is built: query, enum or value.
autorefreshintegernoReloads the column options from the server every this many seconds. No client engine applies it specifically to columns.
alignleft, center, rightnoHorizontal alignment of the cell text: left, center or right. The header is always centered. It also sets the alignment in printed reports.
charlengthintegernoColumn width in characters. AngularJS uses it only when width is not set (characters times the character size, 8 pixels by default); React always uses it, as (characters + 4) times 8 pixels, and ignores width. Printed reports use it too.
widthcolumnWidthnoColumn width: a number of pixels, or * to share the free space. AngularJS uses it before charlength and also accepts a percentage (for example 20%), which this schema does not allow and which fails when printing. React ignores it and uses charlength. In reports, * is a fixed width.
wraptrue, falsenoThe text of the cells wraps over several lines and the row grows to fit it, in both client engines. Without it (or with false) the text is one line cut with an ellipsis, as before. In AngularJS the row-height of the grid becomes the minimum row height, and a grid with frozen columns keeps its single-line rows. Default: false.
max-linespositiveIntegernoMaximum number of lines of a wrapping cell; it implies wrap unless wrap is false. Line N ends in an ellipsis when the text is longer, and the full text shows on hover and on keyboard focus.
secondary-fieldstringnoName of another field of the row whose value is shown under the main value, smaller and muted. An empty secondary value shows only the main line. Sorting, filtering and export use the main value. Combines with plain text and with status-field; ignored in columns with a component.
export-secondarytrue, falsenoPrint and export add a column right after this one with the value of secondary-field, titled with secondary-label (or the column label without it). Default: false.
secondary-labelstringnoLabel (i18n key) of the column that export-secondary adds to print and export. Default: the column label.
status-fieldstringnoName of a field of the row with the tone of the cell: success, warning, danger, info or neutral. The main value is shown as a status, a dot plus the text, so the tone never relies on colour alone. An unknown or empty tone is neutral. Ignored with chips="true" and in columns with a component.
chipstrue, falsenoThe main value is split by chip-separator and each item, trimmed and not empty, is shown as a chip. Takes precedence over status-field; ignored in columns with a component. Default: false.
chip-separatorstringnoText that separates the items of a chips column. Default: , (comma).
max-chipspositiveIntegernoMaximum number of chips of a chips column. The first N chips are shown plus a +n chip whose tooltip and accessible label list the hidden items. Default: all the chips.
avatar-fieldstringnoName of a field of the row with the name (or the initials) the avatar is built from. The cell shows a small round avatar with its initials (the first letter of its first and its last word that start with a letter, in upper case) before the main value and its secondary line. An empty value shows no avatar. The avatar is decorative: sorting, filtering, print and export use the main value. Ignored in columns with a component.
avatar-tone-fieldstringnoName of a field of the row with the tone of the avatar: primary, info, success, warning, danger or neutral. An unknown or empty tone is neutral. Only with avatar-field.
icon-fieldstringnoName of a field of the row with an icon (lucide:name, fa-name...) shown before the main value. With status-field the icon takes the place of the dot, so the status is a plain tag (a row without icon shows the tag without dot nor icon). The icon is decorative: the main value is the accessible text, and sorting, filtering, print and export use it. Ignored with chips="true" and in columns with a component.
sort-fieldstringnoField used to sort the column. Default: the column name.
hiddentrue, falsenoHides the column. Hidden columns are still sent to the server and can be printed with printable. Default: false.
visibletrue, falsenoNot applied: the initial visibility of a column is the opposite of hidden, so visible=false has no effect on its own. Dependencies can still change the visibility at run time.
sortabletrue, falsenoAllows sorting by the column. Default: true.
movabletrue, falsenoStored by the model but not applied: neither client engine uses it to allow or forbid moving the column. Default: true.
sendabletrue, falsenoSends the column values to the server (and to the print request). A printed column that is not sendable shows empty cells. Default: true.
optionaltrue, falsenoFor select and suggest column components, allows clearing the value. Default: false.
summary-typestringnoCalculation shown in the grid footer when show-totals is true, and in the group and subtotal rows of a grouped grid (both engines). AngularJS always calculates a sum; React supports sum, avg, max and min and shows nothing for other values.
number-formatstringnoNumber format options (autoNumeric style) of numeric cells and of the footer total. Both engines apply it; React translates only the common options.
validationstringnoValidation rules of the cell (for example required), applied when the cell is editable.
formatterstringnoStored by the model but not used by either client engine or by printing.
format-optionsstringnoStored by the model but not used by either client engine or by printing.
frozentrue, falsenoPins the column on the left so it stays out of the horizontal scroll. Both client engines; do not use it when the header has more than one line. React moves the frozen columns to the left (with the row number and checkbox columns) and keeps single-line rows; it ignores frozen in a grid with grouped headers and in a tree grid. Default: false.
pagebreaktrue, falsenoStored by the model but not used by either client engine or by printing.
sparkline-typeline, bar, areanoDrawing of the series of a sparkline column: line, bar or area. Only the sparkline component reads it. Default: line.
sparkline-colorstringnoCSS colour of the series of a sparkline column (for example #3b82f6 or rgb(59, 130, 246)). A value that is not a plain colour is ignored. Default: blue.
sparkline-negative-colorstringnoCSS colour used for the negative values of a sparkline column: the bars below zero, or the parts of the line and the area that go below zero. Without it negative values use the colour of the series.
sparkline-last-pointtrue, falsenoHighlights the last point of the series of a sparkline column with a dot (line and area) or a dark outline (bar). Default: false.
sparkline-min-maxtrue, falsenoMarks the lowest (red) and highest (green) points of the series of a sparkline column. Default: false.
printabletrue, false, excelnoWhether the column goes to printed reports: true always prints it, even if hidden; excel prints it only in spreadsheet formats (XLSX, CSV); false never prints it. Without it the column is printed only when it is visible on screen. Only the AngularJS engine sends this information; React ignores it and prints the visible columns.
helpstringnoHelp text shown in the column header. AngularJS only.
help-imagestringnoPath of an image shown in the column help. AngularJS only.
check-initialtrue, falsenoStored by the model for suggest cells; neither client engine reads it.
checkedtrue, falsenoCheckbox cells only. Initial checked state. Default: false.
readonlytrue, falsenoPrevents editing the cell when the column has an editable component. Default: false.
maxstringnoMaximum number of rows retrieved for the column options when the column is loaded from a target. Default: the awe.application.component.criteria-rows-per-page property (100).
dialogstringnoStored by the model but not used by either client engine.
show-weekendstrue, falsenoDate cells only. Shows the weekends in the calendar. The AngularJS engine honours it; React ignores it.
strictbooleannoSuggest cells only. When true (the default) the value must be one of the values suggested by the server. AngularJS only.

row-detail​

Detail area of a grid row. A toggle at the start of each row opens it under the row, across the whole width of the grid; several rows can be open and a reload of the data closes them. The detail is either a template or components, never both. Template: its text, where each {name} placeholder is replaced with the field name of the row, also of hidden columns (the label of the cell when it has one); missing fields show nothing. The detail is plain text (HTML is shown as text) and keeps the line breaks. Use CDATA for multi-line templates. Components: a single read-only grid (no editable nor send-operations), inline or through an include whose source contains only that grid. Each open row gets its own instance of the grid, which loads only when the row is opened; its requests send every field of the parent row as [parent grid id].row.[field] (for example GrdProducts.row.id), so a query reads it with a variable of that name. The components of a row detail are not screen components: they cannot have dependencies (the screen fails to load) and cannot be the target of other components. Declare at most one per grid; only the first one is used. Supported by both client engines; tree grids do not show it.

Type: rowDetailType

Contains: grid (0..1), include (0..1)

Contained by: grid

AttributeTypeRequiredDefaultDescription
stylestringnoCSS classes added to the area of the detail, to give it a background, a border or a font. A template itself stays plain text.

quick-filter​

Quick filters of a grid: a group of buttons (a segmented control) at the start of the grid toolbar, one per option, such as All 128 · Locked 3 · Inactive 12. It is a criterion of the screen: its options come from its initial load (a query or an enumerated) with the fields value, label (a localization key), count (optional, shown after the label) and tone (optional, the colour of the count: danger, warning, success or info). Its value is sent with every request of the grid as a variable named like its id, so the query of the grid reads it to filter the rows; the option with an empty value (usually the first one, All) leaves the grid unfiltered. Choosing an option filters the grid with no dependency, and every filter of the grid (a search, a filter after a maintain, choosing an option) reloads the options too, so the counts stay current. The arrow keys move the choice. The toolbar shows it also when the grid hides its toolbar buttons with show-toolbar="false". Declare at most one per grid; only the first one is used. Supported by both client engines.

Type: quickFilterType

Contains: no child elements

Contained by: grid

AttributeTypeRequiredDefaultDescription
idnameEnumyesIdentifier of the quick filter. It is also the name of the parameter that sends its value with the requests of the grid. Required.
initial-loadenum, query, valueyesWhere the options come from: query runs the target query (the usual case, to get the counts) and enum reads the target enumerated. Required.
target-actionnameEnumyesQuery or enumerated that returns the options, one row per option with the fields value, label, count (optional) and tone (optional). The query receives the values of the screen, so its counts can follow the other filters of the grid. Required.
server-actionserverActionEnum (45 values)noServer action that reloads the options. Default: data.
valuestringnoOption chosen when the screen is opened. Default: empty, the option with an empty value (All); with no option of that value the first option is shown as chosen.
labelstringnoAccessible name of the group of buttons, read by screen readers (a localization key). It is not shown. Default: SCREEN_TEXT_FILTERS.

Search field of a grid: a text box with a search icon at the start of the grid toolbar, before the quick filters. It is a text criterion of the screen with no query of its own (no server-action nor target-action): its value is sent with every request of the grid as a variable named like its id, so the query of the grid reads it to filter the rows (usually with a like filter on several fields). Typing filters the grid after a short pause (300 ms); Enter filters it at once, and the clear button or Escape empties it and filters the grid again. As every filter of the grid, a search reloads the quick filter of the grid too, so its counts follow the search. The toolbar shows it also when the grid hides its toolbar buttons with show-toolbar="false". Declare at most one per grid; only the first one is used. Supported by both client engines.

Type: gridSearchType

Contains: no child elements

Contained by: grid

AttributeTypeRequiredDefaultDescription
idnameEnumyesIdentifier of the search. It is also the name of the parameter that sends its value with the requests of the grid. Required.
placeholderstringnoText shown in the empty field, such as "User, name or email…" (a localization key).
labelstringnoAccessible name of the field, read by screen readers (a localization key). It is not shown. Default: BUTTON_SEARCH.
valuestringnoText of the field when the screen is opened. Default: empty, the grid unfiltered.

header-tag​

Tag of the identity header of a side panel (only inside a side-panel with header-grid): a field of the selected row of the header grid shown as a tag after the subtitle, in the order of the XML, with the look of the status cells of a grid (the tone of tone-field and a dot, or the icon of icon-field in place of the dot). A tag whose field is empty in the selected row is not shown. Supported by both client engines.

Type: headerTagType

Contains: no child elements

Contained by: side-panel

AttributeTypeRequiredDefaultDescription
fieldstringyesField of the selected row with the text of the tag. The tag is not shown when it is empty. Required.
tone-fieldstringnoField of the selected row with the tone of the tag: success, warning, danger, info or neutral (any other value, or none, is neutral).
icon-fieldstringnoField of the selected row with the icon of the tag (an icon name of the Icons page). With it the tag is plain: the icon, if the row has one, takes the place of the dot.

group-header​

Second header level that spans over a set of consecutive columns of the grid. The label is shown over the columns it contains, and printed reports keep the grouping.

Type: groupHeaderType

Contains: column (0..n)

Contained by: grid

AttributeTypeRequiredDefaultDescription
namenameEnumyesRequired by the schema, but the model does not read it: the group header position comes from the columns it contains.
labelstringnoText shown over the grouped columns. It is a localization key that is translated. The header spans all the columns it contains, starting at the first one.

window​

Type: windowType

Contains: grid (0..n), accordion (0..n), pivot-table (0..n), window (0..n), card (0..n), resizable (0..n), tag (0..n), tab (0..n), video (0..n), map (0..n), link (0..n), image (0..n), wizard (0..n), criteria (0..n), button (0..n), avatar (0..n), message (0..n), text (0..n), widget (0..n), chart (0..n), javascript (0..n), include (0..n), dialog (0..n), side-panel (0..n), popover (0..n), info (0..n), info-button (0..n), info-criteria (0..n), menu-container (0..n), frame (0..n), view (0..n), tag-list (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
idnameEnumnoNot documented yet
stylestringnoNot documented yet
iconstringnoIcon (an icon name of the Icons page: Font Awesome 4 by default, mdi:name or lucide:name).
labelstringnoNot documented yet
helpstringnoNot documented yet
help-imagestringnoNot documented yet
expandiblehorizontal, verticalnoNot documented yet
maximizetrue, falsenoNot documented yet

resizable​

Type: resizableType

Contains: grid (0..n), accordion (0..n), pivot-table (0..n), window (0..n), card (0..n), resizable (0..n), tag (0..n), tab (0..n), video (0..n), map (0..n), link (0..n), image (0..n), wizard (0..n), criteria (0..n), button (0..n), avatar (0..n), message (0..n), text (0..n), widget (0..n), chart (0..n), javascript (0..n), include (0..n), dialog (0..n), side-panel (0..n), popover (0..n), info (0..n), info-button (0..n), info-criteria (0..n), menu-container (0..n), frame (0..n), view (0..n), tag-list (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
idnameEnumnoNot documented yet
stylestringnoNot documented yet
iconstringnoIcon (an icon name of the Icons page: Font Awesome 4 by default, mdi:name or lucide:name).
labelstringnoNot documented yet
expandiblehorizontal, verticalnoNot documented yet
directionsstringnoNot documented yet

criteria​

Input component (text, select, date, checkbox...) that gets a value from the user and sends it to the server. Its component attribute selects the kind of input. It can contain dependencies and a context menu.

Type: criteriaType

Contains: dependency (0..n), context-button (0..n), context-separator (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
componentcriteriaComponentType (23 values)yesKind of input: hidden, text, numeric, select, suggest, suggest-multiple, select-multiple, picklist, date, time, filtered-calendar, color, textarea, uploader, checkbox, radio, button-checkbox, button-radio, password, text-view or markdown-editor (progress is accepted by the schema but no engine implements it). picklist exists only in the React engine. Required.
labelstringnoText shown above the input. It is a localization key that is translated. A style containing no-label hides it.
stylestringnoCSS classes of the criterion wrapper, usually Bootstrap grid classes such as col-sm-6. React adds col-12 when there is no style.
iconstringnoIcon shown next to the input (an icon name of the Icons page: Font Awesome 4 by default, mdi:name or lucide:name). React does not show it in a textarea.
unitstringnoUnit text shown after the input (text, password, numeric and text-view). React hides it when the slider is shown and in a textarea.
sizestringnoSize of the input: xs, sm, md or lg. Default: md (property awe.component.size).
area-rowsstringnoTextarea only. Number of visible rows. Without it the browser default applies.
placeholderstringnoHint text shown inside an empty input. It is a localization key that is translated.
optionaltrue, falsenoSelect and select-multiple only. When false the first value is selected automatically if nothing is selected; when true an empty value is allowed and the selection can be cleared. Default: false.
valuestringno``Static initial value of the criterion. A comma separated list gives several values. For a checkbox or radio it is the value sent when checked. It has the lowest priority: a screen target, a variable, the stored criteria, the session and the property replace it.
readonlytrue, falsenoDisables the input. Default: false.
variablestringnoName of the screen variable (a parameter sent from another screen) that gives the initial value. It also names the parameter sent to check a suggest value. Used by the server only.
propertystringnoName of an application property whose value is the initial value. Used by the server only.
sessionstringnoName of a session variable whose value is the initial value. Used by the server only.
validationstringnoValidation rules (for example required), separated by spaces. A rule list containing required also marks the criterion as required.
number-formatstringnoNumeric only. Number format options in autoNumeric style (for example min, max, step and precision). AngularJS passes them to autoNumeric; React translates the common options.
show-slidertrue, falsenoNumeric only. Shows a slider below the input. Default: false.
capitalizetrue, falsenoDeclared but not read by any engine or by the server. Default: false.
stricttrue, falsenoSuggest only. When true the value must be one of the values suggested by the server; when false any typed text is accepted. Default: true.
messagestringnoDeclared but not read by any engine or by the server.
printabletrue, false, excelnoWhether the criterion goes to printed reports. Only false excludes it; hidden criteria are never printed. Default: true.
check-emptytrue, falsenoIncludes the criterion in the check that warns when a form is empty. React only looks at the criteria that set it to true; AngularJS ignores the attribute and checks all the top level criteria. Default: false.
check-initialtrue, falsenoDeclared for suggest criteria; neither client engine nor the server reads it.
check-targetstringnoSuggest only. Query used to find the label of the selected value when only the value is known. Default: the target-action.
specificstringnoDeclared but not read by any engine or by the server.
checkedtrue, falsenoCheckbox and radio only. The criterion starts checked. Default: false.
timeoutintegernoSuggest only. Delay in milliseconds before searching after typing. React uses this attribute (300 by default); AngularJS ignores it and uses a global setting.
groupstringnoCheckbox and radio only. Name of the group the criterion belongs to; the group is used in validation and to match the screen target field.
destinationstringnoUploader only. Folder where the uploaded files are stored.
drop-zonetrue, falsenoUploader only. Shows a drop area where files can be dragged and dropped, plus a preview of the selected image. Default is false
captureuser, environmentnoUploader only. Adds a button to take a photo with the device camera (user: front camera, environment: rear camera). Devices without a camera fall back to the file dialog
presetsstringnoQuick presets of a date-range criterion, as a list of codes separated by commas or spaces. Each code is shown as a button that fills the range from the current date: TODAY, YTD (year to date), ALL (clears both dates) or a period back from today, a number followed by D (days), W (weeks), M (months) or Y (years), for instance 7D, 1M, 3M, 12M, 3Y. The label of each preset is the locale DATE_RANGE_PRESET_ plus the code. The active preset is cleared when the dates are edited. Only used by date-range criteria.
helpstringnoHelp text shown in a tooltip next to the label. It is a localization key that is translated.
help-imagestringnoPath of an image shown in the help tooltip.
show-weekendsbooleannoDate criteria only. When false, Saturdays and Sundays cannot be chosen. AngularJS only; React ignores it. Default: true.
show-future-datesbooleannoDate criteria only. When false, dates after the current selected value cannot be chosen. AngularJS only; React ignores it. Default: true.
date-formatstringnoDate criteria only. Date format in bootstrap-datepicker syntax (default dd/mm/yyyy). AngularJS only; React always uses its own fixed format.
date-show-today-buttontrue, falsenoDate criteria only. Shows the button that goes to today. AngularJS only (default: shown); React always shows it.
date-view-modedays, months, yearsnoDate criteria only. Smallest view of the calendar: days, months or years. Default: days. AngularJS only.
left-labelintegernoShows the label to the left of the input, with a width of this many characters. AngularJS only.
visibletrue, falsenoInitial visibility of the criterion. Default: true.
titlestringnoTooltip shown over the input. AngularJS only; React does not use it.
initial-loadenum, query, valuenoHow the component gets its data when the screen is built. query runs the target query, enum reads the target enumerated, and value runs the target and uses the first row to fill the selected value (for a criterion this overrides the value from variable, session, property and value). A grid only loads data with query.
server-actionserverActionEnum (45 values)noServer action used to load or refresh the component data (for example data). Used together with target-action.
target-actionnameEnumnoName of the target (query, enumerated or maintain) that the server action runs.
maxintegernoNumber of rows requested per page. Default: for a grid, the grid.rows.per.page property (30); for a criterion, the awe.application.component.criteria-rows-per-page property (100).
autorefreshintegernoReloads the component data from the server every this many seconds. 0 or empty means no automatic refresh.
autoloadtrue, falsenoWhen true, the component is reloaded from the server as soon as it is created, after the screen is shown. Default: false.
idnameEnumyesNot documented yet

button​

Type: buttonType

Contains: tag (0..n), include (0..n), button-action (0..n), dependency (0..n), context-button (0..n), context-separator (0..n)

Contained by: grid, accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
idnameEnumyesNot documented yet
typestringnoNot documented yet
labelstringnoNot documented yet
stylestringnoNot documented yet
valuestringnoNot documented yet
sizestringnoNot documented yet
button-typesubmit, button, resetnoNot documented yet
iconstringnoIcon (an icon name of the Icons page: Font Awesome 4 by default, mdi:name or lucide:name).
helpstringnoNot documented yet
help-imagestringnoNot documented yet
show-loadingtrue, falsenoBusy state (true by default): when the action launched by the button is still running after a short time, the button shows a spinner instead of its icon until it ends. false turns it off.
selectiontrue, falsenoOnly for the buttons of a grid (false by default). true makes it an action on the selected rows: it is not shown in the footer of the grid but in its selection bar, which appears between the toolbar and the header of the grid while one or more rows are selected, with the number of selected rows and these buttons in the order of the screen, small and at the right. The button keeps all its behaviour (actions, dependencies, confirmations). With style="btn-danger" it is the destructive action (Delete) and is drawn in the danger colour. In a grid without multiselect the bar shows the one selected row. Supported by both client engines.

context-button​

Type: contextButtonType

Contains: context-button (0..n), context-separator (0..n), button-action (0..n), dependency (0..n)

Contained by: grid, pivot-table, tab, wizard, criteria, button, context-button, info-button, info-criteria, widget, chart

AttributeTypeRequiredDefaultDescription
idnameEnumyesNot documented yet
typestringnoNot documented yet
labelstringnoNot documented yet
stylestringnoNot documented yet
valuestringnoNot documented yet
sizestringnoNot documented yet
button-typesubmit, button, resetnoNot documented yet
iconstringnoIcon (an icon name of the Icons page: Font Awesome 4 by default, mdi:name or lucide:name).
helpstringnoNot documented yet
help-imagestringnoNot documented yet

context-separator​

Type: contextSeparatorType

Contains: no child elements

Contained by: grid, pivot-table, tab, wizard, criteria, button, context-button, info-button, info-criteria, widget, chart

AttributeTypeRequiredDefaultDescription
namestringnoNot documented yet

button-action​

Type: actionType

Contains: no child elements

Contained by: column, button, context-button, info, info-button, avatar

AttributeTypeRequiredDefaultDescription
server-actionserverActionEnum (45 values)noNot documented yet
target-actionstringnoNot documented yet
targetstringnoNot documented yet
typebuttonActionEnum (73 values)yesNot documented yet
contextstringnoNot documented yet
silenttrue, falsenoNot documented yet
asynctrue, falsenoNot documented yet
valuestringnoNot documented yet

message​

Type: messageType

Contains: no child elements

Contained by: screen, accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
idstringyesNot documented yet
messagestringyesNot documented yet
titlestringyesNot documented yet

text​

Contains: no child elements

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

Attributes: none

info​

Type: infoType

Contains: dependency (0..n), info-button (0..n), info-criteria (0..n), tag (0..n), include (0..n), info (0..n), button-action (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, info, avatar, tag-list

AttributeTypeRequiredDefaultDescription
initial-loadenum, query, valuenoHow the component gets its data when the screen is built. query runs the target query, enum reads the target enumerated, and value runs the target and uses the first row to fill the selected value (for a criterion this overrides the value from variable, session, property and value). A grid only loads data with query.
server-actionserverActionEnum (45 values)noServer action used to load or refresh the component data (for example data). Used together with target-action.
target-actionnameEnumnoName of the target (query, enumerated or maintain) that the server action runs.
maxintegernoNumber of rows requested per page. Default: for a grid, the grid.rows.per.page property (30); for a criterion, the awe.application.component.criteria-rows-per-page property (100).
autorefreshintegernoReloads the component data from the server every this many seconds. 0 or empty means no automatic refresh.
autoloadtrue, falsenoWhen true, the component is reloaded from the server as soon as it is created, after the screen is shown. Default: false.
idnameEnumyesNot documented yet
fieldstringnoNot documented yet
titlestringnoNot documented yet
labelstringnoNot documented yet
namestringnoNot documented yet
stylestringnoNot documented yet
dropdown-stylestringnoNot documented yet
iconstringnoIcon (an icon name of the Icons page: Font Awesome 4 by default, mdi:name or lucide:name).
sessionstringnoNot documented yet
valuestringnoNot documented yet
propertystringnoNot documented yet
unitstringnoNot documented yet

info-button​

Type: infoButtonType

Contains: tag (0..n), include (0..n), button-action (0..n), dependency (0..n), context-button (0..n), context-separator (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, info, avatar, tag-list

AttributeTypeRequiredDefaultDescription
idnameEnumyesNot documented yet
typestringnoNot documented yet
labelstringnoNot documented yet
stylestringnoNot documented yet
valuestringnoNot documented yet
sizestringnoNot documented yet
button-typesubmit, button, resetnoNot documented yet
iconstringnoIcon (an icon name of the Icons page: Font Awesome 4 by default, mdi:name or lucide:name).
helpstringnoNot documented yet
help-imagestringnoNot documented yet
show-loadingtrue, falsenoBusy state (true by default): when the action launched by the button is still running after a short time, the button shows a spinner instead of its icon until it ends. false turns it off.
selectiontrue, falsenoOnly for the buttons of a grid (false by default). true makes it an action on the selected rows: it is not shown in the footer of the grid but in its selection bar, which appears between the toolbar and the header of the grid while one or more rows are selected, with the number of selected rows and these buttons in the order of the screen, small and at the right. The button keeps all its behaviour (actions, dependencies, confirmations). With style="btn-danger" it is the destructive action (Delete) and is drawn in the danger colour. In a grid without multiselect the bar shows the one selected row. Supported by both client engines.
titlestringnoNot documented yet
info-stylestringnoNot documented yet
unitstringnoNot documented yet

info-criteria​

Type: infoCriteriaType

Contains: dependency (0..n), context-button (0..n), context-separator (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, info, avatar, tag-list

AttributeTypeRequiredDefaultDescription
componentcriteriaComponentType (23 values)yesKind of input: hidden, text, numeric, select, suggest, suggest-multiple, select-multiple, picklist, date, time, filtered-calendar, color, textarea, uploader, checkbox, radio, button-checkbox, button-radio, password, text-view or markdown-editor (progress is accepted by the schema but no engine implements it). picklist exists only in the React engine. Required.
labelstringnoText shown above the input. It is a localization key that is translated. A style containing no-label hides it.
stylestringnoCSS classes of the criterion wrapper, usually Bootstrap grid classes such as col-sm-6. React adds col-12 when there is no style.
iconstringnoIcon shown next to the input (an icon name of the Icons page: Font Awesome 4 by default, mdi:name or lucide:name). React does not show it in a textarea.
unitstringnoUnit text shown after the input (text, password, numeric and text-view). React hides it when the slider is shown and in a textarea.
sizestringnoSize of the input: xs, sm, md or lg. Default: md (property awe.component.size).
area-rowsstringnoTextarea only. Number of visible rows. Without it the browser default applies.
placeholderstringnoHint text shown inside an empty input. It is a localization key that is translated.
optionaltrue, falsenoSelect and select-multiple only. When false the first value is selected automatically if nothing is selected; when true an empty value is allowed and the selection can be cleared. Default: false.
valuestringno``Static initial value of the criterion. A comma separated list gives several values. For a checkbox or radio it is the value sent when checked. It has the lowest priority: a screen target, a variable, the stored criteria, the session and the property replace it.
readonlytrue, falsenoDisables the input. Default: false.
variablestringnoName of the screen variable (a parameter sent from another screen) that gives the initial value. It also names the parameter sent to check a suggest value. Used by the server only.
propertystringnoName of an application property whose value is the initial value. Used by the server only.
sessionstringnoName of a session variable whose value is the initial value. Used by the server only.
validationstringnoValidation rules (for example required), separated by spaces. A rule list containing required also marks the criterion as required.
number-formatstringnoNumeric only. Number format options in autoNumeric style (for example min, max, step and precision). AngularJS passes them to autoNumeric; React translates the common options.
show-slidertrue, falsenoNumeric only. Shows a slider below the input. Default: false.
capitalizetrue, falsenoDeclared but not read by any engine or by the server. Default: false.
stricttrue, falsenoSuggest only. When true the value must be one of the values suggested by the server; when false any typed text is accepted. Default: true.
messagestringnoDeclared but not read by any engine or by the server.
printabletrue, false, excelnoWhether the criterion goes to printed reports. Only false excludes it; hidden criteria are never printed. Default: true.
check-emptytrue, falsenoIncludes the criterion in the check that warns when a form is empty. React only looks at the criteria that set it to true; AngularJS ignores the attribute and checks all the top level criteria. Default: false.
check-initialtrue, falsenoDeclared for suggest criteria; neither client engine nor the server reads it.
check-targetstringnoSuggest only. Query used to find the label of the selected value when only the value is known. Default: the target-action.
specificstringnoDeclared but not read by any engine or by the server.
checkedtrue, falsenoCheckbox and radio only. The criterion starts checked. Default: false.
timeoutintegernoSuggest only. Delay in milliseconds before searching after typing. React uses this attribute (300 by default); AngularJS ignores it and uses a global setting.
groupstringnoCheckbox and radio only. Name of the group the criterion belongs to; the group is used in validation and to match the screen target field.
destinationstringnoUploader only. Folder where the uploaded files are stored.
drop-zonetrue, falsenoUploader only. Shows a drop area where files can be dragged and dropped, plus a preview of the selected image. Default is false
captureuser, environmentnoUploader only. Adds a button to take a photo with the device camera (user: front camera, environment: rear camera). Devices without a camera fall back to the file dialog
presetsstringnoQuick presets of a date-range criterion, as a list of codes separated by commas or spaces. Each code is shown as a button that fills the range from the current date: TODAY, YTD (year to date), ALL (clears both dates) or a period back from today, a number followed by D (days), W (weeks), M (months) or Y (years), for instance 7D, 1M, 3M, 12M, 3Y. The label of each preset is the locale DATE_RANGE_PRESET_ plus the code. The active preset is cleared when the dates are edited. Only used by date-range criteria.
helpstringnoHelp text shown in a tooltip next to the label. It is a localization key that is translated.
help-imagestringnoPath of an image shown in the help tooltip.
show-weekendsbooleannoDate criteria only. When false, Saturdays and Sundays cannot be chosen. AngularJS only; React ignores it. Default: true.
show-future-datesbooleannoDate criteria only. When false, dates after the current selected value cannot be chosen. AngularJS only; React ignores it. Default: true.
date-formatstringnoDate criteria only. Date format in bootstrap-datepicker syntax (default dd/mm/yyyy). AngularJS only; React always uses its own fixed format.
date-show-today-buttontrue, falsenoDate criteria only. Shows the button that goes to today. AngularJS only (default: shown); React always shows it.
date-view-modedays, months, yearsnoDate criteria only. Smallest view of the calendar: days, months or years. Default: days. AngularJS only.
left-labelintegernoShows the label to the left of the input, with a width of this many characters. AngularJS only.
visibletrue, falsenoInitial visibility of the criterion. Default: true.
titlestringnoTooltip shown over the input. AngularJS only; React does not use it.
initial-loadenum, query, valuenoHow the component gets its data when the screen is built. query runs the target query, enum reads the target enumerated, and value runs the target and uses the first row to fill the selected value (for a criterion this overrides the value from variable, session, property and value). A grid only loads data with query.
server-actionserverActionEnum (45 values)noServer action used to load or refresh the component data (for example data). Used together with target-action.
target-actionnameEnumnoName of the target (query, enumerated or maintain) that the server action runs.
maxintegernoNumber of rows requested per page. Default: for a grid, the grid.rows.per.page property (30); for a criterion, the awe.application.component.criteria-rows-per-page property (100).
autorefreshintegernoReloads the component data from the server every this many seconds. 0 or empty means no automatic refresh.
autoloadtrue, falsenoWhen true, the component is reloaded from the server as soon as it is created, after the screen is shown. Default: false.
idnameEnumyesNot documented yet
info-stylestringnoNot documented yet

avatar​

Type: avatarType

Contains: info (0..n), info-button (0..n), info-criteria (0..n), tag (0..n), include (0..n), button-action (0..n), dependency (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
initial-loadenum, query, valuenoHow the component gets its data when the screen is built. query runs the target query, enum reads the target enumerated, and value runs the target and uses the first row to fill the selected value (for a criterion this overrides the value from variable, session, property and value). A grid only loads data with query.
server-actionserverActionEnum (45 values)noServer action used to load or refresh the component data (for example data). Used together with target-action.
target-actionnameEnumnoName of the target (query, enumerated or maintain) that the server action runs.
maxintegernoNumber of rows requested per page. Default: for a grid, the grid.rows.per.page property (30); for a criterion, the awe.application.component.criteria-rows-per-page property (100).
autorefreshintegernoReloads the component data from the server every this many seconds. 0 or empty means no automatic refresh.
autoloadtrue, falsenoWhen true, the component is reloaded from the server as soon as it is created, after the screen is shown. Default: false.
idnameEnumyesNot documented yet
typestringnoNot documented yet
labelstringnoNot documented yet
stylestringnoNot documented yet
valuestringnoNot documented yet
sizestringnoNot documented yet
button-typesubmit, button, resetnoNot documented yet
iconstringnoIcon (an icon name of the Icons page: Font Awesome 4 by default, mdi:name or lucide:name).
helpstringnoNot documented yet
help-imagestringnoNot documented yet
imagestringnoNot documented yet
show-labeltrue, falsenoNot documented yet
unitstringnoNot documented yet

menu-container​

Type: menuContainerType

Contains: no child elements

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
idstringnoNot documented yet
typehorizontal, verticalnoNot documented yet
stylestringnoNot documented yet

frame​

Deprecated in AWE 5.0 and removed in 6.0: no client engine renders it.

Type: frameType

Contains: no child elements

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
namestringnoNot documented yet
screenstringnoNot documented yet
screen-variablestringnoNot documented yet
scrollyes, nonoNot documented yet
server-actionserverActionEnum (45 values)noNot documented yet

view​

Type: viewType

Contains: no child elements

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
namestringnoNot documented yet
stylestringnoNot documented yet

dependency​

Type: dependencyType

Contains: dependency-action (0..n), dependency-element (0..n)

Contained by: grid, accordion, pivot-table, map, card, tab, wizard, column, criteria, button, context-button, info, info-button, info-criteria, avatar, widget, chart

AttributeTypeRequiredDefaultDescription
initial-loadenum, query, valuenoHow the component gets its data when the screen is built. query runs the target query, enum reads the target enumerated, and value runs the target and uses the first row to fill the selected value (for a criterion this overrides the value from variable, session, property and value). A grid only loads data with query.
server-actionserverActionEnum (45 values)noServer action used to load or refresh the component data (for example data). Used together with target-action.
target-actionnameEnumnoName of the target (query, enumerated or maintain) that the server action runs.
maxintegernoNumber of rows requested per page. Default: for a grid, the grid.rows.per.page property (30); for a criterion, the awe.application.component.criteria-rows-per-page property (100).
autorefreshintegernoReloads the component data from the server every this many seconds. 0 or empty means no automatic refresh.
autoloadtrue, falsenoWhen true, the component is reloaded from the server as soon as it is created, after the screen is shown. Default: false.
initialtrue, falsenoNot documented yet
inverttrue, falsenoNot documented yet
typeand, ornoNot documented yet
labelstringnoNot documented yet
valuestringnoNot documented yet
formulestringnoNot documented yet
source-typedependencySourceEnum (9 values)noNot documented yet
target-typedependencyTargetEnum (24 values)noNot documented yet
silenttrue, falsenoNot documented yet
asynctrue, falsenoNot documented yet

dependency-action​

Type: actionType

Contains: no child elements

Contained by: dependency

AttributeTypeRequiredDefaultDescription
server-actionserverActionEnum (45 values)noNot documented yet
target-actionstringnoNot documented yet
targetstringnoNot documented yet
typebuttonActionEnum (73 values)yesNot documented yet
contextstringnoNot documented yet
silenttrue, falsenoNot documented yet
asynctrue, falsenoNot documented yet
valuestringnoNot documented yet

dependency-element​

Type: dependencyElementType

Contains: no child elements

Contained by: dependency

AttributeTypeRequiredDefaultDescription
idnameEnumyesNot documented yet
conditiondependencyConditionEnum (11 values)noNot documented yet
valuestringnoNot documented yet
namenameEnumnoNot documented yet
eventeventEnum (20 values)noNot documented yet
optionaltrue, falsenoNot documented yet
canceltrue, falsenoNot documented yet
rowstringnoNot documented yet
id2stringnoNot documented yet
attributecriteriaAttributeEnum (34 values)noNot documented yet
attribute2criteriaAttributeEnum (34 values)noNot documented yet
aliasstringnoNot documented yet
columnnameEnumnoNot documented yet
column2nameEnumnoNot documented yet
viewbase, reportnoNot documented yet
view2base, reportnoNot documented yet
check-changestrue, falsenoNot documented yet

widget​

Type: widgetType

Contains: widget-parameter (0..n), dependency (0..n), context-button (0..n), context-separator (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
initial-loadenum, query, valuenoHow the component gets its data when the screen is built. query runs the target query, enum reads the target enumerated, and value runs the target and uses the first row to fill the selected value (for a criterion this overrides the value from variable, session, property and value). A grid only loads data with query.
server-actionserverActionEnum (45 values)noServer action used to load or refresh the component data (for example data). Used together with target-action.
target-actionnameEnumnoName of the target (query, enumerated or maintain) that the server action runs.
maxintegernoNumber of rows requested per page. Default: for a grid, the grid.rows.per.page property (30); for a criterion, the awe.application.component.criteria-rows-per-page property (100).
autorefreshintegernoReloads the component data from the server every this many seconds. 0 or empty means no automatic refresh.
autoloadtrue, falsenoWhen true, the component is reloaded from the server as soon as it is created, after the screen is shown. Default: false.
typestringnoNot documented yet
componentstringnoNot documented yet
stylestringnoNot documented yet
helpstringnoNot documented yet
help-imagestringnoNot documented yet
visibletrue, falsenoNot documented yet
idnameEnumyesNot documented yet

widget-parameter​

Type: widgetParameterType

Contains: widget-parameter (0..n)

Contained by: widget, widget-parameter

AttributeTypeRequiredDefaultDescription
typewidgetParameterTypeEnum (10 values)yesNot documented yet
valuestringyesNot documented yet
namenameEnumnoNot documented yet

chart​

Type: chartType

Contains: chart-legend (0..n), chart-tooltip (0..n), x-axis (0..n), y-axis (0..n), chart-serie (0..n), chart-parameter (0..n), dependency (0..n), context-button (0..n), context-separator (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
idnameEnumyesNot documented yet
stylestringnoNot documented yet
labelstringnoNot documented yet
subtitlestringnoNot documented yet
typechartTypesEnum (16 values)yesNot documented yet
stock-charttrue, falsenoNot documented yet
invertedtrue, falsenoNot documented yet
stackingnormal, percentnoNot documented yet
enable-data-labelstrue, falsenoNot documented yet
format-data-labelsstringnoNot documented yet
zoom-typexAxis, yAxis, allnoNot documented yet
helpstringnoNot documented yet
help-imagestringnoNot documented yet
icon-loadingloadingIconEnum (14 values)nospinnerNot documented yet
visibletrue, falsenoNot documented yet
initial-loadenum, query, valuenoHow the component gets its data when the screen is built. query runs the target query, enum reads the target enumerated, and value runs the target and uses the first row to fill the selected value (for a criterion this overrides the value from variable, session, property and value). A grid only loads data with query.
server-actionserverActionEnum (45 values)noServer action used to load or refresh the component data (for example data). Used together with target-action.
target-actionnameEnumnoName of the target (query, enumerated or maintain) that the server action runs.
maxintegernoNumber of rows requested per page. Default: for a grid, the grid.rows.per.page property (30); for a criterion, the awe.application.component.criteria-rows-per-page property (100).
autorefreshintegernoReloads the component data from the server every this many seconds. 0 or empty means no automatic refresh.
autoloadtrue, falsenoWhen true, the component is reloaded from the server as soon as it is created, after the screen is shown. Default: false.

chart-legend​

Type: chartLegendType

Contains: chart-parameter (0..n)

Contained by: chart

AttributeTypeRequiredDefaultDescription
enabledtrue, falsenoNot documented yet
layouthorizontal, verticalnoNot documented yet
labelstringnoNot documented yet
border-widthstringnoNot documented yet
alignleft, center, rightnoNot documented yet
verticalAligntop, middle, bottomnoNot documented yet
floatingtrue, falsenoNot documented yet

chart-tooltip​

Type: chartTooltipType

Contains: chart-parameter (0..n)

Contained by: chart

AttributeTypeRequiredDefaultDescription
enabledtrue, falsenoNot documented yet
crosshairsxAxis, yAxis, allnoNot documented yet
number-decimalsstringnoNot documented yet
suffixstringnoNot documented yet
prefixstringnoNot documented yet
point-formatstringnoNot documented yet
date-formatstringnoNot documented yet
sharedtrue, falsenoNot documented yet

x-axis​

Type: chartAxisType

Contains: chart-parameter (0..n)

Contained by: chart

AttributeTypeRequiredDefaultDescription
labelstringnoNot documented yet
label-formatstringnoNot documented yet
formatter-functionformatCurrencyMagnitudenoNot documented yet
label-rotationstringnoNot documented yet
typelinear, datetime, logarithmic, categorynoNot documented yet
tick-intervalstringnoNot documented yet
allow-decimaltrue, falsenoNot documented yet
oppositetrue, falsenoNot documented yet

y-axis​

Type: chartAxisType

Contains: chart-parameter (0..n)

Contained by: chart

AttributeTypeRequiredDefaultDescription
labelstringnoNot documented yet
label-formatstringnoNot documented yet
formatter-functionformatCurrencyMagnitudenoNot documented yet
label-rotationstringnoNot documented yet
typelinear, datetime, logarithmic, categorynoNot documented yet
tick-intervalstringnoNot documented yet
allow-decimaltrue, falsenoNot documented yet
oppositetrue, falsenoNot documented yet

chart-serie​

Type: chartSerieType

Contains: chart-parameter (0..n)

Contained by: chart

AttributeTypeRequiredDefaultDescription
idstringyesNot documented yet
labelstringnoNot documented yet
typeserieTypesEnum (10 values)noNot documented yet
colorstringnoNot documented yet
x-axisstringnoNot documented yet
y-axisstringnoNot documented yet
x-valuestringyesNot documented yet
y-valuestringyesNot documented yet
z-valuestringnoNot documented yet
drilldown-seriestringnoNot documented yet
drilldowntrue, falsenoNot documented yet

chart-parameter​

Type: chartParameterType

Contains: chart-parameter (0..n)

Contained by: chart, chart-legend, chart-tooltip, x-axis, y-axis, chart-serie, chart-parameter

AttributeTypeRequiredDefaultDescription
typechartParameterTypeEnum (9 values)yesNot documented yet
namenameEnumyesNot documented yet
valuestringnoNot documented yet

tag-list​

Type: tagListType

Contains: grid (0..n), accordion (0..n), pivot-table (0..n), window (0..n), card (0..n), resizable (0..n), tag (0..n), tab (0..n), video (0..n), map (0..n), link (0..n), image (0..n), wizard (0..n), criteria (0..n), button (0..n), avatar (0..n), message (0..n), text (0..n), widget (0..n), chart (0..n), javascript (0..n), include (0..n), dialog (0..n), side-panel (0..n), popover (0..n), info (0..n), info-button (0..n), info-criteria (0..n), menu-container (0..n), frame (0..n), view (0..n), tag-list (0..n)

Contained by: accordion-item, tag, video, card, link, image, dialog, side-panel, popover, tabcontainer, wizard-panel, window, resizable, tag-list

AttributeTypeRequiredDefaultDescription
initial-loadenum, query, valuenoHow the component gets its data when the screen is built. query runs the target query, enum reads the target enumerated, and value runs the target and uses the first row to fill the selected value (for a criterion this overrides the value from variable, session, property and value). A grid only loads data with query.
server-actionserverActionEnum (45 values)noServer action used to load or refresh the component data (for example data). Used together with target-action.
target-actionnameEnumnoName of the target (query, enumerated or maintain) that the server action runs.
maxintegernoNumber of rows requested per page. Default: for a grid, the grid.rows.per.page property (30); for a criterion, the awe.application.component.criteria-rows-per-page property (100).
autorefreshintegernoReloads the component data from the server every this many seconds. 0 or empty means no automatic refresh.
autoloadtrue, falsenoWhen true, the component is reloaded from the server as soon as it is created, after the screen is shown. Default: false.
typestringnoNot documented yet
stylestringnoNot documented yet
idstringnoNot documented yet

Simple types​

printableEnum​

Printing mode: true always prints, false never prints, excel prints only in spreadsheet formats.

Base type: string

Allowed values: true, false, excel

captureEnum​

Base type: string

Allowed values: user, environment

viewModeEnum​

Smallest view of a date calendar: days, months or years.

Base type: string

Allowed values: days, months, years

initialLoadEnum​

How a component loads its data when the screen is built: from an enumerated, from a query, or from the first row of a query as a value.

Base type: string

Allowed values: enum, query, value

criteriaAttributeEnum​

Base type: string

Allowed values: visible, value, text, label, unit, editable, required, totalValues, selectedValues, currentRow, prevCurrentRow, nextCurrentRow, prevRowValue, nextRowValue, selectedRowValue, footerValue, selectedRow, prevRow, nextRow, totalRows, selectedRows, hasDataColumn, emptyDataColumn, fullDataColumn, currentRowValue, prevCurrentRowValue, nextCurrentRowValue, modifiedRows, xMin, xMax, yMin, yMax, x, y

eventEnum​

Base type: string

Allowed values: click, open, close, change, select-row, before-save-row, save-row, after-save-row, before-cancel-row, cancel-row, after-cancel-row, delete-row, after-delete-row, add-row, after-add-row, check-records-saved, check-records-generated, check-one-selected, check-some-selected, zoom

dependencyJoinEnum​

Base type: string

Allowed values: and, or

dependencySourceEnum​

Base type: string

Allowed values: none, query, criteria-value, criteria-text, launcher, value, label, formule, reset

dependencyTargetEnum​

Base type: string

Allowed values: none, label, unit, icon, input, specific, show, hide, show-column, hide-column, format-number, chart-options, validate, enable, disable, set-required, set-optional, set-readonly, set-editable, set-visible, set-invisible, enable-autorefresh, disable-autorefresh, attribute

criteriaComponentType​

Kind of input of a criterion. All values are implemented by both engines except picklist (React only) and the deprecated progress (not implemented as a criterion by any engine; it only exists as a grid column).

Base type: string

Allowed values: hidden, text, numeric, select, suggest, suggest-multiple, select-multiple, picklist, date, date-range, time, filtered-calendar, color, progress, textarea, uploader, checkbox, radio, button-checkbox, button-radio, password, text-view, markdown-editor

columnComponentType​

Component of a grid column. Most values reuse the criteria of the same name for editing; radio and button-radio columns show the options of their list in every cell, like a select column. link is React only; formatted-text renders sanitized HTML.

Base type: string

Allowed values: text, numeric, select, suggest, suggest-multiple, select-multiple, date, time, filtered-calendar, color, progress, textarea, uploader, checkbox, radio, button-radio, image, icon, sparkline, password, text-view, button, formatted-text, link

cardTrendEnum​

Base type: string

Allowed values: up, down, flat

cardGoodTrendEnum​

Base type: string

Allowed values: up, down

cardProgressStyleEnum​

Base type: string

Allowed values: bar, gauge

cardToneEnum​

Base type: string

Allowed values: success, warning, danger, info, neutral

videoPreloadValues​

Base type: string

Allowed values: full-video, metadata, none

orientationEnum​

Base type: string

Allowed values: horizontal, vertical

yesNoEnum​

Base type: string

Allowed values: yes, no

buttonTypes​

Base type: string

Allowed values: submit, button, reset

cellDataTypes​

Data type of a column used when printing: string, integer, float, date or boolean.

Base type: string

Allowed values: string, integer, float, date, boolean

chartTypesEnum​

Base type: string

Allowed values: line, spline, column, column_3d, area, areaspline, arearange, areasplinerange, pie, pie_3d, donut, donut_3d, semicircle, mixed, bubble, scatter

serieTypesEnum​

Base type: string

Allowed values: line, column, pie, area, areaspline, arearange, areasplinerange, bar, spline, scatter

chartParameterTypeEnum​

Base type: string

Allowed values: string, integer, long, float, double, boolean, array, object, null

widgetParameterTypeEnum​

Base type: string

Allowed values: label, string, integer, long, double, float, boolean, array, object, null

sparklineTypeEnum​

Drawing of a sparkline column: a connected line, one bar per value (negative values go below the zero line) or a line with the area under it filled.

Base type: string

Allowed values: line, bar, area

alignEnum​

Base type: string

Allowed values: left, center, right

verticalAlignEnum​

Base type: string

Allowed values: top, middle, bottom

axisEnum​

Base type: string

Allowed values: xAxis, yAxis, all

axisTypeEnum​

Base type: string

Allowed values: linear, datetime, logarithmic, category

stackTypeEnum​

Base type: string

Allowed values: normal, percent

formatterFunctionEnum​

Base type: string

Allowed values: formatCurrencyMagnitude

nameEnum​

Base type: token

viewEnum​

Base type: string

Allowed values: base, report

PivotColumnPlacementEnum​

Base type: string

Allowed values: left, right

PivotRowPlacementEnum​

Base type: string

Allowed values: top, bottom

PivotRendererEnum​

Base type: string

Allowed values: Table, Table Barchart, Heatmap, Row Heatmap, Col Heatmap

PivotAggregatorEnum​

Base type: string

Allowed values: Count, Count Unique Values, List Unique Values, Sum, Custom Sum, Integer Sum, Average, Minimum, Maximum, Sum over Sum, 80% Upper Bound, 80% Lower Bound, Sum as Fraction of Total, Sum as Fraction of Rows, Sum as Fraction of Columns, Count as Fraction of Total, Count as Fraction of Rows, Count as Fraction of Columns, Custom Sum, Custom Average, Custom Minimum, Custom Maximum, Custom Sum over Sum, Custom 80% Upper Bound, Custom 80% Lower Bound

PivotSortMethodEnum​

Base type: string

Allowed values: absolute, natural

loadingIconEnum​

Style of the loading indicator of a grid.

Base type: string

Allowed values: spinner, square, circles, carpet, cubes, dots, folding, squarebar, circlebar, icon, custom, none, skeleton, skeleton-dim

dependencyConditionEnum​

Base type: string

Allowed values: eq, ne, contains, not contains, ge, le, gt, lt, in, is empty, is not empty

onCloseEnum​

Base type: string

Allowed values: accept, reject

gridColumnsPanelEnum​

Base type: string

Allowed values: popover, dialog, side-panel

sidePanelPositionEnum​

Base type: string

Allowed values: left, right

popoverPositionEnum​

Base type: string

Allowed values: bottom, top, left, right

columnWidth​

Column width: a number of pixels or * for the free space.

Base type: string

Pattern: ([0-9]+\|\*)