facet (starRating)

Parent: facet

Applies whentype = starRating

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
namestringYesP#PAGE_ID#_NEWdata type=string; maxLen=255; textCase=UPPER
typeenumYesdata type=string; lov=PLUGINS
Valid values: starRating

Property Groups:

  • settings
  • label
  • lov
  • cascadingLov
  • layout
  • appearance
  • listEntries
  • actionsMenu
  • advanced
  • source
  • multipleValues
  • default
  • dependingOn
  • serverSideCondition
  • security
  • config
  • comments
settings
PropertyTypeRequiredDefault ValueDetails
noOfStarsenumYes5data type=string; maxLen=4000; lov=STATIC
Valid values: 2 3 7 10 1 4 6 9 5 8
useDefaultsbooleanYestruedata type=boolean
iconstringYesfa-stardata type=string; maxLen=4000
Applies whenuse_defaults = N
activeColorstringNodata type=string; maxLen=4000
Applies whenuse_defaults = N
inactiveColorstringNodata type=string; maxLen=4000
Applies whenuse_defaults = N
tooltipstringYes#VALUE#data type=string; maxLen=50
Applies whenuse_defaults = N
showClearButtonbooleanYesfalsedata type=boolean
Applies whenuse_defaults = N
showValuebooleanYesfalsedata type=boolean
Applies whenuse_defaults = N
readOnlyDisplayenumYesstarsdata type=string; maxLen=4000; lov=STATIC
Valid values: singleStarAndValue stars starsAndValue value
Applies whenuse_defaults = N
settings {
  noOfStars: "2"
  useDefaults: false
  icon: value
  activeColor: value
  inactiveColor: value
  tooltip: value
  showClearButton: false
  showValue: false
  readOnlyDisplay: singleStarAndValue
}
label
PropertyTypeRequiredDefault ValueDetails
labelstringNodata type=string; maxLen=4000
Applies whentype supports VISIBLE

Enter the label for the facet. The label displays on the page only if the facet displays. The label for type Search is visually hidden, but available to assistive technology.

showLabelForCurrentFacetbooleanYestruedata type=boolean
Applies whentype supports VISIBLE
label {
  label: value
  showLabelForCurrentFacet: false
}
lov
PropertyTypeRequiredDefault ValueDetails
typeenumNodata type=string; lov=STATIC
Valid values: sharedComponent sqlQuery staticValues functionBody distinctValues
Applies whentype supports LOV
lovreferenceYesdata type=reference; lov=COMPONENT; references=lov
Applies whentype supports LOV and type = sharedComponent
sqlQuerymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports LOV and type = sqlQuery

Enter the SQL query definition to populate this list of values. Generally list of value queries are of the form:

select [displayValue],
       [returnValue]
  from ...
 where ...
 order by ...

Each column selected must have a unique name or alias. Oracle recommends using an alias on any column that includes an SQL expression.

Note: When defining a Popup LOV item type, if you would like to display multiple columns in the popup, you must instead define your List of Values in Shared Components, with the required additional metadata. Inline list of values can only be used to display single columns for Popup LOVs.

