Use the Ordinal Configuration Property
Many components use the ordinal configuration property to set the order in which elements appear in the component user interface. For example, Tiles uses the ordinal to set the order of tiles, and Item List uses it to set the order of columns.
 |
When using the ordinal property in a custom implementation of a component, do not use the values 0 or 1 as ordinal values. The lowest value that can be used for the ordinal property in this case is 2.
When using the ordinal property in a predefined configuration, it is fine to use the values 0 and 1 as ordinal values.
|
The following is an example of how the ordinal appears in a component configuration:
"items": [
{
"id": "RecurringCost",
"ordinal": 1
},
{
"id": "NonRecurringCost",
"ordinal": 0
},
{
"id": "Category",
"ordinal": 3
},
{
"id": "RequestPriority",
"ordinal": 2
}
]
{
"id": "RecurringCost",
"ordinal": 1
},
{
"id": "NonRecurringCost",
"ordinal": 0
},
{
"id": "Category",
"ordinal": 3
},
{
"id": "RequestPriority",
"ordinal": 2
}
]
The items in the above example appear in the user interface in the order NonRecurringCost, RecurringCost, RequestPriority, Category.
If there are no ordinal values defined in the component configuration, then the items appear according to their order in the configuration. If the order of items is tailored in the tailoring page, then the ordinal values are overridden and the order in the user interface reflects the tailoring.
The following is a list of possible input cases for ordinal values and what is expected in those cases:
|
Case
|
Example of Ordinal Values
|
Behavior in User Interface
|
|---|---|---|
|
Order values are sequential values.
|
0 1 2 3
|
Items appear in order of ordinal values.
|
|
Order values are nonsequential values.
|
2 5 7 8
|
Items appear in order of ordinal values.
|
|
Two items have the same ordinal value.
|
0 1 1 2
|
Items appear in order of ordinal values. Items with the same ordinal value appear according to their order in the configuration.
During runtime, the INFO message is logged to the log file.
|
|
One or more items do not have ordinal values.
|
0 1 [empty] 3
|
Items appear in order of ordinal values. Items without ordinal values appear last. If multiple items do not have ordinal values, they appear at the end, according to their order in the configuration.
During runtime, the INFO message is logged to the log file.
|
|
One or more items have invalid inputs for ordinal values.
Note that negative values are treated as invalid inputs.
|
0 1 “string” 3
|
Items with invalid ordinal values are treated as items that do not have ordinal values. They appear last, and in the case of multiple items with invalid ordinal values they appear according to their order in the configuration.
During runtime, the INFO message is logged to the log file.
|