views.schema.yml

Same filename and directory in other branches
  1. 9 core/modules/views/config/schema/views.schema.yml
  2. 8.9.x core/modules/views/config/schema/views.schema.yml
  3. 10 core/modules/views/config/schema/views.schema.yml
core/modules/views/config/schema/views.schema.yml

File

core/modules/views/config/schema/views.schema.yml

View source 
  1. # Schema for the configuration files of the Views module.

  2. 

  3. views.settings:

  4.   type: config_object

  5.   label: 'Views settings'

  6.   mapping:

  7.     display_extenders:

  8.       type: sequence

  9.       label: 'Display extenders'

  10.       sequence:

  11.         type: string

  12.         label: 'Display extender'

  13.     sql_signature:

  14.       type: boolean

  15.       label: 'Add Views signature to all SQL queries'

  16.     ui:

  17.       type: mapping

  18.       label: 'UI settings'

  19.       mapping:

  20.         show:

  21.           type: mapping

  22.           label: 'Live preview settings'

  23.           mapping:

  24.             additional_queries:

  25.               type: boolean

  26.               label: 'Show other queries run during render during live preview'

  27.             advanced_column:

  28.               type: boolean

  29.               label: 'Always show advanced display settings'

  30.             default_display:

  31.               type: boolean

  32.               label: 'Always show the default display'

  33.             performance_statistics:

  34.               type: boolean

  35.               label: 'Show performance statistics'

  36.             preview_information:

  37.               type: boolean

  38.               label: 'Show information and statistics about the view during live preview'

  39.             sql_query:

  40.               type: mapping

  41.               label: 'Query settings'

  42.               mapping:

  43.                 enabled:

  44.                   type: boolean

  45.                   label: 'Show the SQL query'

  46.                 where:

  47.                   type: string

  48.                   label: 'Show SQL query'

  49.             display_embed:

  50.               type: boolean

  51.               label: 'Allow embedded displays'

  52.         always_live_preview:

  53.           type: boolean

  54.           label: 'Automatically update preview on changes'

  55.         exposed_filter_any_label:

  56.           type: string

  57.           label: 'Label for "Any" value on non-required single-select exposed filters'

  58.     field_rewrite_elements:

  59.       type: sequence

  60.       label: 'Field rewrite elements'

  61.       sequence:

  62.         type: string

  63.         label: 'Element'

  64. 

  65. views.view.*:

  66.   type: config_entity

  67.   label: 'View'

  68.   mapping:

  69.     id:

  70.       type: machine_name

  71.       label: 'ID'

  72.       constraints:

  73.         Length:

  74.           # View IDs are specifically limited to 128 characters.

  75.           # @see \Drupal\views_ui\ViewAddForm::form()

  76.           max: 128

  77.     label:

  78.       type: required_label

  79.       label: 'Label'

  80.     module:

  81.       type: string

  82.       label: 'Module'

  83.     description:

  84.       type: text

  85.       label: 'Administrative description'

  86.     tag:

  87.       type: string

  88.       label: 'Tag'

  89.     base_table:

  90.       type: string

  91.       label: 'Base table'

  92.     base_field:

  93.       type: string

  94.       label: 'Base field'

  95.     display:

  96.       type: sequence

  97.       label: 'Displays'

  98.       sequence:

  99.         type: mapping

  100.         label: 'Display settings'

  101.         mapping:

  102.           id:

  103.             type: string

  104.             label: 'Machine name'

  105.           display_title:

  106.             type: text

  107.             label: 'Title'

  108.           display_plugin:

  109.             type: string

  110.             label: 'Display plugin'

  111.             constraints:

  112.               PluginExists:

  113.                 manager: plugin.manager.views.display

  114.           position:

  115.             type: integer

  116.             label: 'Position'

  117.           display_options:

  118.             type: views.display.[%parent.display_plugin]

  119.           cache_metadata:

  120.             type: mapping

  121.             label: 'Cache metadata'

  122.             mapping:

  123.               max-age:

  124.                 type: integer

  125.                 label: 'Cache maximum age'

  126.               contexts:

  127.                 type: sequence

  128.                 label: 'Cache contexts'

  129.                 sequence:

  130.                   type: string

  131.               tags:

  132.                 type: sequence

  133.                 label: 'Cache tags'

  134.                 sequence:

  135.                   type: string

  136.               # Deprecated.

  137.               cacheable:

  138.                 type: boolean

  139.                 label: 'Cacheable'

  140. views_block:

  141.   type: block_settings

  142.   label: 'View block'

  143.   mapping:

  144.     views_label:

  145.       type: label

  146.       label: 'Title'

  147.     items_per_page:

  148.       type: string

  149.       label: 'Items per block'

  150. 

  151. block.settings.views_block:*:

  152.   type: views_block

  153. 

  154. block.settings.views_exposed_filter_block:*:

  155.   type: views_block

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.