staticValuesmultiline stringYesSTATIC:Display1;Return1,Display2;Return2data type=multiline string; maxLen=4000
Applies whentype supports LOV and type = staticValues
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql javaScript-mle
Applies whentype supports LOV and type = functionBody
plsqlFunctionBodymultiline stringYesdata type=multiline string; maxLen=32767
Applies whentype supports LOV and type = functionBody and language = plsql
javaScriptFunctionBodymultiline stringYesdata type=multiline string; maxLen=32767
Applies whentype supports LOV and type = functionBody and language = javaScript-mle
sortDirectionenumYesascdata type=string; lov=STATIC
Valid values: asc desc
Applies whentype supports LOV and type = distinctValues
includeNullOptionbooleanYesfalsedata type=boolean
Applies whentype supports FC_LOV_DISPLAY_NULL and type supports LOV and type is set
nullDisplayValuestringYesdata type=string; maxLen=255
Applies whentype supports FC_LOV_DISPLAY_NULL and type supports LOV and type is set and includeNullOption = true
Enter the text to be displayed within the list NULL option at the top of this list.
lov {
  type: sharedComponent
  lov: @component
  sqlQuery: ```sql
    value
  ```
  staticValues: ```
    value
  ```
  language: plsql
  plsqlFunctionBody: ```plsql
    value
  ```
  javaScriptFunctionBody: ```javascript-mle
    value
  ```
  sortDirection: asc
  includeNullOption: false
  nullDisplayValue: value
}
cascadingLov
PropertyTypeRequiredDefault ValueDetails
parentFacetstringNodata type=string; maxLen=32767; textCase=UPPER
Applies whentype supports LOV and type = sharedComponent
lovColumnstringYesdata type=string; maxLen=128
Applies whentype supports LOV and type = sharedComponent and parentFacet is set
parentRequiredbooleanYestruedata type=boolean
Applies whentype supports LOV and type = sharedComponent and parentFacet is set
cascadingLov {
  parentFacet: value
  lovColumn: value
  parentRequired: false
}
layout
PropertyTypeRequiredDefault ValueDetails
sequencenumberYesdata type=number; maxLen=22
maxHeightintegerNodata type=integer; maxLen=32767
layout {
  sequence: 42
  maxHeight: 42
}
appearance
PropertyTypeRequiredDefault ValueDetails
valuePlaceholderstringNodata type=string; maxLen=255
Applies whentype supports PLACEHOLDER
iconstringNodata 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.

displayenumYesinlinedata type=string; lov=STATIC
Valid values: inline addFilterDialog
formatMaskstringNodata type=string; maxLen=255
Applies whentype supports FORMAT_MASK_DATE and dataType in (date)type supports FORMAT_MASK_DATE and dataType in (timestamp)type supports FORMAT_MASK_DATE and dataType in (timestampWithTimeZone)type supports FORMAT_MASK_DATE and dataType in (timestampWithLocalTimeZone)
appearance {
  valuePlaceholder: value
  icon: value
  display: inline
  formatMask: value
}
listEntries
PropertyTypeRequiredDefault ValueDetails
computeCountsbooleanYestruedata type=boolean
Applies whentype supports FC_HAS_FEEDBACK
showCountsbooleanYestruedata type=boolean
Applies whentype supports FC_HAS_FEEDBACK and computeCounts = true
zeroCountEntriesenumYeshidedata type=string; lov=STATIC
Valid values: hide disable showLast
Applies whentype supports FC_HAS_FEEDBACK and computeCounts = true
sortByTopCountsbooleanYestruedata type=boolean
Applies whentype supports FC_HAS_FEEDBACK and computeCounts = true and showCounts = true and type in (checkboxGroup)type supports FC_HAS_FEEDBACK and computeCounts = true and showCounts = true and type in (radioGroup)
showSelectedFirstbooleanYesfalsedata type=boolean
Applies whentype supports FC_SHOW_SELECTED_FIRST and type supports LOV and type is set
maxDisplayedEntriesintegerNodata type=integer; maxLen=32767
Applies whentype supports FC_SHOW_MORE_COUNT and type supports LOV and type is set
allowToExcludebooleanYestruedata type=boolean
Applies whentype in (checkboxGroup)type in (radioGroup)type in (range)
displayFilterInitiallybooleanYesfalsedata type=boolean
Applies whentype supports FC_FILTER_VALUES and type supports LOV and type is set
listEntries {
  computeCounts: false
  showCounts: false
  zeroCountEntries: hide
  sortByTopCounts: false
  showSelectedFirst: false
  maxDisplayedEntries: 42
  allowToExclude: false
  displayFilterInitially: false
}
actionsMenu
PropertyTypeRequiredDefault ValueDetails
filterbooleanYestruedata type=boolean
Applies whentype supports FC_FILTER_VALUES and type supports LOV and type is set and display = inline
chartbooleanYestruedata type=boolean
Applies whentype supports FC_HAS_FEEDBACK and computeCounts = true and type supports LOV and type is set
actionsMenu {
  filter: false
  chart: false
}
advanced
PropertyTypeRequiredDefault ValueDetails
showChartInitiallybooleanYesfalsedata type=boolean
Applies whentype supports FC_HAS_FEEDBACK and computeCounts = true and type supports LOV and type is set and chart = true and display = inline
collapsiblebooleanYesfalsedata type=boolean
Applies whendisplay = inline
initiallyCollapsedbooleanYesfalsedata type=boolean
Applies whendisplay = inline and collapsible = true
cssClassesarray of stringsNodata type=string; maxLen=255
Applies whendisplay = inline
Enter classes to add to this facet. You may add multiple classes by separating them with spaces.
advanced {
  showChartInitially: false
  collapsible: false
  initiallyCollapsed: false
  cssClasses: [
    value
    value
  ]
}
source
PropertyTypeRequiredDefault ValueDetails
databaseColumnstringYesdata type=string; maxLen=128

