column (rowSelector)
Applies when
type = rowSelector| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
columnName | string | Yes | data type=string; maxLen=128 | |
type | enum | Yes | data type=string; lov=PLUGINSValid values: rowSelector |
rowSelection
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
enableMultiSelect | boolean | Yes | true | data type=boolean |
showSelectAll | boolean | Yes | true | data type=booleanApplies when enableMultiSelect = true |
hideControl | boolean | Yes | false | data type=boolean |
currentSelectionPageItem | string | No | data type=string; maxLen=255; textCase=UPPER |
rowSelection {
enableMultiSelect: false
showSelectAll: false
hideControl: false
currentSelectionPageItem: value
}heading
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
heading | string | Yes | data type=string; maxLen=4000 | |
alternativeLabel | string | No | data type=string; maxLen=4000Enter the alternative label to use in dialogs and in various column heading placements.
Use an alternative label when the heading contains extra formatting, such as HTML tags, which do not display properly. | |
alignment | enum | Yes | start | data type=string; lov=STATICValid values: start center end |
heading {
heading: value
alternativeLabel: value
alignment: start
}singleRowView
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
useColumnHeading | boolean | Yes | true | data type=boolean |
label | string | Yes | data type=string; maxLen=4000Applies when useColumnHeading = false |
singleRowView {
useColumnHeading: false
label: value
}lov
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
lov | reference | Yes | data type=reference; lov=COMPONENT; references=lov |
lov {
lov: @component
}layout
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
sequence | number | Yes | data type=number; maxLen=22 | |
columnAlignment | enum | Yes | start | data type=string; lov=STATICValid values: start center end |
group | reference | No | data type=reference; lov=COMPONENT; references=columnGroup |
layout {
sequence: 42
columnAlignment: start
group: @component
}accessibility
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
valueIdentifiesRow | boolean | Yes | false | data type=boolean |
imageDescription | string | No | data type=string; maxLen=255 |
accessibility {
valueIdentifiesRow: false
imageDescription: value
}settings
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
format | enum | Yes | markdown | data type=string; lov=STATICValid values: html markdown |
settings {
format: html
}appearance
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
cssClasses | array of strings | No | data type=string; maxLen=255Enter CSS classes to apply to each cell in this column. You may add multiple classes by separating them with spaces. | |
formatMask | string | No | data type=string; maxLen=255 | |
backgroundColor | string | No | data type=string; maxLen=255 | |
foregroundColor | string | No | data type=string; maxLen=255 | |
barWidth | integer | No | data type=integer; maxLen=32767 | |
viewFileAs | enum | Yes | attachment | data type=string; lov=STATICValid values: attachment inline |
downloadText | string | No | data type=string; maxLen=255 |
appearance {
cssClasses: [
value
value
]
formatMask: value
backgroundColor: value
foregroundColor: value
barWidth: 42
viewFileAs: attachment
downloadText: value
}blobAttributes
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
tableOwner | string | No | data type=string; maxLen=32767 | |
tableName | string | Yes | data type=string; maxLen=32767 | |
blobColumn | string | Yes | data type=string; maxLen=32767 | |
primaryKeyColumn1 | string | Yes | data type=string; maxLen=32767 | |
primaryKeyColumn2 | string | No | data type=string; maxLen=32767 | |
mimeTypeColumn | string | No | data type=string; maxLen=32767 | |
filenameColumn | string | No | data type=string; maxLen=32767 | |
lastUpdatedColumn | string | No | data type=string; maxLen=32767 | |
charSetColumn | string | No | data type=string; maxLen=32767 |
blobAttributes {
tableOwner: value
tableName: value
blobColumn: value
primaryKeyColumn1: value
primaryKeyColumn2: value
mimeTypeColumn: value
filenameColumn: value
lastUpdatedColumn: value
charSetColumn: value
}link
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
target | complex | No | data type=complex; maxLen=32767 | |
linkText | string | Yes | data type=string; maxLen=4000Applies when target is set | |
linkAttributes | string | No | data type=string; maxLen=4000Applies when target is set |
link {
target: {
type: in_app
url: value
app: value
page: value
items: [
value
value
]
clearCache: value
action: value
request: value
anchor: value
session: "&SESSION."
debug: "&DEBUG."
printerFriendly: N
otherArgs: value
}
linkText: value
linkAttributes: value
}columnFormatting
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
htmlExpression | multiline string | No | data type=multiline string; maxLen=4000 |
columnFormatting {
htmlExpression: ```html
value
```
}source
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
primaryKey | boolean | Yes | false | data type=boolean |
dataType | enum | Yes | data type=string; lov=STATICValid values: varchar2 date number clob boolean other | |
availableOnClient | boolean | Yes | false | data type=booleanApplies when primaryKey = false |
valueProtected | boolean | Yes | true | data type=booleanApplies when primaryKey = false and availableOnClient = true |
timezoneAware | string | Yes | N | data type=string; maxLen=32767Applies when dataType = date |
source {
primaryKey: false
dataType: varchar2
availableOnClient: false
valueProtected: false
timezoneAware: value
}columnFilter
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
type | enum | Yes | defaultBasedOnColumnType | data type=string; lov=STATICValid values: none defaultBasedOnColumnType definedLovExactMatch definedLovWordContains namedLovExactMatch namedLovWordContains |
namedLov | reference | Yes | data type=reference; lov=COMPONENT; references=lovApplies when type in (namedLovExactMatch)type in (namedLovWordContains) | |
sqlQuery | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type in (definedLovExactMatch)type in (definedLovWordContains) | |
dateRanges | enum | Yes | all | data type=string; lov=STATICValid values: all past futureApplies when dataType = date and type = defaultBasedOnColumnType |
type | enum | Yes | namedLovExactMatch | data type=string; lov=STATICValid values: none defaultBasedOnColumnType definedLovExactMatch definedLovWordContains namedLovExactMatch namedLovWordContains |
sqlQuery | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type in (definedLovExactMatch)type in (definedLovWordContains) |
columnFilter {
type: none
namedLov: @component
sqlQuery: ```sql
value
```
dateRanges: all
}advanced
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
htmlDomId | string | No | data type=string; maxLen=255Enter the DOM ID for the column. If defined, the DOM ID is used as the ID for the corresponding table header (TH) cell, and as the HEADERS value for corresponding table data (TD) cells. The DOM ID can be useful when developing custom JavaScript behavior, or custom style for the column. If the DOM ID is not defined, the table generates an internal ID for these attribute values. | |
endUserAlias | string | No | data type=string; maxLen=10; textCase=UPPER |
advanced {
htmlDomId: value
endUserAlias: value
}genAI
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
columnContext | multiline string | No | data type=multiline string; maxLen=32767Applies when naturalLanguageSupport = true | |
referenceDataType | enum | No | data type=string; lov=STATICValid values: sharedComponent sqlQuery staticValuesApplies when naturalLanguageSupport = true | |
lov | reference | Yes | data type=reference; lov=COMPONENT; references=lovApplies when naturalLanguageSupport = true and referenceDataType = sharedComponent | |
sqlQuery | multiline string | Yes | data type=multiline string; maxLen=4000Applies when naturalLanguageSupport = true and referenceDataType = sqlQuery | |
staticValues | multiline string | Yes | STATIC:Display1;Return1,Display2;Return2 | data type=multiline string; maxLen=4000Applies when naturalLanguageSupport = true and referenceDataType = staticValues |
genAI {
columnContext: ```
value
```
referenceDataType: sharedComponent
lov: @component
sqlQuery: ```sql
value
```
staticValues: ```
value
```
}enableUsersTo
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
hide | boolean | Yes | true | data type=boolean |
sort | boolean | Yes | true | data type=boolean |
filter | boolean | Yes | true | data type=boolean |
highlight | boolean | Yes | true | data type=boolean |
controlBreak | boolean | Yes | true | data type=boolean |
aggregate | boolean | Yes | true | data type=boolean |
compute | boolean | Yes | true | data type=boolean |
chart | boolean | Yes | true | data type=boolean |
groupBy | boolean | Yes | true | data type=boolean |
pivot | boolean | Yes | true | data type=boolean |
enableUsersTo {
hide: false
sort: false
filter: false
highlight: false
controlBreak: false
aggregate: false
compute: false
chart: false
groupBy: false
pivot: false
}serverSideCondition
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
type | enum | No | data type=string; lov=STATICValid values: always rowsReturned noRowsReturned expression functionBody request=Value request!=Value requestIsContainedInValue requestIsNotContainedInValue item=value item!=value itemIsNull itemIsNotNull itemIsZero itemIsNotZero itemIsNullOrZero itemIsNotNullAndNotZero itemContainsNoSpaces itemIsNumeric itemIsNotNumeric itemIsAlphanumeric itemIsInColonDelimitedList itemIsNotInColonDelimitedList textIsContainedInItem text=value text!=value textIsContainedInValue textIsNotContainedInValue userPreference=value userPreference!=value currentPage=page currentPage!=page currentPageInList currentPageNotInList currentPage=pageSubmitted currentPage!=pageSubmitted currentPageIsInPrinterFriendlyMode currentPageIsNotInPrinterFriendlyMode pageRegionIsReadOnly pageRegionIsNotReadOnly userIsAuthenticated userIsPublicUser inlineValidationErrorsDisplayed inlineValidationErrorsNotDisplayed sqlReportsOkToShowForwardButton sqlReportsOkToShowBackButton currentLanguage=value currentLanguage!=value currentLanguageIsContainedInValue currentLanguageIsNotContainedInValue clientBrowserIsMozilla clientBrowserIsIE7higher clientBrowserIsXhtmlCssCapable clientBrowserIsOther cgiEnvDadName=value cgiEnvDadName!=value cgiEnvServerName=value cgiEnvServerName!=value cgiEnvHttpHost=value cgiEnvHttpHost!=value never | |
sqlQuery | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type in (rowsReturned)type in (noRowsReturned) | |
language | enum | Yes | plsql | data type=string; lov=STATICValid values: sql plsql javaScript-mleApplies when type = expression |
sqlExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = expression and language = sql | |
plsqlExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = expression and language = plsql | |
javaScriptExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = expression and language = javaScript-mle | |
language | enum | Yes | plsql | data type=string; lov=STATICValid values: plsql javaScript-mleApplies when type = functionBody |
plsqlFunctionBody | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = functionBody and language = plsql | |
javaScriptFunctionBody | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = functionBody and language = javaScript-mle | |
value | string | Yes | data type=string; maxLen=4000Applies when type in (request=Value)type in (request!=Value)type in (requestIsContainedInValue)type in (requestIsNotContainedInValue)type in (currentLanguageIsContainedInValue)type in (currentLanguageIsNotContainedInValue)type in (currentLanguage!=value)type in (currentLanguage=value)type in (cgiEnvDadName=value)type in (cgiEnvDadName!=value)type in (cgiEnvServerName=value)type in (cgiEnvServerName!=value)type in (cgiEnvHttpHost=value)type in (cgiEnvHttpHost!=value) | |
item | string | Yes | data type=string; maxLen=4000; textCase=UPPERApplies when type in (item=value)type in (item!=value)type in (VALUE_OF_ITEM_IN_COND_1_EQ_COND_2)type in (VALUE_OF_ITEM_IN_COND_1_NOT_EQ_COND_2)type in (itemIsNull)type in (itemIsNotNull)type in (itemIsZero)type in (itemIsNotZero)type in (itemIsNullOrZero)type in (itemIsNotNullAndNotZero)type in (itemContainsNoSpaces)type in (itemIsNumeric)type in (itemIsNotNumeric)type in (itemIsAlphanumeric)type in (itemIsInColonDelimitedList)type in (itemIsNotInColonDelimitedList) | |
preference | string | Yes | data type=string; maxLen=4000; textCase=UPPERApplies when type in (userPreference=value)type in (userPreference!=value) | |
page | integer | Yes | data type=integer; maxLen=4000Applies when type in (currentPage=page)type in (currentPage!=page) | |
pages | array of integers | Yes | data type=integer; maxLen=4000Applies when type in (currentPageInList)type in (currentPageNotInList) | |
text | string | Yes | data type=string; maxLen=4000Applies when type in (textIsContainedInItem)type in (textIsContainedInValue)type in (textIsNotContainedInValue)type in (text=value)type in (text!=value) | |
value | string | Yes | data type=string; maxLen=4000Applies when type in (item=value)type in (item!=value)type in (VALUE_OF_ITEM_IN_COND_1_EQ_COND_2)type in (VALUE_OF_ITEM_IN_COND_1_NOT_EQ_COND_2) | |
list | array of strings | Yes | data type=string; maxLen=4000Applies when type in (itemIsInColonDelimitedList)type in (itemIsNotInColonDelimitedList) | |
item | string | Yes | data type=string; maxLen=4000; textCase=UPPERApplies when type = textIsContainedInItem | |
value | string | Yes | data type=string; maxLen=4000Applies when type in (textIsContainedInValue)type in (textIsNotContainedInValue)type in (text=value)type in (text!=value) |
serverSideCondition {
type: always
sqlQuery: ```sql
value
```
language: sql
sqlExpression: ```sql
value
```
plsqlExpression: ```plsql
value
```
javaScriptExpression: ```javascript-mle
value
```
plsqlFunctionBody: ```plsql
value
```
javaScriptFunctionBody: ```javascript-mle
value
```
value: value
item: value
preference: value
page: 42
pages: [
42
42
]
text: value
list: [
value
value
]
}security
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
authorizationScheme | enum | No | data type=reference; lov=COMPONENT; references=authorizationValid values: mustNotBePublicUser | |
escapeSpecialChars | boolean | Yes | true | data type=boolean |
security {
authorizationScheme: mustNotBePublicUser
escapeSpecialChars: false
}help
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
helpText | multiline string | No | data type=multiline string; maxLen=4000 |
help {
helpText: ```html
value
```
}config
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
buildOption | reference | No | data type=reference; lov=COMPONENT; references=buildOption |
config {
buildOption: @component
}comments
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
comments | multiline string | No | data type=multiline string; maxLen=4000 |
comments {
comments: ```
value
```
}APEXlang Example
column sample (
columnName: value
type: rowSelector
rowSelection {
enableMultiSelect: false
showSelectAll: false
hideControl: false
currentSelectionPageItem: value
}
heading {
heading: value
alternativeLabel: value
alignment: start
}
singleRowView {
useColumnHeading: false
label: value
}
lov {
lov: @component
}
layout {
sequence: 42
columnAlignment: start
group: @component
}
accessibility {
valueIdentifiesRow: false
imageDescription: value
}
settings {
format: html
}
appearance {
cssClasses: [
value
value
]
formatMask: value
backgroundColor: value
foregroundColor: value
barWidth: 42
viewFileAs: attachment
downloadText: value
}
blobAttributes {
tableOwner: value
tableName: value
blobColumn: value
primaryKeyColumn1: value
primaryKeyColumn2: value
mimeTypeColumn: value
filenameColumn: value
lastUpdatedColumn: value
charSetColumn: value
}
link {
target: {
type: in_app
url: value
app: value
page: value
items: [
value
value
]
clearCache: value
action: value
request: value
anchor: value
session: "&SESSION."
debug: "&DEBUG."
printerFriendly: N
otherArgs: value
}
linkText: value
linkAttributes: value
}
columnFormatting {
htmlExpression: ```html
value
```
}
source {
primaryKey: false
dataType: varchar2
availableOnClient: false
valueProtected: false
timezoneAware: value
}
columnFilter {
type: none
namedLov: @component
sqlQuery: ```sql
value
```
dateRanges: all
}
advanced {
htmlDomId: value
endUserAlias: value
}
genAI {
columnContext: ```
value
```
referenceDataType: sharedComponent
lov: @component
sqlQuery: ```sql
value
```
staticValues: ```
value
```
}
enableUsersTo {
hide: false
sort: false
filter: false
highlight: false
controlBreak: false
aggregate: false
compute: false
chart: false
groupBy: false
pivot: false
}
serverSideCondition {
type: always
sqlQuery: ```sql
value
```
language: sql
sqlExpression: ```sql
value
```
plsqlExpression: ```plsql
value
```
javaScriptExpression: ```javascript-mle
value
```
plsqlFunctionBody: ```plsql
value
```
javaScriptFunctionBody: ```javascript-mle
value
```
value: value
item: value
preference: value
page: 42
pages: [
42
42
]
text: value
list: [
value
value
]
}
security {
authorizationScheme: mustNotBePublicUser
escapeSpecialChars: false
}
help {
helpText: ```html
value
```
}
config {
buildOption: @component
}
comments {
comments: ```
value
```
}
)