facetGroup - APEXlang Reference

`facetGroup`

Parent: region

Applies whentype = facetedSearch

Children: checkbox

Direct Properties:

Property	Type	Required	Default Value	Details
`label`	`string`	Yes		data type=`string`; maxLen=4000 ~Enter the label of the facet group.~

Property Groups:

layout

Property	Type	Required	Default Value	Details
`sequence`	`number`	Yes		data type=`number`; maxLen=22
`maxHeight`	`integer`	No		data type=`integer`; maxLen=32767

layout {
  sequence: 42
  maxHeight: 42
}

appearance

Property	Type	Required	Default Value	Details
`icon`	`string`	No		data type=`string`; maxLen=255 Enter the classes for the icon you want to use to identify this facet. You may add multiple classes by separating them with spaces. If your theme uses Font APEX then review the Universal Theme Sample Application to view available icons and modifiers.
`display`	`enum`	Yes	`inline`	data type=`string`; lov=`STATIC` Valid values: `inline` `addFilterDialog`

appearance {
  icon: value
  display: inline
}

listEntries

Property	Type	Required	Default Value	Details
`computeCounts`	`boolean`	Yes	`true`	data type=`boolean`
`showCounts`	`boolean`	Yes	`true`	data type=`boolean` Applies when`computeCounts = true`
`zeroCountEntries`	`enum`	Yes	`hide`	data type=`string`; lov=`STATIC` Valid values: `hide` `disable` `showLast` Applies when`computeCounts = true`
`sortByTopCounts`	`boolean`	Yes	`true`	data type=`boolean` Applies when`computeCounts = true and showCounts = true`
`showSelectedFirst`	`boolean`	Yes	`false`	data type=`boolean`
`maxDisplayedEntries`	`integer`	No		data type=`integer`; maxLen=32767

listEntries {
  computeCounts: false
  showCounts: false
  zeroCountEntries: hide
  sortByTopCounts: false
  showSelectedFirst: false
  maxDisplayedEntries: 42
}

actionsMenu

Property	Type	Required	Default Value	Details
`chart`	`boolean`	Yes	`true`	data type=`boolean` Applies when`computeCounts = true and display = inline`

actionsMenu {
  chart: false
}

advanced

Property	Type	Required	Default Value	Details
`showChartInitially`	`boolean`	Yes	`false`	data type=`boolean` Applies when`computeCounts = true and display = inline and chart = true`
`collapsible`	`boolean`	Yes	`false`	data type=`boolean` Applies when`display = inline`
`initiallyCollapsed`	`boolean`	Yes	`false`	data type=`boolean` Applies when`display = inline and collapsible = true`
`cssClasses`	`array of strings`	No		data type=`string`; maxLen=255 Applies when`display = inline` Enter classes to add to this facet group. You may add multiple classes by separating them with spaces.
`staticId`	`string`	Yes		data type=`string`; maxLen=255
`combineFilters`	`enum`	Yes	`or`	data type=`string`; lov=`STATIC` Valid values: `or` `and`

advanced {
  showChartInitially: false
  collapsible: false
  initiallyCollapsed: false
  cssClasses: [
    value
    value
  ]
  staticId: value
  combineFilters: or
}

serverSideCondition

Property	Type	Required	Default Value	Details
`type`	`enum`	No		data 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`
`sqlQuery`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type in (rowsReturned)type in (noRowsReturned)`
`language`	`enum`	Yes	`plsql`	data type=`string`; lov=`STATIC` Valid values: `sql` `plsql` `javaScript-mle` Applies when`type = expression`
`sqlExpression`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type = expression and language = sql`
`plsqlExpression`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type = expression and language = plsql`
`javaScriptExpression`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type = expression and language = javaScript-mle`
`language`	`enum`	Yes	`plsql`	data type=`string`; lov=`STATIC` Valid values: `plsql` `javaScript-mle` Applies when`type = functionBody`
`plsqlFunctionBody`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type = functionBody and language = plsql`
`javaScriptFunctionBody`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type = functionBody and language = javaScript-mle`
`value`	`string`	Yes		data type=`string`; maxLen=4000 Applies 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=`UPPER` Applies 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=`UPPER` Applies when`type in (userPreference=value)type in (userPreference!=value)`
`page`	`integer`	Yes		data type=`integer`; maxLen=4000 Applies when`type in (currentPage=page)type in (currentPage!=page)`
`pages`	`array of integers`	Yes		data type=`integer`; maxLen=4000 Applies when`type in (currentPageInList)type in (currentPageNotInList)`
`text`	`string`	Yes		data type=`string`; maxLen=4000 Applies 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=4000 Applies 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=4000 Applies when`type in (itemIsInColonDelimitedList)type in (itemIsNotInColonDelimitedList)`
`item`	`string`	Yes		data type=`string`; maxLen=4000; textCase=`UPPER` Applies when`type = textIsContainedInItem`
`value`	`string`	Yes		data type=`string`; maxLen=4000 Applies 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=`authorization` Valid values: `mustNotBePublicUser`

security {
  authorizationScheme: mustNotBePublicUser
}

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

facetGroup sample (
    label: value
    layout {
        sequence: 42
        maxHeight: 42
    }
    appearance {
        icon: value
        display: inline
    }
    listEntries {
        computeCounts: false
        showCounts: false
        zeroCountEntries: hide
        sortByTopCounts: false
        showSelectedFirst: false
        maxDisplayedEntries: 42
    }
    actionsMenu {
        chart: false
    }
    advanced {
        showChartInitially: false
        collapsible: false
        initiallyCollapsed: false
        cssClasses: [
          value
          value
        ]
        staticId: value
        combineFilters: or
    }
    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
    }
    config {
        buildOption: @component
    }
    comments {
        comments: ```
          value
        ```
    }
)