column

Parent: region

Applies whentype = interactiveReport

Plug-in Variants: displayImagetype = displayImage, downloadBlobtype = downloadBlob, hiddentype = hidden, linktype = link, percentGraphtype = percentGraph, plainTexttype = plainText, plainTextBasedOnLovtype = plainTextBasedOnLov, removeHtmltype = removeHtml, richTexttype = richText, rowSelectortype = rowSelector

Children: action

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
columnNamestringYesdata type=string; maxLen=128
typeenumYesdata type=string; lov=PLUGINS
Valid values: displayImage downloadBlob hidden link percentGraph plainText plainTextBasedOnLov removeHtml richText rowSelector

Property Groups:

  • rowSelection
  • heading
  • singleRowView
  • lov
  • layout
  • accessibility
  • settings
  • appearance
  • blobAttributes
  • link
  • columnFormatting
  • source
  • columnFilter
  • advanced
  • genAI
  • enableUsersTo
  • serverSideCondition
  • security
  • help
  • config
  • comments
rowSelection
PropertyTypeRequiredDefault ValueDetails
enableMultiSelectbooleanYestruedata type=boolean
Applies whentype = rowSelector
showSelectAllbooleanYestruedata type=boolean
Applies whentype = rowSelector and enableMultiSelect = true
hideControlbooleanYesfalsedata type=boolean
Applies whentype = rowSelector
currentSelectionPageItemstringNodata type=string; maxLen=255; textCase=UPPER
Applies whentype = rowSelector
rowSelection {
  enableMultiSelect: false
  showSelectAll: false
  hideControl: false
  currentSelectionPageItem: value
}
heading
PropertyTypeRequiredDefault ValueDetails
headingstringYesdata type=string; maxLen=4000
alternativeLabelstringNodata type=string; maxLen=4000
Enter 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.
alignmentenumYesstartdata type=string; lov=STATIC
Valid values: start center end
heading {
  heading: value
  alternativeLabel: value
  alignment: start
}
singleRowView
PropertyTypeRequiredDefault ValueDetails
useColumnHeadingbooleanYestruedata type=boolean
labelstringYesdata type=string; maxLen=4000
Applies whenuseColumnHeading = false
singleRowView {
  useColumnHeading: false
  label: value
}
lov
PropertyTypeRequiredDefault ValueDetails
lovreferenceYesdata type=reference; lov=COMPONENT; references=lov
Applies whentype = plainTextBasedOnLov
lov {
  lov: @component
}
layout
PropertyTypeRequiredDefault ValueDetails
sequencenumberYesdata type=number; maxLen=22
columnAlignmentenumYesstartdata type=string; lov=STATIC
Valid values: start center end
groupreferenceNodata type=reference; lov=COMPONENT; references=columnGroup
layout {
  sequence: 42
  columnAlignment: start
  group: @component
}
accessibility
PropertyTypeRequiredDefault ValueDetails
valueIdentifiesRowbooleanYesfalsedata type=boolean
imageDescriptionstringNodata type=string; maxLen=255
Applies whentype = displayImage
accessibility {
  valueIdentifiesRow: false
  imageDescription: value
}
settings
PropertyTypeRequiredDefault ValueDetails
formatenumYesmarkdowndata type=string; lov=STATIC
Valid values: html markdown
Applies whentype = richText
settings {
  format: html
}
appearance
PropertyTypeRequiredDefault ValueDetails
cssClassesarray of stringsNodata type=string; maxLen=255
Enter CSS classes to apply to each cell in this column. You may add multiple classes by separating them with spaces.
formatMaskstringNodata type=string; maxLen=255
Applies whentype in (plainText)type in (link)type in (removeHtml)
backgroundColorstringNodata type=string; maxLen=255
Applies whentype = percentGraph
foregroundColorstringNodata type=string; maxLen=255
Applies whentype = percentGraph
barWidthintegerNodata type=integer; maxLen=32767
Applies whentype = percentGraph
viewFileAsenumYesattachmentdata type=string; lov=STATIC
Valid values: attachment inline
Applies whentype = downloadBlob
downloadTextstringNodata type=string; maxLen=255
Applies whentype = downloadBlob
appearance {
  cssClasses: [
    value
    value
  ]
  formatMask: value
  backgroundColor: value
  foregroundColor: value
  barWidth: 42
  viewFileAs: attachment
  downloadText: value
}
blobAttributes
PropertyTypeRequiredDefault ValueDetails
tableOwnerstringNodata type=string; maxLen=32767
Applies whentype in (displayImage)type in (downloadBlob)
tableNamestringYesdata type=string; maxLen=32767
Applies whentype in (displayImage)type in (downloadBlob)
blobColumnstringYesdata type=string; maxLen=32767
Applies whentype in (displayImage)type in (downloadBlob)
primaryKeyColumn1stringYesdata type=string; maxLen=32767
Applies whentype in (displayImage)type in (downloadBlob)
primaryKeyColumn2stringNodata type=string; maxLen=32767
Applies whentype in (displayImage)type in (downloadBlob)
mimeTypeColumnstringNodata type=string; maxLen=32767
Applies whentype in (displayImage)type in (downloadBlob)
filenameColumnstringNodata type=string; maxLen=32767
Applies whentype in (displayImage)type in (downloadBlob)
lastUpdatedColumnstringNodata type=string; maxLen=32767
Applies whentype in (displayImage)type in (downloadBlob)
charSetColumnstringNodata type=string; maxLen=32767
Applies whentype = downloadBlob
blobAttributes {
  tableOwner: value
  tableName: value
  blobColumn: value
  primaryKeyColumn1: value
  primaryKeyColumn2: value
  mimeTypeColumn: value
  filenameColumn: value
  lastUpdatedColumn: value
  charSetColumn: value
}
link
PropertyTypeRequiredDefault ValueDetails
targetcomplexNodata type=complex; maxLen=32767
Applies whentype in (link)type in (percentGraph)type in (plainTextBasedOnLov)
linkTextstringYesdata type=string; maxLen=4000
Applies whentype in (link) and target is settype in (percentGraph) and target is settype in (plainTextBasedOnLov) and target is set
linkAttributesstringNodata type=string; maxLen=4000
Applies whentype in (link) and target is settype in (percentGraph) and target is settype in (plainTextBasedOnLov) and 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
PropertyTypeRequiredDefault ValueDetails
htmlExpressionmultiline stringNodata type=multiline string; maxLen=4000
Applies whentype in (plainText)type in (plainTextBasedOnLov)
columnFormatting {
  htmlExpression: ```html
    value
  ```
}
source
PropertyTypeRequiredDefault ValueDetails
primaryKeybooleanYesfalsedata type=boolean
dataTypeenumYesdata type=string; lov=STATIC
Valid values: varchar2 date number clob boolean other
availableOnClientbooleanYesfalsedata type=boolean
Applies whenprimaryKey = false
valueProtectedbooleanYestruedata type=boolean
Applies whenprimaryKey = false and availableOnClient = true
timezoneAwarestringYesNdata type=string; maxLen=32767
Applies whendataType = date
source {
  primaryKey: false
  dataType: varchar2
  availableOnClient: false
  valueProtected: false
  timezoneAware: value
}
columnFilter
PropertyTypeRequiredDefault ValueDetails
typeenumYesdefaultBasedOnColumnTypedata type=string; lov=STATIC
Valid values: none defaultBasedOnColumnType definedLovExactMatch definedLovWordContains namedLovExactMatch namedLovWordContains
namedLovreferenceYesdata type=reference; lov=COMPONENT; references=lov
Applies whentype in (namedLovExactMatch)type in (namedLovWordContains)
sqlQuerymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype in (definedLovExactMatch)type in (definedLovWordContains)
dateRangesenumYesalldata type=string; lov=STATIC
Valid values: all past future
Applies whendataType = date and type = defaultBasedOnColumnType
typeenumYesnamedLovExactMatchdata type=string; lov=STATIC
Valid values: none defaultBasedOnColumnType definedLovExactMatch definedLovWordContains namedLovExactMatch namedLovWordContains
Applies whentype = plainTextBasedOnLov
sqlQuerymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = plainTextBasedOnLov and type in (definedLovExactMatch)type = plainTextBasedOnLov and type in (definedLovWordContains)
columnFilter {
  type: none
  namedLov: @component
  sqlQuery: ```sql
    value
  ```
  dateRanges: all
}
advanced
PropertyTypeRequiredDefault ValueDetails
htmlDomIdstringNodata type=string; maxLen=255
Enter 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.
endUserAliasstringNodata type=string; maxLen=10; textCase=UPPER
advanced {
  htmlDomId: value
  endUserAlias: value
}
genAI
PropertyTypeRequiredDefault ValueDetails
columnContextmultiline stringNodata type=multiline string; maxLen=32767
Applies whennaturalLanguageSupport = true
referenceDataTypeenumNodata type=string; lov=STATIC
Valid values: sharedComponent sqlQuery staticValues
Applies whennaturalLanguageSupport = true
lovreferenceYesdata type=reference; lov=COMPONENT; references=lov
Applies whennaturalLanguageSupport = true and referenceDataType = sharedComponent
sqlQuerymultiline stringYesdata type=multiline string; maxLen=4000
Applies whennaturalLanguageSupport = true and referenceDataType = sqlQuery
staticValuesmultiline stringYesSTATIC:Display1;Return1,Display2;Return2data type=multiline string; maxLen=4000
Applies whennaturalLanguageSupport = true and referenceDataType = staticValues
genAI {
  columnContext: ```
    value
  ```
  referenceDataType: sharedComponent
  lov: @component
  sqlQuery: ```sql
    value
  ```
  staticValues: ```
    value
  ```
}
enableUsersTo
PropertyTypeRequiredDefault ValueDetails
hidebooleanYestruedata type=boolean
sortbooleanYestruedata type=boolean
filterbooleanYestruedata type=boolean
highlightbooleanYestruedata type=boolean
controlBreakbooleanYestruedata type=boolean
aggregatebooleanYestruedata type=boolean
computebooleanYestruedata type=boolean
chartbooleanYestruedata type=boolean
groupBybooleanYestruedata type=boolean
pivotbooleanYestruedata type=boolean
enableUsersTo {
  hide: false
  sort: false
  filter: false
  highlight: false
  controlBreak: false
  aggregate: false
  compute: false
  chart: false
  groupBy: false
  pivot: false
}
serverSideCondition
PropertyTypeRequiredDefault ValueDetails
typeenumNodata type=string; lov=STATIC
Valid 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
sqlQuerymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype in (rowsReturned)type in (noRowsReturned)
languageenumYesplsqldata type=string; lov=STATIC
Valid values: sql plsql javaScript-mle
Applies whentype = expression
sqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = expression and language = sql
plsqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = expression and language = plsql
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = expression and language = javaScript-mle
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql javaScript-mle
Applies whentype = functionBody
plsqlFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = functionBody and language = plsql
javaScriptFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = functionBody and language = javaScript-mle
valuestringYesdata type=string; maxLen=4000
Applies whentype 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)
itemstringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whentype 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)
preferencestringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whentype in (userPreference=value)type in (userPreference!=value)
pageintegerYesdata type=integer; maxLen=4000
Applies whentype in (currentPage=page)type in (currentPage!=page)
pagesarray of integersYesdata type=integer; maxLen=4000
Applies whentype in (currentPageInList)type in (currentPageNotInList)
textstringYesdata type=string; maxLen=4000
Applies whentype in (textIsContainedInItem)type in (textIsContainedInValue)type in (textIsNotContainedInValue)type in (text=value)type in (text!=value)
valuestringYesdata type=string; maxLen=4000
Applies whentype 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)
listarray of stringsYesdata type=string; maxLen=4000
Applies whentype in (itemIsInColonDelimitedList)type in (itemIsNotInColonDelimitedList)
itemstringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whentype = textIsContainedInItem
valuestringYesdata type=string; maxLen=4000
Applies whentype 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
PropertyTypeRequiredDefault ValueDetails
authorizationSchemeenumNodata type=reference; lov=COMPONENT; references=authorization
Valid values: mustNotBePublicUser
escapeSpecialCharsbooleanYestruedata type=boolean
Applies whentype in (plainText)type in (link)type in (hidden)
security {
  authorizationScheme: mustNotBePublicUser
  escapeSpecialChars: false
}
help
PropertyTypeRequiredDefault ValueDetails
helpTextmultiline stringNodata type=multiline string; maxLen=4000
help {
  helpText: ```html
    value
  ```
}
config
PropertyTypeRequiredDefault ValueDetails
buildOptionreferenceNodata type=reference; lov=COMPONENT; references=buildOption
config {
  buildOption: @component
}
comments
PropertyTypeRequiredDefault ValueDetails
commentsmultiline stringNodata type=multiline string; maxLen=4000
comments {
  comments: ```
    value
  ```
}

APEXlang Example

column sample (
    columnName: value
    type: displayImage
    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
        ```
    }
)