Enter the case sensitive database column name used as the source for this facet.

dbColumnsstringNodata type=string; maxLen=4000
Applies whentype = search
dataTypeenumYesvarchar2data type=string; maxLen=128; lov=STATIC
Valid values: varchar2 number date timestamp timestampWithTimeZone timestampWithLocalTimeZone intervalYearToMonth intervalDayToSecond clob blob boolean rowid bfile sdoGeometry
source {
  databaseColumn: value
  dbColumns: value
  dataType: varchar2
}
multipleValues
PropertyTypeRequiredDefault ValueDetails
typeenumNodata type=string; lov=STATIC
Valid values: delimitedList jsonArray
Applies whentype in (checkboxGroup)type in (radioGroup)type in (selectList)
separatorstringYes:data type=string; maxLen=5
Applies whentype in (checkboxGroup) and type = delimitedListtype in (radioGroup) and type = delimitedListtype in (selectList) and type = delimitedList
trimWhitespacebooleanYesfalsedata type=boolean
Applies whentype in (checkboxGroup) and type = delimitedListtype in (radioGroup) and type = delimitedListtype in (selectList) and type = delimitedList
filterCombinationenumYesordata type=string; lov=STATIC
Valid values: or and
Applies whentype in (checkboxGroup) and type is settype in (radioGroup) and type is settype in (selectList) and type is set
multipleValues {
  type: delimitedList
  separator: value
  trimWhitespace: false
  filterCombination: or
}
default
PropertyTypeRequiredDefault ValueDetails
typeenumNodata type=string; lov=STATIC
Valid values: static item sqlQuerySingleValue sqlQueryMultipleValues expression functionBody sequence
Applies whentype supports SOURCE
staticValuemultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = static
itemstringYesdata type=string; maxLen=32767; textCase=UPPER
Applies whentype supports SOURCE and type = item
sqlQuerySingleValuemultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = sqlQuerySingleValue
sqlQueryMultipleValuesmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = sqlQueryMultipleValues
languageenumYesplsqldata type=string; lov=STATIC
Valid values: sql plsql javaScript-mle
Applies whentype supports SOURCE and type = expression
sqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = expression and language = sql
plsqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = expression and language = plsql
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = expression and language = javaScript-mle
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql javaScript-mle
Applies whentype supports SOURCE and type = functionBody
plsqlFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = functionBody and language = plsql
javaScriptFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = functionBody and language = javaScript-mle
sequencestringYesdata type=string; maxLen=128
Applies whentype supports SOURCE and type = sequence
default {
  type: static
  staticValue: ```
    value
  ```
  item: value
  sqlQuerySingleValue: ```sql
    value
  ```
  sqlQueryMultipleValues: ```sql
    value
  ```
  language: sql
  sqlExpression: ```sql
    value
  ```
  plsqlExpression: ```plsql
    value
  ```
  javaScriptExpression: ```javascript-mle
    value
  ```
  plsqlFunctionBody: ```plsql
    value
  ```
  javaScriptFunctionBody: ```javascript-mle
    value
  ```
  sequence: value
}
dependingOn
PropertyTypeRequiredDefault ValueDetails
facetreferenceNodata type=reference; lov=COMPONENT; references=facet
typeenumYesisNotNulldata type=string; lov=STATIC
Valid values: = != inList notInList isNull isNotNull
Applies whenfacet is set
valuestringYesdata type=string; maxLen=4000
Applies whenfacet is set and type in (=)facet is set and type in (!=)
listarray of stringsYesdata type=string; maxLen=4000
Applies whenfacet is set and type in (inList)facet is set and type in (notInList)
dependingOn {
  facet: @component
  type: "="
  value: value
  list: [
    value
    value
  ]
}
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
encryptSessionStatebooleanYestruedata type=boolean
Applies whentype supports ENCRYPT
escapeSpecialCharsbooleanYestruedata type=boolean
Applies whentype supports ESCAPE_OUTPUT
security {
  authorizationScheme: mustNotBePublicUser
  encryptSessionState: false
  escapeSpecialChars: false
}
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

