You are here

Home » API reference » Drupal 8

views.schema.yml in Drupal 8

Same filename and directory in other branches
  1. 9 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.     skip_cache:

  14.       type: boolean

  15.       label: 'Disable views data caching'

  16.     sql_signature:

  17.       type: boolean

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

  19.     ui:

  20.       type: mapping

  21.       label: 'UI settings'

  22.       mapping:

  23.         show:

  24.           type: mapping

  25.           label: 'Live preview settings'

  26.           mapping:

  27.             additional_queries:

  28.               type: boolean

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

  30.             advanced_column:

  31.               type: boolean

  32.               label: 'Always show advanced display settings'

  33.             master_display:

  34.               type: boolean

  35.               label: 'Always show the master (default) display'

  36.             performance_statistics:

  37.               type: boolean

  38.               label: 'Show performance statistics'

  39.             preview_information:

  40.               type: boolean

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

  42.             sql_query:

  43.               type: mapping

  44.               label: 'Query settings'

  45.               mapping:

  46.                 enabled:

  47.                   type: boolean

  48.                   label: 'Show the SQL query'

  49.                 where:

  50.                   type: string

  51.                   label: 'Show SQL query'

  52.             display_embed:

  53.               type: boolean

  54.               label: 'Allow embedded displays'

  55.         always_live_preview:

  56.           type: boolean

  57.           label: 'Automatically update preview on changes'

  58.         exposed_filter_any_label:

  59.           type: string

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

  61.     field_rewrite_elements:

  62.       type: sequence

  63.       label: 'Field rewrite elements'

  64.       sequence:

  65.         type: string

  66.         label: 'Element'

  67. 

  68. views.view.*:

  69.   type: config_entity

  70.   label: 'View'

  71.   mapping:

  72.     id:

  73.       type: string

  74.       label: 'ID'

  75.     label:

  76.       type: label

  77.       label: 'Label'

  78.     module:

  79.       type: string

  80.       label: 'Module'

  81.     description:

  82.       type: text

  83.       label: 'Administrative description'

  84.     tag:

  85.       type: string

  86.       label: 'Tag'

  87.     base_table:

  88.       type: string

  89.       label: 'Base table'

  90.     base_field:

  91.       type: string

  92.       label: 'Base field'

  93.     display:

  94.       type: sequence

  95.       label: 'Displays'

  96.       sequence:

  97.         type: mapping

  98.         label: 'Display settings'

  99.         mapping:

  100.           id:

  101.             type: string

  102.             label: 'Machine name'

  103.           display_title:

  104.             type: text

  105.             label: 'Title'

  106.           display_plugin:

  107.             type: string

  108.             label: 'Display plugin'

  109.           position:

  110.             type: integer

  111.             label: 'Position'

  112.           display_options:

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

  114.           cache_metadata:

  115.             type: mapping

  116.             label: 'Cache metadata'

  117.             mapping:

  118.               max-age:

  119.                 type: integer

  120.                 label: 'Cache maximum age'

  121.               contexts:

  122.                 type: sequence

  123.                 label: 'Cache contexts'

  124.                 sequence:

  125.                   type: string

  126.               tags:

  127.                 type: sequence

  128.                 label: 'Cache tags'

  129.                 sequence:

  130.                   type: string

  131.               # Deprecated.

  132.               cacheable:

  133.                 type: boolean

  134.                 label: 'Cacheable'

  135. views_block:

  136.   type: block_settings

  137.   label: 'View block'

  138.   mapping:

  139.     views_label:

  140.       type: label

  141.       label: 'Title'

  142.     items_per_page:

  143.       type: string

  144.       label: 'Items per block'

  145. 

  146. block.settings.views_block:*:

  147.   type: views_block

  148. 

  149. block.settings.views_exposed_filter_block:*:

  150.   type: views_block