image.schema.yml

Same filename in other branches
  1. 9 core/modules/image/config/schema/image.schema.yml
  2. 8.9.x core/modules/image/config/schema/image.schema.yml
  3. 10 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.   constraints:

  7.     FullyValidatable: ~

  8.   mapping:

  9.     name:

  10.       type: machine_name

  11.     label:

  12.       type: required_label

  13.       label: 'Label'

  14.     effects:

  15.       type: sequence

  16.       sequence:

  17.         type: mapping

  18.         mapping:

  19.           uuid:

  20.             type: uuid

  21.           id:

  22.             type: string

  23.             constraints:

  24.               PluginExists:

  25.                 manager: plugin.manager.image.effect

  26.                 interface: 'Drupal\image\ImageEffectInterface'

  27.           weight:

  28.             type: weight

  29.           data:

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

  31. 

  32. image.effect.*:

  33.   type: mapping

  34.   label: 'Effect settings'

  35. 

  36. image.effect.image_crop:

  37.   type: image_size

  38.   label: 'Image crop'

  39.   mapping:

  40.     anchor:

  41.       label: 'Anchor'

  42.       type: string

  43. 

  44. image.effect.image_convert:

  45.   type: mapping

  46.   label: 'Convert'

  47.   mapping:

  48.     extension:

  49.       label: 'Extension'

  50.       type: string

  51.       constraints:

  52.         Choice:

  53.           callback: 'Drupal\Core\ImageToolkit\ImageToolkitManager::getAllValidExtensions'

  54. 

  55. image.effect.image_resize:

  56.   type: image_size

  57.   label: 'Image resize'

  58. 

  59. image.effect.image_rotate:

  60.   type: mapping

  61.   label: 'Image rotate'

  62.   mapping:

  63.     degrees:

  64.       type: integer

  65.       label: 'Rotation angle'

  66.     bgcolor:

  67.       label: 'Background color'

  68.       type: color_hex

  69.     random:

  70.       type: boolean

  71.       label: 'Randomize'

  72. 

  73. image.effect.image_scale:

  74.   type: image_size

  75.   label: 'Image scale'

  76.   mapping:

  77.     upscale:

  78.       type: boolean

  79.       label: 'Upscale'

  80. 

  81. # The image desaturate effect has no settings.

  82. image.effect.image_desaturate:

  83.   type: sequence

  84. 

  85. image.effect.image_scale_and_crop:

  86.   type: image_size

  87.   label: 'Image scale and crop'

  88.   mapping:

  89.     anchor:

  90.       label: 'Anchor'

  91.       type: string

  92. 

  93. image.settings:

  94.   type: config_object

  95.   constraints:

  96.     FullyValidatable: ~

  97.   mapping:

  98.     preview_image:

  99.       type: string

  100.       label: 'Preview image'

  101.       constraints:

  102.         NotBlank: []

  103.         # We need to use Symfony's Image constraint because it will accept a file

  104.         # path as a string, whereas the File module's FileIsImage constraint expects

  105.         # a full file entity.

  106.         Image: []

  107.     allow_insecure_derivatives:

  108.       type: boolean

  109.       label: 'Allow insecure image derivatives'

  110.     suppress_itok_output:

  111.       type: boolean

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

  113. 

  114. field.storage_settings.image:

  115.   type: field.storage_settings.file

  116.   label: 'Image settings'

  117.   mapping:

  118.     default_image:

  119.       type: field_default_image

  120.       label: 'Default value'

  121. 

  122. field.field_settings.image:

  123.   type: base_file_field_field_settings

  124.   label: 'Image settings'

  125.   mapping:

  126.     max_resolution:

  127.       type: string

  128.       label: 'Maximum image dimensions'

  129.     min_resolution:

  130.       type: string

  131.       label: 'Minimum image dimensions'

  132.     alt_field:

  133.       type: boolean

  134.       label: 'Enable Alt field'

  135.     alt_field_required:

  136.       type: boolean

  137.       label: 'Alt field required'

  138.     title_field:

  139.       type: boolean

  140.       label: 'Enable Title field'

  141.     title_field_required:

  142.       type: boolean

  143.       label: 'Title field required'

  144.     default_image:

  145.       type: field_default_image

  146.       label: 'Default value'

  147. 

  148. field.value.image:

  149.   type: field_default_image

  150.   label: 'Default value'

  151. 

  152. field.formatter.settings.image:

  153.   type: mapping

  154.   label: 'Image field display format settings'

  155.   mapping:

  156.     image_link:

  157.       type: string

  158.       label: 'Link image to'

  159.     image_style:

  160.       type: string

  161.       label: 'Image style'

  162.     image_loading:

  163.       type: mapping

  164.       label: 'Image loading settings'

  165.       mapping:

  166.         attribute:

  167.           type: string

  168.           label: 'Loading attribute'

  169. 

  170. field.formatter.settings.image_url:

  171.   type: mapping

  172.   label: 'Image URL formatter settings'

  173.   mapping:

  174.     image_style:

  175.       type: string

  176.       label: 'Image style'

  177. 

  178. field.widget.settings.image_image:

  179.   type: mapping

  180.   label: 'Image field display format settings'

  181.   mapping:

  182.     progress_indicator:

  183.       type: string

  184.       label: 'Progress indicator'

  185.     preview_image_style:

  186.       type: string

  187.       label: 'Preview image style'

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