facet sample (
    name: value
    type: starRating
    settings {
        noOfStars: "2"
        useDefaults: false
        icon: value
        activeColor: value
        inactiveColor: value
        tooltip: value
        showClearButton: false
        showValue: false
        readOnlyDisplay: singleStarAndValue
    }
    label {
        label: value
        showLabelForCurrentFacet: false
    }
    lov {
        type: sharedComponent
        lov: @component
        sqlQuery: ```sql
          value
        ```
        staticValues: ```
          value
        ```
        language: plsql
        plsqlFunctionBody: ```plsql
          value
        ```
        javaScriptFunctionBody: ```javascript-mle
          value
        ```
        sortDirection: asc
        includeNullOption: false
        nullDisplayValue: value
    }
    cascadingLov {
        parentFacet: value
        lovColumn: value
        parentRequired: false
    }
    layout {
        sequence: 42
        maxHeight: 42
    }
    appearance {
        valuePlaceholder: value
        icon: value
        display: inline
        formatMask: value
    }
    listEntries {
        computeCounts: false
        showCounts: false
        zeroCountEntries: hide
        sortByTopCounts: false
        showSelectedFirst: false
        maxDisplayedEntries: 42
        allowToExclude: false
        displayFilterInitially: false
    }
    actionsMenu {
        filter: false
        chart: false
    }
    advanced {
        showChartInitially: false
        collapsible: false
        initiallyCollapsed: false
        cssClasses: [
          value
          value
        ]
    }
    source {
        databaseColumn: value
        dbColumns: value
        dataType: varchar2
    }
    multipleValues {
        type: delimitedList
        separator: value
        trimWhitespace: false
        filterCombination: or
    }
    default {
        type: static
        staticValue: ```
          value
        ```
        item: value
        sqlQuerySingleValue: ```sql
          value
        ```
        sqlQueryMultipleValues: ```sql
          value
        ```
        language: sql
        sqlExpression: ```sql
          value
        ```
        plsqlExpression: ```plsql
          value
        ```
        javaScriptExpression: ```javascript-mle
          value
        ```
        plsqlFunctionBody: ```plsql
          value
        ```
        javaScriptFunctionBody: ```javascript-mle
          value
        ```
        sequence: value
    }
    dependingOn {
        facet: @component
        type: "="
        value: value
        list: [
          value
          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 {
        authorizationScheme: mustNotBePublicUser
        encryptSessionState: false
        escapeSpecialChars: false
    }
    config {
        buildOption: @component
    }
    comments {
        comments: ```
          value
        ```
    }
)