You are here

Home » API reference » Facets 8

facets.facet.schema.yml in Facets 8

config/schema/facets.facet.schema.yml

File

config/schema/facets.facet.schema.yml
View source 
  1. facets.facet.*:

  2.   type: config_entity

  3.   label : 'Facet'

  4.   mapping:

  5.     id:

  6.       type: string

  7.       label: 'ID'

  8.     name:

  9.       type: label

  10.       label: Name

  11.     weight:

  12.       type: integer

  13.       label: 'Weight'

  14.     min_count:

  15.       type: integer

  16.       label: 'Minimum count'

  17.     url_alias:

  18.       type: label

  19.       label: 'Name of facet as used in the URL'

  20.     facet_source_id:

  21.       type: string

  22.       label: 'Facet source id'

  23.     field_identifier:

  24.       type: string

  25.       label: 'Field identifier'

  26.     query_operator:

  27.       type: string

  28.       label: 'Query Operator'

  29.     hard_limit:

  30.       type: integer

  31.       label: 'Hard limit'

  32.     exclude:

  33.       type: boolean

  34.       label: 'Exclude'

  35.     use_hierarchy:

  36.       type: boolean

  37.       label: 'Use hierarchy'

  38.     keep_hierarchy_parents_active:

  39.       type: boolean

  40.       label: 'Keep hierarchy parents active'

  41.     expand_hierarchy:

  42.       type: boolean

  43.       label: 'Expand hierarchy'

  44.     enable_parent_when_child_gets_disabled:

  45.       type: boolean

  46.       label: 'Enable parent when child gets disabled'

  47.     widget:

  48.       type: mapping

  49.       label: 'Facet widget'

  50.       mapping:

  51.         type:

  52.           type: string

  53.           label: 'Plugin ID'

  54.         config:

  55.           type: facet.widget.config.[%parent.type]

  56.           label: 'Configuration'

  57.     empty_behavior:

  58.       type: mapping

  59.       label: 'Empty behavior'

  60.       mapping:

  61.         behavior:

  62.           type: string

  63.           label: 'The empty behavior identifier'

  64.         text_format:

  65.           type: string

  66.           label: 'Text format'

  67.         text:

  68.           type: text

  69.           label: 'Text'

  70.     only_visible_when_facet_source_is_visible:

  71.       type: boolean

  72.       label: 'Show this facet only when the facet source is visible.'

  73.     show_only_one_result:

  74.       type: boolean

  75.       label: 'Show only one result'

  76.     show_title:

  77.       type: boolean

  78.       label: 'Show title'

  79.     processor_configs:

  80.       type: sequence

  81.       label: 'Processor settings'

  82.       sequence:

  83.         type: mapping

  84.         label: 'A processor'

  85.         mapping:

  86.           processor_id:

  87.             type: string

  88.             label: 'The plugin ID of the processor'

  89.           weights:

  90.             type: sequence

  91.             label: 'The processor''s weights for the different processing stages'

  92.             sequence:

  93.               type: integer

  94.               label: 'The processor''s weight for this stage'

  95.           settings:

  96.             type: plugin.plugin_configuration.facets_processor.[%parent.processor_id]