< panel />
View Element Reference
< panel />
This element, along with its child elements controls the presentation of the data retrieved by the <dataSource> element. Each <panel> lays out its data in a format dictated by the panel's attributes.
Note the following:
-
Fields from a panel may be added to a data source as virtual fields; however, there is a problem with caching if you rely on this.
-
Data source caching changes in V2023.02 resulted in a change to the way data sources are located relative to a panel. It will look for the data source:
-
in the same axvw
-
in a file referenced by a panel in the same axvw (including transitively)
-
in a file referenced in any way (including js files) by the same axvw (also transitively)
-
Then, steps 1-3 again, but starting from the task or axvw entered on the URL instead of the panel's axvw.
-
<panel type="form"
id="rm_form" columns="2">
<panel type="grid"
id="rm_report" controlType="reportGrid">
<panel type="grid" id="rm_report" dataSource="roomDS" recordLimit="20">
<panel type="grid" id="userProcessGrid" dataSource="userProcessDS" layoutRegion="row2col1"
selectionEnabled="true" showOnLoad="false" recordLimit="1000">
<panel type="view" id="panel_row3col2" file="ab-ex-part-mdx.axvw" layoutRegion="row3col2" useFrame="true"/>
Enclosing Element:
This tag is a
direct child of a
<view>
or
<tab>
element.
Encloses:
This tag encloses the
<title>
,
<field>
,
<action>
,
<event>
,
<indexField>
, and
<sortField>
child elements.
Attributes
| Attribute | Description | Valid Values | Optional |
|---|---|---|---|
| type |
Specifies how the available data will be presented. Forms allow for the editing of a single record. A panel of type
grid
presents multiple records
as a table. The
html
panel allows HTML to be presented verbatim. The panel type of
view
allows for the inclusion of an external view, specified by the
file
attribute. Note that inclusion of a multi-panel view requires that the
useFrame
attribute of the panel also be set to
true
to avoid conflict between layouts.
|
grid
,
form
drawing
chart
crossTable
,
columnReport
console
tree
hierTree
html
,
view
control
|
No |
| id | Specifies an identifier that may be used as a handle to the panel by other elements such as the command element's panelId attribute, or from JavaScript through DOM functions | a string unique within the view | yes |
| newRecord |
To make the edit form edit a new (not yet existing) record, add the newRecord="true" attribute to the panel, such as:
<panel type="form" ... newRecord="true">
|
yes | |
| dataSource | When multiple dataSources are listed for a view, specifies the dataSource id to be used by the panel | an existing dataSource id | yes |
| layout |
Along with an accompanying
region
attribute, specifies the portion of the multi-panel page the presentation control should occupy
|
an existing layout id | |
| region |
Along with an accompanying
layout
attribute, specifies the portion of the multi-panel page the presentation control should occupy
|
west
,
east
,
north
,
south
,
center
|
yes |
| layoutRegion |
Specifies the id of a layout region to be used by the panel. Layout region ids are generally used in nested layout configurations as a convenience instead of using a
layout
and a
region
attribute
|
a layout region id | yes |
| columns |
When the panel type is
form, columnReport
or
console
, this attribute specifies how many pairs
of label-value columns will be laid out horizontally across the control.
The number of rows will be determined automatically by how
many fields are added to the panel
|
a small integer, defaults to 1. | yes |
| showOnLoad | The panel can automatically load its data when the page is loaded into the browser or, if special scripted loading is required, the loading can be handled programmatically. When the panel is to be loaded programmatically, setting this attribute to false will result in greater efficiency and smoother presentation |
true
or
false
defaulting to
true
|
yes |
| showIndexAndFilterOnLoad |
The global setting in
WEB-INF/config/context/controls/grid/controls-grid.xml
controls whether grid panels display the index and filter bars upon view loading. By default, the filter bar always shows.
<panel type="grid" ... showIndexAndFilterOnLoad="true">
|
This setting can be overwritten per grid panel in AXVW views:
|
yes |
| labelsPosition | When the panel type is form , this attribute specifies whether the panel lays out the field labels to the left of the value, or above the value. |
top
or
left
, defaulting to
left
|
|
| formLabelWidth | When the panel type is form and labelsPosition equals left, this attribute specifies the percentage of width given to labels versus to the field values. When this attribute is not specified, the form is divided into twice the number of the columns attribute and each vertical slice of labels or values is given an equally wide slice. Use this attribute when you would like to give more width to the field label (use a value greater than 50) or more width to the field value (use a value less than 50) than would be given by default | an integer between 0 and 100, defaulting to 50 | yes |
| useParentRestriction | When a panel is opened by another panel -- when a button in one panel is used to open a dialog, when a selection in one tab switches the application to another tab, or when a selection in one frame changes the data in another frame -- the child panel may use the selection in the first panel to filter what data is displayed. Typically, the restriction of the child panel by the parent panel selection is desirable, but sometimes it is not, for example when opening a new record in the child panel with no data is carried over from the parent selection. This attribute allows the parent panel's restriction to be ignored in the child panel |
true
or
false
defaulting to
true
.
|
yes |
| selectionEnabled | When the panel type is grid, and this attribute is set to true, the grid row is highlighted when the user clicks on any link or button in the row |
true
or
false
defaulting to
true
|
yes |
| multipleSelectionEnabled | When the panel type is report, this attribute inserts a column of checkboxes that allow one or more rows to be marked as selected | true or false defaulting to false | yes |
| sortEnabled | Enables or disables the default grid sort in the AXVW. You may want to disable the default grid sort for views that use calculated SQL fields, as the program generates runtime errors if the user attempts to sort records using standard grid sort icons |
true
or
false
. True by default, if the property is not specified
|
yes |
| controlType |
Specifies
a subtype of the presentation control. This attribute is currently
only used when the
panel
is of type
grid
. Normally this would generate a smart search report, but if the simpler
reportGrid
is desired the
controlType
attribute can be set to
reportGrid
|
reportGrid | yes |
| afterRefresh | Specifies the name of a JavaScript function to be called after the panel is refreshed | a name of an available JavaScript function | yes |
| beforeSave | Specifies the name of a JavaScript function to be called before a record in a form is saved | a name of an available JavaScript function | yes |
| beforeDelete | Specifies the name of a JavaScript function to be called before a record in a form is deleted | a name of an available JavaScript function | yes |
| recordLimit |
Specifies a limit on the number of records displayed in a grid. A record limit of
'0'
retrieves all available records
|
any integer | yes |
| useFrame |
Used to wrap a panel's view content inside an IFrame element to prevent conflicts between HTML element names and JavaScript function names. When including a multi-panel view, the
useFrame
attribute must be set to
true
to avoid conflicts between layouts. Can also be used to include an mdx view
|
true
or
false
, defaulting to
false
|
yes |
| file |
Specifies a file name to be included in a panel of
type="view"
|
valid file name | |
| maxCellContentWidth | Used to override the max cell content width. By default, the grid truncates long text to 50 characters, and displays an ellipsis and a tooltip to reveal the full text. Since grid columns can be wide, some space remains unused | ||
| showIndex |
Used in mini-console grid panels. This attribute allows you to show paging, but not show the index. Add the
showIndex=false
to the grid panel, but still use
indexField
|
||
| URL |
You may want to display a web site--such as a web site with latest news headlines, stock quotes, your company's web site--in a panel. Use this option to specify the URL of the web site. For example:
<panel type="view" id="abViewdefURL_urlPanel"
url="https://www.archibus.com" region="center" useFrame="true"/>
|
||
| tabOrder | Tab order for form and console panels: determines how the focus moves from field to field when the user presses the TAB button |
|