You are here

Home » API reference » Image Effects 8.3

image_effects.schema.yml in Image Effects 8.3

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

  227.   type: mapping

  228.   label: 'Relative crop'

  229.   mapping:

  230.     width:

  231.       type: integer

  232.       label: 'Ratio width'

  233.     height:

  234.       type: integer

  235.       label: 'Ratio height'

  236.     anchor:

  237.       type: mapping

  238.       label: 'Anchor'

  239.       mapping:

  240.         width:

  241.           type: string

  242.           label: 'Width anchor'

  243.           constraints:

  244.             AllowedValues: ['left', 'center', 'right']

  245.         height:

  246.           type: string

  247.           label: 'Height anchor'

  248.           constraints:

  249.             AllowedValues: ['top', 'center', 'bottom']

  250. 

  251. image.effect.image_effects_resize_percentage:

  252.   type: mapping

  253.   label: 'Resize based on percentage'

  254.   mapping:

  255.     width:

  256.       type: string

  257.       label: 'Width in px or %'

  258.     height:

  259.       type: string

  260.       label: 'Height in px or %'

  261. 

  262. image.effect.image_effects_scale_and_smart_crop:

  263.   type: mapping

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

  265.   mapping:

  266.     width:

  267.       type: string

  268.       label: 'Width in px or %'

  269.     height:

  270.       type: string

  271.       label: 'Height in px or %'

  272.     upscale:

  273.       type: boolean

  274.       label: 'Upscale'

  275.     simulate:

  276.       type: boolean

  277.       label: 'Simulate'

  278.     algorithm:

  279.       type: string

  280.       label: 'Calculation algorithm'

  281. 

  282. image.effect.image_effects_set_canvas:

  283.   type: mapping

  284.   label: 'Set canvas image effect'

  285.   mapping:

  286.     canvas_size:

  287.       type: string

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

  289.     canvas_color:

  290.       type: string

  291.       label: 'RGBA color of the canvas'

  292.     exact:

  293.       type: mapping

  294.       mapping:

  295.         width:

  296.           type: string

  297.           label: 'Exact width in px'

  298.         height:

  299.           type: string

  300.           label: 'Exact height in px'

  301.         placement:

  302.           type: string

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

  304.         x_offset:

  305.           type: integer

  306.           label: 'x offset vs placement'

  307.         y_offset:

  308.           type: integer

  309.           label: 'y offset vs placement'

  310.     relative:

  311.       type: mapping

  312.       mapping:

  313.         left:

  314.           type: integer

  315.           label: 'Left margin in px'

  316.         right:

  317.           type: integer

  318.           label: 'Right margin in px'

  319.         top:

  320.           type: integer

  321.           label: 'Top margin in px'

  322.         bottom:

  323.           type: integer

  324.           label: 'Bottom margin in px'

  325. 

  326. image.effect.image_effects_set_transparent_color:

  327.   type: mapping

  328.   label: 'Set transparent color'

  329.   mapping:

  330.     transparent_color:

  331.       type: string

  332.       label: 'RGB color'

  333. 

  334. image.effect.image_effects_smart_crop:

  335.   type: mapping

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

  337.   mapping:

  338.     width:

  339.       type: string

  340.       label: 'Width in px or %'

  341.     height:

  342.       type: string

  343.       label: 'Height in px or %'

  344.     square:

  345.       type: boolean

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

  347.     simulate:

  348.       type: boolean

  349.       label: 'Simulate'

  350.     algorithm:

  351.       type: string

  352.       label: 'Calculation algorithm'

  353. 

  354. # The strip metadata effect has no settings.

  355. image.effect.image_effects_strip_metadata:

  356.   type: sequence

  357. 

  358. image.effect.image_effects_text_overlay:

  359.   type: mapping

  360.   label: 'Text overlay effect'

  361.   mapping:

  362.     text_string:

  363.       type: text

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

  365.     font:

  366.       type: mapping

  367.       mapping:

  368.         name:

  369.           type: string

  370.           label: 'Font name'

  371.         uri:

  372.           type: string

  373.           label: 'Font file URI'

  374.         size:

  375.           type: integer

  376.           label: 'Font size'

  377.         angle:

  378.           type: integer

  379.           label: 'Font orientation'

  380.         color:

  381.           type: color_hex

  382.           label: 'Font color'

  383.         stroke_mode:

  384.           type: string

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

  386.         stroke_color:

  387.           type: color_hex

  388.           label: 'Color of the stroke'

  389.         outline_top:

  390.           type: integer

  391.           label: 'Outline px on the top'

  392.         outline_right:

  393.           type: integer

  394.           label: 'Outline px on the right'

  395.         outline_bottom:

  396.           type: integer

  397.           label: 'Outline px on the bottom'

  398.         outline_left:

  399.           type: integer

  400.           label: 'Outline px on the left'

  401.         shadow_x_offset:

  402.           type: integer

  403.           label: 'Shadow horizontal offset in px'

  404.         shadow_y_offset:

  405.           type: integer

  406.           label: 'Shadow vertical offset in px'

  407.         shadow_width:

  408.           type: integer

  409.           label: 'Shadow width in px'

  410.         shadow_height:

  411.           type: integer

  412.           label: 'Shadow height in px'

  413.     layout:

  414.       type: mapping

  415.       mapping:

  416.         padding_top:

  417.           type: integer

  418.           label: 'Padding top in px'

  419.         padding_right:

  420.           type: integer

  421.           label: 'Padding right in px'

  422.         padding_bottom:

  423.           type: integer

  424.           label: 'Padding bottom in px'

  425.         padding_left:

  426.           type: integer

  427.           label: 'Padding left in px'

  428.         x_pos:

  429.           type: string

  430.           label: 'Placement on canvas, horizontal'

  431.         y_pos:

  432.           type: string

  433.           label: 'Placement on canvas, vertical'

  434.         x_offset:

  435.           type: integer

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

  437.         y_offset:

  438.           type: integer

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

  440.         background_color:

  441.           type: color_hex

  442.           label: 'Color of bounding box'

  443.         overflow_action:

  444.           type: string

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

  446.         extended_color:

  447.           type: color_hex

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

  449.     text:

  450.       type: mapping

  451.       mapping:

  452.         strip_tags:

  453.           type: boolean

  454.           label: 'Strip HTML tags'

  455.         decode_entities:

  456.           type: boolean

  457.           label: 'Decode HTML entities'

  458.         maximum_chars:

  459.           type: integer

  460.           label: 'Maximum characters threshold'

  461.         excess_chars_text:

  462.           type: text

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

  464.         maximum_width:

  465.           type: integer

  466.           label: 'Maximum width in px'

  467.         fixed_width:

  468.           type: boolean

  469.           label: 'Fixed width flag'

  470.         align:

  471.           type: string

  472.           label: 'Text alignment'

  473.         line_spacing:

  474.           type: integer

  475.           label: 'Line spacing in px'

  476.         case_format:

  477.           type: string

  478.           label: 'Text format conversion'

  479. 

  480. image.effect.image_effects_watermark:

  481.   type: mapping

  482.   label: 'Watermark image effect'

  483.   mapping:

  484.     watermark_image:

  485.       type: string

  486.       label: 'Watermark image path'

  487.     watermark_width:

  488.       type: string

  489.       label: 'Watermark image horizontal resizing'

  490.     watermark_height:

  491.       type: string

  492.       label: 'Watermark image vertical resizing'

  493.     placement:

  494.       type: string

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

  496.     x_offset:

  497.       type: string

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

  499.     y_offset:

  500.       type: string

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

  502.     opacity:

  503.       type: integer

  504.       label: 'opacity'

  505. 

  506. image.effect.image_effects_convolution:

  507.   type: mapping

  508.   label: 'Filter image using convolution'

  509.   mapping:

  510.     kernel:

  511.       type: sequence

  512.       label: 'Kernel'

  513.       sequence:

  514.         type: sequence

  515.         label: 'Row'

  516.         sequence:

  517.           type: integer

  518.           label: 'Column'

  519.     divisor:

  520.       type: integer

  521.       label: 'Divisor'

  522.     offset:

  523.       type: integer

  524.       label: 'Offset'

  525.     label:

  526.       type: string

  527.       label: 'Label'

  528. 

  529. image.effect.image_effects_convolution_sharpen:

  530.   type: mapping

  531.   label: 'Sharpen image using convolution'

  532.   mapping:

  533.     level:

  534.       type: integer

  535.       label: 'Level'

  536. 

  537. image.effect.image_effects_interlace:

  538.   type: mapping

  539.   label: 'Adjust interlace type'

  540.   mapping:

  541.     type:

  542.       type: string

  543.       label: 'Type'

  544. 

  545. image.effect.image_effects_aspect_switcher:

  546.   type: mapping

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

  548.   mapping:

  549.     landscape_image_style:

  550.       type: string

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

  552.     portrait_image_style:

  553.       type: string

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

  555.     ratio_adjustment:

  556.       type: float

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