image.schema.yml

Same filename in other branches
  1. 8.9.x core/modules/image/config/schema/image.schema.yml
  2. 10 core/modules/image/config/schema/image.schema.yml
  3. 11.x core/modules/image/config/schema/image.schema.yml
core/modules/image/config/schema/image.schema.yml

File

core/modules/image/config/schema/image.schema.yml

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

  2. 

  3. image.style.*:

  4.   type: config_entity

  5.   label: 'Image style'

  6.   mapping:

  7.     name:

  8.       type: string

  9.     label:

  10.       type: label

  11.       label: 'Label'

  12.     effects:

  13.       type: sequence

  14.       sequence:

  15.         type: mapping

  16.         mapping:

  17.           uuid:

  18.             type: uuid

  19.           id:

  20.             type: string

  21.           weight:

  22.             type: integer

  23.           data:

  24.             type: image.effect.[%parent.id]

  25. 

  26. image.effect.*:

  27.   type: mapping

  28.   label: 'Effect settings'

  29. 

  30. image.effect.image_crop:

  31.   type: image_size

  32.   label: 'Image crop'

  33.   mapping:

  34.     anchor:

  35.       label: 'Anchor'

  36.       type: string

  37. 

  38. image.effect.image_convert:

  39.   type: mapping

  40.   label: 'Convert'

  41.   mapping:

  42.     extension:

  43.       label: 'Extension'

  44.       type: string

  45. 

  46. image.effect.image_resize:

  47.   type: image_size

  48.   label: 'Image resize'

  49. 

  50. image.effect.image_rotate:

  51.   type: mapping

  52.   label: 'Image rotate'

  53.   mapping:

  54.     degrees:

  55.       type: integer

  56.       label: 'Rotation angle'

  57.     bgcolor:

  58.       label: 'Background color'

  59.       type: color_hex

  60.     random:

  61.       type: boolean

  62.       label: 'Randomize'

  63. 

  64. image.effect.image_scale:

  65.   type: image_size

  66.   label: 'Image scale'

  67.   mapping:

  68.     upscale:

  69.       type: boolean

  70.       label: 'Upscale'

  71. 

  72. # The image desaturate effect has no settings.

  73. image.effect.image_desaturate:

  74.   type: sequence

  75. 

  76. image.effect.image_scale_and_crop:

  77.   type: image_size

  78.   label: 'Image scale and crop'

  79.   mapping:

  80.     anchor:

  81.       label: 'Anchor'

  82.       type: string

  83. 

  84. image.settings:

  85.   type: config_object

  86.   mapping:

  87.     preview_image:

  88.       type: string

  89.       label: 'Preview image'

  90.     allow_insecure_derivatives:

  91.       type: boolean

  92.       label: 'Allow insecure image derivatives'

  93.     suppress_itok_output:

  94.       type: boolean

  95.       label: 'Suppress the itok query string for image derivatives'

  96. 

  97. field.storage_settings.image:

  98.   type: field.storage_settings.file

  99.   label: 'Image settings'

  100.   mapping:

  101.     default_image:

  102.       type: field_default_image

  103.       label: 'Default value'

  104. 

  105. field.field_settings.image:

  106.   type: base_file_field_field_settings

  107.   label: 'Image settings'

  108.   mapping:

  109.     max_resolution:

  110.       type: string

  111.       label: 'Maximum image resolution'

  112.     min_resolution:

  113.       type: string

  114.       label: 'Minimum image resolution'

  115.     alt_field:

  116.       type: boolean

  117.       label: 'Enable Alt field'

  118.     alt_field_required:

  119.       type: boolean

  120.       label: 'Alt field required'

  121.     title_field:

  122.       type: boolean

  123.       label: 'Enable Title field'

  124.     title_field_required:

  125.       type: boolean

  126.       label: 'Title field required'

  127.     default_image:

  128.       type: field_default_image

  129.       label: 'Default value'

  130. 

  131. field.value.image:

  132.   type: field_default_image

  133.   label: 'Default value'

  134. 

  135. field.formatter.settings.image:

  136.   type: mapping

  137.   label: 'Image field display format settings'

  138.   mapping:

  139.     image_link:

  140.       type: string

  141.       label: 'Link image to'

  142.     image_style:

  143.       type: string

  144.       label: 'Image style'

  145.     image_loading:

  146.       type: mapping

  147.       label: 'Image loading settings'

  148.       mapping:

  149.         attribute:

  150.           type: string

  151.           label: 'Loading attribute'

  152. 

  153. field.formatter.settings.image_url:

  154.   type: mapping

  155.   label: 'Image URL formatter settings'

  156.   mapping:

  157.     image_style:

  158.       type: string

  159.       label: 'Image style'

  160. 

  161. field.widget.settings.image_image:

  162.   type: mapping

  163.   label: 'Image field display format settings'

  164.   mapping:

  165.     progress_indicator:

  166.       type: string

  167.       label: 'Progress indicator'

  168.     preview_image_style:

  169.       type: string

  170.       label: 'Preview image style'

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