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. 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. image.style.*:
  3. type: config_entity
  4. label: 'Image style'
  5. mapping:
  6. name:
  7. type: machine_name
  8. label:
  9. type: required_label
  10. label: 'Label'
  11. effects:
  12. type: sequence
  13. sequence:
  14. type: mapping
  15. mapping:
  16. uuid:
  17. type: uuid
  18. id:
  19. type: string
  20. constraints:
  21. PluginExists:
  22. manager: plugin.manager.image.effect
  23. interface: 'Drupal\image\ImageEffectInterface'
  24. weight:
  25. type: weight
  26. data:
  27. type: image.effect.[%parent.id]
  28. image.effect.*:
  29. type: mapping
  30. label: 'Effect settings'
  31. image.effect.image_crop:
  32. type: image_size
  33. label: 'Image crop'
  34. mapping:
  35. anchor:
  36. label: 'Anchor'
  37. type: string
  38. image.effect.image_convert:
  39. type: mapping
  40. label: 'Convert'
  41. mapping:
  42. extension:
  43. label: 'Extension'
  44. type: string
  45. image.effect.image_resize:
  46. type: image_size
  47. label: 'Image resize'
  48. image.effect.image_rotate:
  49. type: mapping
  50. label: 'Image rotate'
  51. mapping:
  52. degrees:
  53. type: integer
  54. label: 'Rotation angle'
  55. bgcolor:
  56. label: 'Background color'
  57. type: color_hex
  58. random:
  59. type: boolean
  60. label: 'Randomize'
  61. image.effect.image_scale:
  62. type: image_size
  63. label: 'Image scale'
  64. mapping:
  65. upscale:
  66. type: boolean
  67. label: 'Upscale'
  68. # The image desaturate effect has no settings.
  69. image.effect.image_desaturate:
  70. type: sequence
  71. image.effect.image_scale_and_crop:
  72. type: image_size
  73. label: 'Image scale and crop'
  74. mapping:
  75. anchor:
  76. label: 'Anchor'
  77. type: string
  78. image.settings:
  79. type: config_object
  80. constraints:
  81. FullyValidatable: ~
  82. mapping:
  83. preview_image:
  84. type: string
  85. label: 'Preview image'
  86. constraints:
  87. NotBlank: []
  88. # We need to use Symfony's Image constraint because it will accept a file
  89. # path as a string, whereas the File module's FileIsImage constraint expects
  90. # a full file entity.
  91. Image: []
  92. allow_insecure_derivatives:
  93. type: boolean
  94. label: 'Allow insecure image derivatives'
  95. suppress_itok_output:
  96. type: boolean
  97. label: 'Suppress the itok query string for image derivatives'
  98. field.storage_settings.image:
  99. type: field.storage_settings.file
  100. label: 'Image settings'
  101. mapping:
  102. default_image:
  103. type: field_default_image
  104. label: 'Default value'
  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 dimensions'
  112. min_resolution:
  113. type: string
  114. label: 'Minimum image dimensions'
  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. field.value.image:
  131. type: field_default_image
  132. label: 'Default value'
  133. field.formatter.settings.image:
  134. type: mapping
  135. label: 'Image field display format settings'
  136. mapping:
  137. image_link:
  138. type: string
  139. label: 'Link image to'
  140. image_style:
  141. type: string
  142. label: 'Image style'
  143. image_loading:
  144. type: mapping
  145. label: 'Image loading settings'
  146. mapping:
  147. attribute:
  148. type: string
  149. label: 'Loading attribute'
  150. field.formatter.settings.image_url:
  151. type: mapping
  152. label: 'Image URL formatter settings'
  153. mapping:
  154. image_style:
  155. type: string
  156. label: 'Image style'
  157. field.widget.settings.image_image:
  158. type: mapping
  159. label: 'Image field display format settings'
  160. mapping:
  161. progress_indicator:
  162. type: string
  163. label: 'Progress indicator'
  164. preview_image_style:
  165. type: string
  166. label: 'Preview image style'

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