You are here

Home » API reference » Image Effects 8

image_effects.schema.yml in Image Effects 8

Same filename and directory in other branches
  1. 8.3 config/schema/image_effects.schema.yml
  2. 8.2 config/schema/image_effects.schema.yml
config/schema/image_effects.schema.yml

File

config/schema/image_effects.schema.yml
View source 
  1. # image_effects module schema

  2. 

  3. # Schema for module settings.

  4. 

  5. image_effects.settings:

  6.   type: config_object

  7.   label: 'Image Effects settings'

  8.   mapping:

  9.     color_selector:

  10.       type: mapping

  11.       label: 'Color selector plugin'

  12.       mapping:

  13.         plugin_id:

  14.           type: string

  15.           label: 'Selected plugin id'

  16.         plugin_settings:

  17.           type: sequence

  18.           label: 'Plugin settings'

  19.           sequence:

  20.             type: image_effects.plugin.color_selector.[%key]

  21.     image_selector:

  22.       type: mapping

  23.       label: 'Image selector plugin'

  24.       mapping:

  25.         plugin_id:

  26.           type: string

  27.           label: 'Selected plugin id'

  28.         plugin_settings:

  29.           type: sequence

  30.           label: 'Plugins settings'

  31.           sequence:

  32.             type: image_effects.plugin.image_selector.[%key]

  33.     font_selector:

  34.       type: mapping

  35.       label: 'Font selector plugin'

  36.       mapping:

  37.         plugin_id:

  38.           type: string

  39.           label: 'Selected plugin id'

  40.         plugin_settings:

  41.           type: sequence

  42.           label: 'Plugins settings'

  43.           sequence:

  44.             type: image_effects.plugin.font_selector.[%key]

  45. 

  46. # Schema for image_effects plugins settings.

  47. 

  48. image_effects.plugin.color_selector.*:

  49.   type: mapping

  50.   label: 'Color selector plugin settings'

  51. 

  52. image_effects.plugin.color_selector.html_color:

  53.   type: mapping

  54.   label: 'HTML color element'

  55. 

  56. image_effects.plugin.color_selector.farbtastic:

  57.   type: mapping

  58.   label: 'Farbtastic color picker'

  59. 

  60. image_effects.plugin.image_selector.*:

  61.   type: mapping

  62.   label: 'Image selector plugin settings'

  63. 

  64. image_effects.plugin.image_selector.basic:

  65.   type: mapping

  66.   label: 'Basic'

  67. 

  68. image_effects.plugin.image_selector.dropdown:

  69.   type: mapping

  70.   label: 'Dropdown'

  71.   mapping:

  72.     path:

  73.       type: string

  74.       label: 'Path where image files can be found'

  75. 

  76. image_effects.plugin.font_selector.*:

  77.   type: mapping

  78.   label: 'Font selector plugin settings'

  79. 

  80. image_effects.plugin.font_selector.basic:

  81.   type: mapping

  82.   label: 'Basic'

  83. 

  84. image_effects.plugin.font_selector.dropdown:

  85.   type: mapping

  86.   label: 'Dropdown'

  87.   mapping:

  88.     path:

  89.       type: string

  90.       label: 'Path where font files can be found'

  91. 

  92. # Image effects settings

  93. 

  94. image.effect.image_effects_auto_orient:

  95.   type: mapping

  96.   label: 'Automatically correct orientation'

  97.   mapping:

  98.     scan_exif:

  99.       type: boolean

  100.       label: 'Scan EXIF data when calculating styled image dimensions'

  101. 

  102. image.effect.image_effects_background:

  103.   type: mapping

  104.   label: 'Background image effect'

  105.   mapping:

  106.     background_image:

  107.       type: string

  108.       label: 'Background image path'

  109.     background_image_width:

  110.       type: string

  111.       label: 'Background image width in px'

  112.     background_image_height:

  113.       type: string

  114.       label: 'Background image height in px'

  115.     placement:

  116.       type: string

  117.       label: 'Position of the source image on the background image'

  118.     x_offset:

  119.       type: integer

  120.       label: 'X offset of the source image vs placement'

  121.     y_offset:

  122.       type: integer

  123.       label: 'Y offset of the source image vs placement'

  124.     opacity:

  125.       type: integer

  126.       label: 'Opacity of the source image'

  127. 

  128. image.effect.image_effects_brightness:

  129.   type: mapping

  130.   label: 'Adjust image brightness'

  131.   mapping:

  132.     level:

  133.       type: integer

  134.       label: 'Level'

  135. 

  136. image.effect.image_effects_color_shift:

  137.   type: mapping

  138.   label: 'Shift image colors'

  139.   mapping:

  140.     RGB:

  141.       type: string

  142.       label: 'RGB color shift'

  143. 

  144. image.effect.image_effects_contrast:

  145.   type: mapping

  146.   label: 'Adjust image contrast'

  147.   mapping:

  148.     level:

  149.       type: integer

  150.       label: 'Level'

  151. 

  152. image.effect.image_effects_gaussian_blur:

  153.   type: mapping

  154.   label: 'Blur the image with a Gaussian operator'

  155.   mapping:

  156.     radius:

  157.       type: integer

  158.       label: 'Radius'

  159.     sigma:

  160.       type: float

  161.       label: 'Sigma'

  162. 

  163. image.effect.image_effects_imagemagick_arguments:

  164.   type: mapping

  165.   label: 'Directly enter ImageMagick command line arguments'

  166.   mapping:

  167.     command_line:

  168.       type: text

  169.       label: 'Command line arguments'

  170.     dimensions_method:

  171.       type: string

  172.       label: 'Method for determining dimensions'

  173.     width:

  174.       type: string

  175.       label: 'Width in px or %'

  176.     height:

  177.       type: string

  178.       label: 'Height in px or %'

  179. 

  180. # The image invert effect has no settings.

  181. image.effect.image_effects_invert:

  182.   type: sequence

  183. 

  184. image.effect.image_effects_mask:

  185.   type: mapping

  186.   label: 'Apply a mask to the image'

  187.   mapping:

  188.     mask_image:

  189.       type: string

  190.       label: 'Mask image path'

  191.     mask_width:

  192.       type: string

  193.       label: 'Mask image horizontal resizing'

  194.     mask_height:

  195.       type: string

  196.       label: 'Mask image vertical resizing'

  197.     placement:

  198.       type: string

  199.       label: 'Position of the mask image on the image'

  200.     x_offset:

  201.       type: string

  202.       label: 'X offset of the mask image vs placement'

  203.     y_offset:

  204.       type: string

  205.       label: 'Y offset of the mask image vs placement'

  206. 

  207. image.effect.image_effects_mirror:

  208.   type: mapping

  209.   label: 'Mirror the image horizontally and/or vertically'

  210.   mapping:

  211.     x_axis:

  212.       type: boolean

  213.       label: 'Flop the source image horizontally'

  214.     y_axis:

  215.       type: boolean

  216.       label: 'Flip the source image vertically'

  217. 

  218. image.effect.image_effects_opacity:

  219.   type: mapping

  220.   label: 'Adjust image transparency level'

  221.   mapping:

  222.     opacity:

  223.       type: integer

  224.       label: 'Opacity % of the source image'

  225. 

  226. image.effect.image_effects_resize_percentage:

  227.   type: mapping

  228.   label: 'Resize based on percentage'

  229.   mapping:

  230.     width:

  231.       type: string

  232.       label: 'Width in px or %'

  233.     height:

  234.       type: string

  235.       label: 'Height in px or %'

  236. 

  237. image.effect.image_effects_scale_and_smart_crop:

  238.   type: mapping

  239.   label: 'Similar to Scale and Crop, but preserves the portion of the image with the most entropy.'

  240.   mapping:

  241.     width:

  242.       type: string

  243.       label: 'Width in px or %'

  244.     height:

  245.       type: string

  246.       label: 'Height in px or %'

  247.     upscale:

  248.       type: boolean

  249.       label: 'Upscale'

  250.     simulate:

  251.       type: boolean

  252.       label: 'Simulate'

  253.     algorithm:

  254.       type: string

  255.       label: 'Calculation algorithm'

  256. 

  257. image.effect.image_effects_set_canvas:

  258.   type: mapping

  259.   label: 'Set canvas image effect'

  260.   mapping:

  261.     canvas_size:

  262.       type: string

  263.       label: 'Canvas sizing, exact or relative'

  264.     canvas_color:

  265.       type: string

  266.       label: 'RGBA color of the canvas'

  267.     exact:

  268.       type: mapping

  269.       mapping:

  270.         width:

  271.           type: string

  272.           label: 'Exact width in px'

  273.         height:

  274.           type: string

  275.           label: 'Exact height in px'

  276.         placement:

  277.           type: string

  278.           label: 'Position of the source image on the canvas'

  279.         x_offset:

  280.           type: integer

  281.           label: 'x offset vs placement'

  282.         y_offset:

  283.           type: integer

  284.           label: 'y offset vs placement'

  285.     relative:

  286.       type: mapping

  287.       mapping:

  288.         left:

  289.           type: integer

  290.           label: 'Left margin in px'

  291.         right:

  292.           type: integer

  293.           label: 'Right margin in px'

  294.         top:

  295.           type: integer

  296.           label: 'Top margin in px'

  297.         bottom:

  298.           type: integer

  299.           label: 'Bottom margin in px'

  300. 

  301. image.effect.image_effects_set_transparent_color:

  302.   type: mapping

  303.   label: 'Set transparent color'

  304.   mapping:

  305.     transparent_color:

  306.       type: string

  307.       label: 'RGB color'

  308. 

  309. image.effect.image_effects_smart_crop:

  310.   type: mapping

  311.   label: 'Similar to Crop, but preserves the portion of the image with the most entropy.'

  312.   mapping:

  313.     width:

  314.       type: string

  315.       label: 'Width in px or %'

  316.     height:

  317.       type: string

  318.       label: 'Height in px or %'

  319.     square:

  320.       type: boolean

  321.       label: 'Make width/height the same if one dimension is not specified'

  322.     simulate:

  323.       type: boolean

  324.       label: 'Simulate'

  325.     algorithm:

  326.       type: string

  327.       label: 'Calculation algorithm'

  328. 

  329. # The strip metadata effect has no settings.

  330. image.effect.image_effects_strip_metadata:

  331.   type: sequence

  332. 

  333. image.effect.image_effects_text_overlay:

  334.   type: mapping

  335.   label: 'Text overlay effect'

  336.   mapping:

  337.     text_string:

  338.       type: text

  339.       label: 'Text associated with this effect, can include tokens'

  340.     font:

  341.       type: mapping

  342.       mapping:

  343.         name:

  344.           type: string

  345.           label: 'Font name'

  346.         uri:

  347.           type: string

  348.           label: 'Font file URI'

  349.         size:

  350.           type: integer

  351.           label: 'Font size'

  352.         angle:

  353.           type: integer

  354.           label: 'Font orientation'

  355.         color:

  356.           type: color_hex

  357.           label: 'Font color'

  358.         stroke_mode:

  359.           type: string

  360.           label: 'Type of stroke (outline/shadow)'

  361.         stroke_color:

  362.           type: color_hex

  363.           label: 'Color of the stroke'

  364.         outline_top:

  365.           type: integer

  366.           label: 'Outline px on the top'

  367.         outline_right:

  368.           type: integer

  369.           label: 'Outline px on the right'

  370.         outline_bottom:

  371.           type: integer

  372.           label: 'Outline px on the bottom'

  373.         outline_left:

  374.           type: integer

  375.           label: 'Outline px on the left'

  376.         shadow_x_offset:

  377.           type: integer

  378.           label: 'Shadow horizontal offset in px'

  379.         shadow_y_offset:

  380.           type: integer

  381.           label: 'Shadow vertical offset in px'

  382.         shadow_width:

  383.           type: integer

  384.           label: 'Shadow width in px'

  385.         shadow_height:

  386.           type: integer

  387.           label: 'Shadow height in px'

  388.     layout:

  389.       type: mapping

  390.       mapping:

  391.         padding_top:

  392.           type: integer

  393.           label: 'Padding top in px'

  394.         padding_right:

  395.           type: integer

  396.           label: 'Padding right in px'

  397.         padding_bottom:

  398.           type: integer

  399.           label: 'Padding bottom in px'

  400.         padding_left:

  401.           type: integer

  402.           label: 'Padding left in px'

  403.         x_pos:

  404.           type: string

  405.           label: 'Placement on canvas, horizontal'

  406.         y_pos:

  407.           type: string

  408.           label: 'Placement on canvas, vertical'

  409.         x_offset:

  410.           type: integer

  411.           label: 'Placement on canvas, horizontal, offset'

  412.         y_offset:

  413.           type: integer

  414.           label: 'Placement on canvas, vertical, offset'

  415.         background_color:

  416.           type: color_hex

  417.           label: 'Color of bounding box'

  418.         overflow_action:

  419.           type: string

  420.           label: 'Action when text wrapper overflows canvas'

  421.         extended_color:

  422.           type: color_hex

  423.           label: 'Color to be used when extending the underlying image'

  424.     text:

  425.       type: mapping

  426.       mapping:

  427.         strip_tags:

  428.           type: boolean

  429.           label: 'Strip HTML tags'

  430.         decode_entities:

  431.           type: boolean

  432.           label: 'Decode HTML entities'

  433.         maximum_chars:

  434.           type: integer

  435.           label: 'Maximum characters threshold'

  436.         excess_chars_text:

  437.           type: text

  438.           label: 'Text to append at the end of the trimmed text string when it exceeded maximum characters threshold'

  439.         maximum_width:

  440.           type: integer

  441.           label: 'Maximum width in px'

  442.         fixed_width:

  443.           type: boolean

  444.           label: 'Fixed width flag'

  445.         align:

  446.           type: string

  447.           label: 'Text alignment'

  448.         line_spacing:

  449.           type: integer

  450.           label: 'Line spacing in px'

  451.         case_format:

  452.           type: string

  453.           label: 'Text format conversion'

  454. 

  455. image.effect.image_effects_watermark:

  456.   type: mapping

  457.   label: 'Watermark image effect'

  458.   mapping:

  459.     watermark_image:

  460.       type: string

  461.       label: 'Watermark image path'

  462.     watermark_width:

  463.       type: string

  464.       label: 'Watermark image horizontal resizing'

  465.     watermark_height:

  466.       type: string

  467.       label: 'Watermark image vertical resizing'

  468.     placement:

  469.       type: string

  470.       label: 'Position of the watermark image on the canvas'

  471.     x_offset:

  472.       type: string

  473.       label: 'X offset of the watermark image vs placement'

  474.     y_offset:

  475.       type: string

  476.       label: 'Y offset of the watermark image vs placement'

  477.     opacity:

  478.       type: integer

  479.       label: 'opacity'

  480. 

  481. image.effect.image_effects_convolution:

  482.   type: mapping

  483.   label: 'Filter image using convolution'

  484.   mapping:

  485.     kernel:

  486.       type: sequence

  487.       label: 'Kernel'

  488.       sequence:

  489.         type: sequence

  490.         label: 'Row'

  491.         sequence:

  492.           type: integer

  493.           label: 'Column'

  494.     divisor:

  495.       type: integer

  496.       label: 'Divisor'

  497.     offset:

  498.       type: integer

  499.       label: 'Offset'

  500.     label:

  501.       type: string

  502.       label: 'Label'

  503. 

  504. image.effect.image_effects_convolution_sharpen:

  505.   type: mapping

  506.   label: 'Sharpen image using convolution'

  507.   mapping:

  508.     level:

  509.       type: integer

  510.       label: 'Level'

  511. 

  512. image.effect.image_effects_interlace:

  513.   type: mapping

  514.   label: 'Adjust interlace type'

  515.   mapping:

  516.     type:

  517.       type: string

  518.       label: 'Type'

  519. 

  520. image.effect.image_effects_aspect_switcher:

  521.   type: mapping

  522.   label: 'Allows to choose image styles to apply based on orientation (portrait or landscape)'

  523.   mapping:

  524.     landscape_image_style:

  525.       type: string

  526.       label: 'Image style machine_name for landscape orientation'

  527.     portrait_image_style:

  528.       type: string

  529.       label: 'Image style machine_name for portrait orientation'

  530.     ratio_adjustment:

  531.       type: float

  532.       label: 'This allows you to bend the rules for how different the proportions need to be to trigger the switch'