imgix-rails 2.1.4 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -3,56 +3,87 @@ module Imgix
3
3
  class ConfigurationError < StandardError; end
4
4
 
5
5
  module UrlHelper
6
- def ix_image_url(source, options={})
6
+ def ix_image_url(*args)
7
7
  validate_configuration!
8
8
 
9
- source = replace_hostname(source)
9
+ case args.size
10
+ when 1
11
+ path = args[0]
12
+ source = nil
13
+ options = {}
14
+ when 2
15
+ if args[0].is_a?(String) && args[1].is_a?(Hash)
16
+ source = nil
17
+ path = args[0]
18
+ options = args[1]
19
+ elsif args[0].is_a?(String) && args[1].is_a?(String)
20
+ source = args[0]
21
+ path = args[1]
22
+ options = {}
23
+ else
24
+ raise RuntimeError.new("path and source must be of type String; options must be of type Hash")
25
+ end
26
+ when 3
27
+ source = args[0]
28
+ path = args[1]
29
+ options = args[2]
30
+ else
31
+ raise RuntimeError.new('path missing')
32
+ end
10
33
 
11
- imgix_client.path(source).to_url(options).html_safe
34
+ imgix_client(source).path(path).to_url(options).html_safe
12
35
  end
13
36
 
14
37
  private
15
38
 
16
39
  def validate_configuration!
17
40
  imgix = ::Imgix::Rails.config.imgix
18
- unless imgix.try(:[], :source)
19
- raise ConfigurationError.new("imgix source is not configured. Please set config.imgix[:source].")
20
- end
21
41
 
22
- unless imgix[:source].is_a?(Array) || imgix[:source].is_a?(String)
23
- raise ConfigurationError.new("imgix source must be a String or an Array.")
42
+ if imgix.slice(:source, :sources).size != 1
43
+ raise ConfigurationError.new("Exactly one of :source, :sources is required")
24
44
  end
25
- end
26
45
 
27
- def replace_hostname(source)
28
- new_source = source.dup
46
+ if imgix[:source]
47
+ unless imgix[:source].is_a?(Array) || imgix[:source].is_a?(String)
48
+ raise ConfigurationError.new("imgix source must be a String or an Array.")
49
+ end
50
+ end
29
51
 
30
- # Replace any hostnames configured to trim things down just to their paths.
31
- # We use split to remove the protocol in the process.
32
- hostnames_to_remove.each do |hostname|
33
- splits = source.split(hostname)
34
- new_source = splits.last if splits.size > 1
52
+ if imgix[:sources]
53
+ unless imgix[:sources].is_a?(Hash)
54
+ raise ConfigurationError.new(":sources must be a Hash")
55
+ end
35
56
  end
36
57
 
37
- new_source
58
+ unless !imgix.key?(:shard_strategy) || STRATEGIES.include?(imgix[:shard_strategy])
59
+ raise ConfigurationError.new("#{imgix[:shard_strategy]} is not supported")
60
+ end
38
61
  end
39
62
 
40
- def hostnames_to_remove
41
- Array(::Imgix::Rails.config.imgix[:hostname_to_replace] || ::Imgix::Rails.config.imgix[:hostnames_to_replace])
63
+ def imgix_client(source)
64
+ begin
65
+ return imgix_clients.fetch(source)
66
+ rescue KeyError
67
+ raise RuntimeError.new("Unknown source '#{source}'")
68
+ end
42
69
  end
43
70
 
44
- def imgix_client
45
- return @imgix_client if @imgix_client
71
+ def imgix_clients
72
+ return @imgix_clients if @imgix_clients
46
73
  imgix = ::Imgix::Rails.config.imgix
47
74
 
48
75
  opts = {
49
- host: imgix[:source],
50
76
  library_param: "rails",
51
77
  library_version: Imgix::Rails::VERSION,
52
78
  use_https: true,
53
- secure_url_token: imgix[:secure_url_token]
54
79
  }
55
80
 
81
+ if imgix[:source].is_a?(String)
82
+ opts[:host] = imgix[:source]
83
+ else
84
+ opts[:hosts] = imgix[:source]
85
+ end
86
+
56
87
  if imgix.has_key?(:include_library_param)
57
88
  opts[:include_library_param] = imgix[:include_library_param]
58
89
  end
@@ -61,7 +92,25 @@ module Imgix
61
92
  opts[:use_https] = imgix[:use_https]
62
93
  end
63
94
 
64
- @imgix_client = ::Imgix::Client.new(opts)
95
+ if imgix.has_key?(:shard_strategy)
96
+ opts[:shard_strategy] = imgix[:shard_strategy]
97
+ end
98
+
99
+ sources = imgix[:sources] || { imgix[:source] => imgix[:secure_url_token] }
100
+ @imgix_clients = {}
101
+
102
+ sources.map do |source, token|
103
+ opts[:host] = source
104
+ opts[:secure_url_token] = token
105
+ @imgix_clients[source] = ::Imgix::Client.new(opts)
106
+ end
107
+
108
+ default_source = imgix[:default_source] || imgix[:source]
109
+ if default_source
110
+ @imgix_clients[nil] = @imgix_clients.fetch(default_source)
111
+ end
112
+
113
+ @imgix_clients
65
114
  end
66
115
  end
67
116
  end
@@ -1,5 +1,5 @@
1
1
  module Imgix
2
2
  module Rails
3
- VERSION = '2.1.4'
3
+ VERSION = '3.0.0'
4
4
  end
5
5
  end
@@ -1,4 +1,5 @@
1
1
  require "imgix"
2
+ require "imgix/rails/tag"
2
3
  require "imgix/rails/image_tag"
3
4
  require "imgix/rails/picture_tag"
4
5
 
@@ -7,12 +8,12 @@ module Imgix
7
8
  module ViewHelper
8
9
  include UrlHelper
9
10
 
10
- def ix_image_tag(source, options={})
11
- Imgix::Rails::ImageTag.new(source, options).render
11
+ def ix_image_tag(source=nil, path, tag_options: {}, url_params: {}, widths: [])
12
+ return Imgix::Rails::ImageTag.new(path, source: source, tag_options: tag_options, url_params: url_params, widths: widths).render
12
13
  end
13
14
 
14
- def ix_picture_tag(source, picture_tag_options:, imgix_default_options:, breakpoints:)
15
- Imgix::Rails::PictureTag.new(source, picture_tag_options, imgix_default_options, breakpoints).render
15
+ def ix_picture_tag(source=nil, path, tag_options: {}, url_params: {}, breakpoints:)
16
+ return Imgix::Rails::PictureTag.new(path, source: source, tag_options: tag_options, url_params: url_params, breakpoints: breakpoints).render
16
17
  end
17
18
  end
18
19
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: imgix-rails
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.1.4
4
+ version: 3.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Kelly Sutton
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: exe
11
11
  cert_chain: []
12
- date: 2017-06-01 00:00:00.000000000 Z
12
+ date: 2018-09-24 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: imgix
@@ -101,6 +101,7 @@ files:
101
101
  - ".rspec"
102
102
  - ".travis.yml"
103
103
  - Gemfile
104
+ - LICENSE
104
105
  - README.md
105
106
  - Rakefile
106
107
  - bin/console
@@ -114,10 +115,9 @@ files:
114
115
  - lib/imgix/rails/version.rb
115
116
  - lib/imgix/rails/view_helper.rb
116
117
  - lib/imgix/railtie.rb
117
- - vendor/parameters.json
118
118
  homepage: https://github.com/imgix/imgix-rails
119
119
  licenses:
120
- - MIT
120
+ - BSD-2-Clause
121
121
  metadata:
122
122
  allowed_push_host: https://rubygems.org
123
123
  post_install_message:
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
136
136
  version: '0'
137
137
  requirements: []
138
138
  rubyforge_project:
139
- rubygems_version: 2.6.8
139
+ rubygems_version: 2.5.1
140
140
  signing_key:
141
141
  specification_version: 4
142
142
  summary: Makes integrating imgix into your Rails app easier. It builds on imgix-rb
@@ -1,1712 +0,0 @@
1
- {
2
- "parameters": {
3
- "auto": {
4
- "display_name": "auto features",
5
- "category": "automatic",
6
- "expects": [
7
- {
8
- "type": "list",
9
- "possible_values": [
10
- "enhance",
11
- "format",
12
- "redeye"
13
- ]
14
- }
15
- ],
16
- "url": "https://www.imgix.com/docs/reference/automatic#param-auto",
17
- "short_description": "Applies automatic enhancements to images."
18
- },
19
- "ba": {
20
- "display_name": "blend align",
21
- "category": "blend",
22
- "expects": [
23
- {
24
- "type": "list",
25
- "possible_values": [
26
- "top",
27
- "bottom",
28
- "middle",
29
- "left",
30
- "right",
31
- "center"
32
- ]
33
- }
34
- ],
35
- "depends": [
36
- "blend"
37
- ],
38
- "url": "https://www.imgix.com/docs/reference/blend#param-blendalign",
39
- "short_description": "Changes the blend alignment relative to the parent image."
40
- },
41
- "balph": {
42
- "display_name": "blend alpha",
43
- "category": "blend",
44
- "expects": [
45
- {
46
- "type": "number",
47
- "min": 0,
48
- "max": 100
49
- }
50
- ],
51
- "default": 100,
52
- "depends": [
53
- "blend"
54
- ],
55
- "url": "https://www.imgix.com/docs/reference/blend#param-blendalpha",
56
- "short_description": "Changes the alpha of the blend image."
57
- },
58
- "bc": {
59
- "display_name": "blend crop",
60
- "category": "blend",
61
- "expects": [
62
- {
63
- "type": "list",
64
- "possible_values": [
65
- "top",
66
- "bottom",
67
- "left",
68
- "right",
69
- "faces"
70
- ]
71
- }
72
- ],
73
- "depends": [
74
- "blend"
75
- ],
76
- "url": "https://www.imgix.com/docs/reference/blend#param-blendcrop",
77
- "short_description": "Specifies the type of crop for blend images."
78
- },
79
- "bf": {
80
- "display_name": "blend fit",
81
- "category": "blend",
82
- "expects": [
83
- {
84
- "type": "string",
85
- "possible_values": [
86
- "clamp",
87
- "clip",
88
- "crop",
89
- "scale",
90
- "max"
91
- ]
92
- }
93
- ],
94
- "default": "clip",
95
- "depends": [
96
- "blend"
97
- ],
98
- "url": "https://www.imgix.com/docs/reference/blend#param-blendfit",
99
- "short_description": "Specifies the fit mode for blend images."
100
- },
101
- "bg": {
102
- "display_name": "background color",
103
- "category": "background",
104
- "expects": [
105
- {
106
- "type": "hex_color"
107
- }
108
- ],
109
- "default": "fff",
110
- "url": "https://www.imgix.com/docs/reference/background#param-bg",
111
- "short_description": "Colors the background of padded images."
112
- },
113
- "bh": {
114
- "display_name": "blend height",
115
- "category": "blend",
116
- "expects": [
117
- {
118
- "type": "number",
119
- "min": 0
120
- }
121
- ],
122
- "depends": [
123
- "blend"
124
- ],
125
- "url": "https://www.imgix.com/docs/reference/blend#param-blendheight",
126
- "short_description": "Adjusts the height of the blend image."
127
- },
128
- "blend": {
129
- "display_name": "blend",
130
- "category": "blend",
131
- "expects": [
132
- {
133
- "type": "hex_color"
134
- },
135
- {
136
- "type": "url"
137
- }
138
- ],
139
- "url": "https://www.imgix.com/docs/reference/blend#param-blend",
140
- "short_description": "Specifies the location of the blend image."
141
- },
142
- "blur": {
143
- "display_name": "blur",
144
- "category": "stylize",
145
- "expects": [
146
- {
147
- "type": "number",
148
- "min": 0,
149
- "max": 2000
150
- }
151
- ],
152
- "default": 0,
153
- "url": "https://www.imgix.com/docs/reference/stylize#param-blur",
154
- "short_description": "Applies a gaussian blur to an image."
155
- },
156
- "bm": {
157
- "display_name": "blend mode",
158
- "category": "blend",
159
- "expects": [
160
- {
161
- "type": "string",
162
- "possible_values": [
163
- "color",
164
- "burn",
165
- "dodge",
166
- "darken",
167
- "difference",
168
- "exclusion",
169
- "hardlight",
170
- "hue",
171
- "lighten",
172
- "luminosity",
173
- "multiply",
174
- "overlay",
175
- "saturation",
176
- "screen",
177
- "softlight",
178
- "normal"
179
- ]
180
- }
181
- ],
182
- "default": "overlay",
183
- "depends": [
184
- "blend"
185
- ],
186
- "url": "https://www.imgix.com/docs/reference/blend#param-blendmode",
187
- "short_description": "Sets the blend mode for a blend image."
188
- },
189
- "border": {
190
- "display_name": "border",
191
- "category": "border_and_padding",
192
- "expects": [
193
- {
194
- "0": {
195
- "type": "integer",
196
- "min": 0
197
- },
198
- "1": {
199
- "type": "hex_color"
200
- },
201
- "type": "list",
202
- "length": 2
203
- }
204
- ],
205
- "url": "https://www.imgix.com/docs/reference/border-padding#param-border",
206
- "short_description": "Applies a border to an image."
207
- },
208
- "bp": {
209
- "display_name": "blend padding",
210
- "category": "blend",
211
- "expects": [
212
- {
213
- "type": "number",
214
- "min": 0
215
- }
216
- ],
217
- "default": 0,
218
- "depends": [
219
- "blend"
220
- ],
221
- "url": "https://www.imgix.com/docs/reference/blend#param-blendpadding",
222
- "short_description": "Applies padding to the blend image."
223
- },
224
- "bri": {
225
- "display_name": "brightness",
226
- "category": "adjustment",
227
- "expects": [
228
- {
229
- "type": "number",
230
- "min": -100,
231
- "max": 100
232
- }
233
- ],
234
- "default": 0,
235
- "url": "https://www.imgix.com/docs/reference/adjustment#param-bri",
236
- "short_description": "Adjusts the brightness of the source image."
237
- },
238
- "bs": {
239
- "display_name": "blend size",
240
- "category": "blend",
241
- "expects": [
242
- {
243
- "type": "string",
244
- "possible_values": [
245
- "inherit"
246
- ]
247
- }
248
- ],
249
- "depends": [
250
- "blend"
251
- ],
252
- "url": "https://www.imgix.com/docs/reference/blend#param-blendsize",
253
- "short_description": "Adjusts the size of the blend image."
254
- },
255
- "bw": {
256
- "display_name": "blend width",
257
- "category": "blend",
258
- "expects": [
259
- {
260
- "type": "number",
261
- "min": 0
262
- }
263
- ],
264
- "depends": [
265
- "blend"
266
- ],
267
- "url": "https://www.imgix.com/docs/reference/blend#param-blendwidth",
268
- "short_description": "Adjusts the width of the blend image."
269
- },
270
- "bx": {
271
- "display_name": "blend x",
272
- "category": "blend",
273
- "expects": [
274
- {
275
- "type": "number",
276
- "min": 0
277
- }
278
- ],
279
- "default": 0,
280
- "depends": [
281
- "blend"
282
- ],
283
- "url": "https://www.imgix.com/docs/reference/blend#param-blendx",
284
- "short_description": "Adjusts the x-offset of the blend image relative to its parent."
285
- },
286
- "by": {
287
- "display_name": "blend y",
288
- "category": "blend",
289
- "expects": [
290
- {
291
- "type": "number",
292
- "min": 0
293
- }
294
- ],
295
- "default": 0,
296
- "depends": [
297
- "blend"
298
- ],
299
- "url": "https://www.imgix.com/docs/reference/blend#param-blendy",
300
- "short_description": "Adjusts the y-offset of the blend image relative to its parent."
301
- },
302
- "ch": {
303
- "display_name": "client-hints",
304
- "category": "format",
305
- "expects": [
306
- {
307
- "type": "list",
308
- "possible_values": [
309
- "width",
310
- "dpr"
311
- ]
312
- }
313
- ],
314
- "short_description": "Sets one or more Client-Hints headers"
315
- },
316
- "chromasub": {
317
- "display_name": "chroma subsampling",
318
- "category": "format",
319
- "expects": [
320
- {
321
- "type": "integer",
322
- "possible_values": [
323
- 444,
324
- 422,
325
- 420
326
- ]
327
- }
328
- ],
329
- "default": 420,
330
- "url": "https://www.imgix.com/docs/reference/format#param-chromasub",
331
- "short_description": "Specifies the output chroma subsampling rate."
332
- },
333
- "colorquant": {
334
- "display_name": "color quantization",
335
- "category": "format",
336
- "expects": [
337
- {
338
- "type": "integer",
339
- "min": 2,
340
- "max": 256
341
- }
342
- ],
343
- "url": "https://www.imgix.com/docs/reference/format#param-colorquant",
344
- "short_description": "Limits the number of unique colors in an image."
345
- },
346
- "colors": {
347
- "display_name": "color count",
348
- "category": "palette",
349
- "expects": [
350
- {
351
- "type": "integer",
352
- "min": 0,
353
- "max": 16
354
- }
355
- ],
356
- "default": 6,
357
- "depends": [
358
- "palette"
359
- ],
360
- "url": "https://www.imgix.com/docs/reference/palette#param-colors",
361
- "short_description": "Specifies how many colors to include in a palette-extraction response."
362
- },
363
- "con": {
364
- "display_name": "contrast",
365
- "category": "adjustment",
366
- "expects": [
367
- {
368
- "type": "number",
369
- "min": -100,
370
- "max": 100
371
- }
372
- ],
373
- "default": 0,
374
- "url": "https://www.imgix.com/docs/reference/adjustment#param-con",
375
- "short_description": "Adjusts the contrast of the source image."
376
- },
377
- "crop": {
378
- "display_name": "crop mode",
379
- "category": "size",
380
- "expects": [
381
- {
382
- "type": "list",
383
- "possible_values": [
384
- "top",
385
- "bottom",
386
- "left",
387
- "right",
388
- "faces",
389
- "entropy"
390
- ]
391
- }
392
- ],
393
- "depends": [
394
- "fit=crop"
395
- ],
396
- "url": "https://www.imgix.com/docs/reference/size#param-crop",
397
- "short_description": "Specifies how to crop an image."
398
- },
399
- "cs": {
400
- "display_name": "colorspace",
401
- "category": "format",
402
- "expects": [
403
- {
404
- "type": "string",
405
- "possible_values": [
406
- "srgb",
407
- "adobergb1998"
408
- ]
409
- }
410
- ],
411
- "short_description": "Specifies the color space of the output image."
412
- },
413
- "dl": {
414
- "display_name": "download",
415
- "category": "format",
416
- "expects": [
417
- {
418
- "type": "string"
419
- }
420
- ],
421
- "url": "https://www.imgix.com/docs/reference/format#param-download",
422
- "short_description": "Forces a URL to use send-file in its response."
423
- },
424
- "dpi": {
425
- "display_name": "dots per inch",
426
- "category": "format",
427
- "expects": [
428
- {
429
- "type": "number"
430
- }
431
- ],
432
- "url": "https://www.imgix.com/docs/reference/format#param-dpi",
433
- "short_description": "Sets the DPI value in the EXIF header."
434
- },
435
- "dpr": {
436
- "display_name": "device pixel ratio",
437
- "category": "pixel_density",
438
- "expects": [
439
- {
440
- "type": "number",
441
- "min": 0.75,
442
- "max": 8
443
- }
444
- ],
445
- "default": 1,
446
- "url": "https://www.imgix.com/docs/reference/pixeldensity#param-dpr",
447
- "short_description": "Adjusts the device-pixel-ratio of the output image."
448
- },
449
- "exp": {
450
- "display_name": "exposure",
451
- "category": "adjustment",
452
- "expects": [
453
- {
454
- "type": "number",
455
- "min": -100,
456
- "max": 100
457
- }
458
- ],
459
- "default": 0,
460
- "url": "https://www.imgix.com/docs/reference/adjustment#param-exp",
461
- "short_description": "Adjusts the exposure of the output image."
462
- },
463
- "faceindex": {
464
- "display_name": "face index",
465
- "category": "face_detection",
466
- "expects": [
467
- {
468
- "type": "integer",
469
- "min": 1
470
- }
471
- ],
472
- "depends": [
473
- "fit=facearea"
474
- ],
475
- "url": "https://www.imgix.com/docs/reference/face-detection#param-faceindex",
476
- "short_description": "Selects a face to crop to."
477
- },
478
- "facepad": {
479
- "display_name": "face padding",
480
- "category": "face_detection",
481
- "expects": [
482
- {
483
- "type": "number",
484
- "min": 0
485
- }
486
- ],
487
- "default": 1,
488
- "depends": [
489
- "fit=facearea"
490
- ],
491
- "url": "https://www.imgix.com/docs/reference/face-detection#param-facepad",
492
- "short_description": "Adjusts padding around a selected face."
493
- },
494
- "faces": {
495
- "display_name": "faces",
496
- "category": "face_detection",
497
- "expects": [
498
- {
499
- "type": "integer",
500
- "possible_values": [
501
- 1
502
- ]
503
- }
504
- ],
505
- "depends": [
506
- "fm=json"
507
- ],
508
- "url": "https://www.imgix.com/docs/reference/face-detection#param-faces",
509
- "short_description": "Specifies that face data should be included in output when combined with `fm=json`."
510
- },
511
- "fit": {
512
- "display_name": "fit mode",
513
- "category": "size",
514
- "expects": [
515
- {
516
- "type": "string",
517
- "possible_values": [
518
- "clamp",
519
- "clip",
520
- "crop",
521
- "facearea",
522
- "fill",
523
- "max",
524
- "min",
525
- "scale"
526
- ]
527
- }
528
- ],
529
- "default": "clip",
530
- "aliases": [
531
- "f"
532
- ],
533
- "url": "https://www.imgix.com/docs/reference/size#param-fit",
534
- "short_description": "Specifies how to map the source image to the output image dimensions."
535
- },
536
- "flip": {
537
- "display_name": "flip direction",
538
- "category": "rotation",
539
- "expects": [
540
- {
541
- "type": "string",
542
- "possible_values": [
543
- "h",
544
- "v",
545
- "hv"
546
- ]
547
- }
548
- ],
549
- "url": "https://www.imgix.com/docs/reference/rotation#param-flip",
550
- "short_description": "Flips an image on a specified axis."
551
- },
552
- "fm": {
553
- "display_name": "output format",
554
- "category": "format",
555
- "expects": [
556
- {
557
- "type": "string",
558
- "possible_values": [
559
- "gif",
560
- "jpg",
561
- "jp2",
562
- "json",
563
- "jxr",
564
- "pjpg",
565
- "mp4",
566
- "png",
567
- "png8",
568
- "png32",
569
- "webp"
570
- ]
571
- }
572
- ],
573
- "url": "https://www.imgix.com/docs/reference/format#param-fm",
574
- "short_description": "Changes the format of the output image."
575
- },
576
- "gam": {
577
- "display_name": "gamma",
578
- "category": "adjustment",
579
- "expects": [
580
- {
581
- "type": "number",
582
- "min": -100,
583
- "max": 100
584
- }
585
- ],
586
- "default": 0,
587
- "url": "https://www.imgix.com/docs/reference/adjustment#param-gam",
588
- "short_description": "Adjusts the gamma of the source image."
589
- },
590
- "h": {
591
- "display_name": "height",
592
- "category": "size",
593
- "expects": [
594
- {
595
- "type": "number"
596
- },
597
- {
598
- "type": "unit_scalar"
599
- }
600
- ],
601
- "url": "https://www.imgix.com/docs/reference/size#param-h",
602
- "short_description": "Adjusts the height of the output image."
603
- },
604
- "high": {
605
- "display_name": "high",
606
- "category": "adjustment",
607
- "expects": [
608
- {
609
- "type": "number",
610
- "min": -100,
611
- "max": 100
612
- }
613
- ],
614
- "default": 0,
615
- "url": "https://www.imgix.com/docs/reference/adjustment#param-high",
616
- "short_description": "Adjusts the highlights of the source image."
617
- },
618
- "htn": {
619
- "display_name": "halftone",
620
- "category": "stylize",
621
- "expects": [
622
- {
623
- "type": "number",
624
- "min": 0,
625
- "max": 100
626
- }
627
- ],
628
- "default": 0,
629
- "url": "https://www.imgix.com/docs/reference/stylize#param-htn",
630
- "short_description": "Applies a half-tone effect to the source image."
631
- },
632
- "hue": {
633
- "display_name": "hue shift",
634
- "category": "adjustment",
635
- "expects": [
636
- {
637
- "type": "number",
638
- "min": 0,
639
- "max": 360
640
- }
641
- ],
642
- "default": 0,
643
- "url": "https://www.imgix.com/docs/reference/adjustment#param-hue",
644
- "short_description": "Adjusts the hue of the source image."
645
- },
646
- "invert": {
647
- "display_name": "invert",
648
- "category": "adjustment",
649
- "expects": [
650
- {
651
- "type": "string",
652
- "possible_values": [
653
- "true"
654
- ]
655
- }
656
- ],
657
- "url": "https://www.imgix.com/docs/reference/adjustment#param-invert",
658
- "short_description": "Inverts the colors on the source image."
659
- },
660
- "lossless": {
661
- "display_name": "lossless",
662
- "category": "format",
663
- "expects": [
664
- {
665
- "type": "integer",
666
- "possible_values": [
667
- 0,
668
- 1
669
- ]
670
- },
671
- {
672
- "type": "string",
673
- "possible_values": [
674
- "false",
675
- "true"
676
- ]
677
- }
678
- ],
679
- "default": "false",
680
- "depends": [
681
- "fm=webp",
682
- "fm=jxr"
683
- ],
684
- "url": "https://www.imgix.com/docs/reference/format#param-fm",
685
- "short_description": "Specifies that the output image should be a lossless variant."
686
- },
687
- "mark": {
688
- "display_name": "watermark image",
689
- "category": "watermark",
690
- "expects": [
691
- {
692
- "type": "url"
693
- }
694
- ],
695
- "aliases": [
696
- "m"
697
- ],
698
- "url": "https://www.imgix.com/docs/reference/watermark#param-mark",
699
- "short_description": "Specifies the location of the watermark image."
700
- },
701
- "markalign": {
702
- "display_name": "watermark alignment mode",
703
- "category": "watermark",
704
- "expects": [
705
- {
706
- "type": "list",
707
- "possible_values": [
708
- "top",
709
- "middle",
710
- "bottom",
711
- "left",
712
- "center",
713
- "right"
714
- ]
715
- }
716
- ],
717
- "aliases": [
718
- "ma"
719
- ],
720
- "depends": [
721
- "mark"
722
- ],
723
- "url": "https://www.imgix.com/docs/reference/watermark#param-markalign",
724
- "short_description": "Changes the watermark alignment relative to the parent image."
725
- },
726
- "markalpha": {
727
- "display_name": "watermark alpha",
728
- "category": "watermark",
729
- "expects": [
730
- {
731
- "type": "integer",
732
- "min": 0,
733
- "max": 100
734
- }
735
- ],
736
- "default": 100,
737
- "depends": [
738
- "mark"
739
- ],
740
- "url": "https://www.imgix.com/docs/reference/watermark#param-markalpha",
741
- "short_description": "Changes the alpha of the watermark image."
742
- },
743
- "markbase": {
744
- "display_name": "watermark url base",
745
- "category": "watermark",
746
- "expects": [
747
- {
748
- "type": "url"
749
- }
750
- ],
751
- "aliases": [
752
- "mb"
753
- ],
754
- "depends": [
755
- "mark"
756
- ],
757
- "short_description": "Changes base URL of the watermark image."
758
- },
759
- "markfit": {
760
- "display_name": "watermark fit mode",
761
- "category": "watermark",
762
- "expects": [
763
- {
764
- "type": "string",
765
- "possible_values": [
766
- "clip",
767
- "crop",
768
- "fill",
769
- "max",
770
- "scale"
771
- ]
772
- }
773
- ],
774
- "default": "clip",
775
- "aliases": [
776
- "mf"
777
- ],
778
- "depends": [
779
- "mark",
780
- "markw",
781
- "markh"
782
- ],
783
- "url": "https://www.imgix.com/docs/reference/watermark#param-markfit",
784
- "short_description": "Specifies the fit mode for watermark images."
785
- },
786
- "markh": {
787
- "display_name": "watermark height",
788
- "category": "watermark",
789
- "expects": [
790
- {
791
- "type": "number"
792
- },
793
- {
794
- "type": "unit_scalar"
795
- }
796
- ],
797
- "aliases": [
798
- "mh"
799
- ],
800
- "depends": [
801
- "mark"
802
- ],
803
- "url": "https://www.imgix.com/docs/reference/watermark#param-markh",
804
- "short_description": "Adjusts the height of the watermark image."
805
- },
806
- "markpad": {
807
- "display_name": "watermark padding",
808
- "category": "watermark",
809
- "expects": [
810
- {
811
- "type": "number"
812
- }
813
- ],
814
- "default": 10,
815
- "aliases": [
816
- "mp"
817
- ],
818
- "depends": [
819
- "mark"
820
- ],
821
- "url": "https://www.imgix.com/docs/reference/watermark#param-markpad",
822
- "short_description": "Applies padding to the watermark image."
823
- },
824
- "markscale": {
825
- "display_name": "watermark scale",
826
- "category": "watermark",
827
- "expects": [
828
- {
829
- "type": "number",
830
- "min": 0,
831
- "max": 100
832
- }
833
- ],
834
- "aliases": [
835
- "ms"
836
- ],
837
- "depends": [
838
- "mark"
839
- ],
840
- "url": "https://www.imgix.com/docs/reference/watermark#param-markscale",
841
- "short_description": "Adjusts the scale of the watermark image."
842
- },
843
- "markw": {
844
- "display_name": "watermark width",
845
- "category": "watermark",
846
- "expects": [
847
- {
848
- "type": "number"
849
- },
850
- {
851
- "type": "unit_scalar"
852
- }
853
- ],
854
- "aliases": [
855
- "mw"
856
- ],
857
- "depends": [
858
- "mark"
859
- ],
860
- "url": "https://www.imgix.com/docs/reference/watermark#param-markw",
861
- "short_description": "Adjusts the width of the watermark image."
862
- },
863
- "markx": {
864
- "display_name": "watermark x-position",
865
- "category": "watermark",
866
- "expects": [
867
- {
868
- "type": "integer"
869
- }
870
- ],
871
- "aliases": [
872
- "mx"
873
- ],
874
- "depends": [
875
- "mark"
876
- ],
877
- "url": "https://www.imgix.com/docs/reference/watermark#param-markx",
878
- "short_description": "Adjusts the x-offset of the watermark image relative to its parent."
879
- },
880
- "marky": {
881
- "display_name": "watermark y-position",
882
- "category": "watermark",
883
- "expects": [
884
- {
885
- "type": "integer"
886
- }
887
- ],
888
- "aliases": [
889
- "my"
890
- ],
891
- "depends": [
892
- "mark"
893
- ],
894
- "url": "https://www.imgix.com/docs/reference/watermark#param-marky",
895
- "short_description": "Adjusts the y-offset of the watermark image relative to its parent."
896
- },
897
- "mask": {
898
- "display_name": "mask",
899
- "category": "mask",
900
- "expects": [
901
- {
902
- "type": "string",
903
- "possible_values": [
904
- "ellipse"
905
- ]
906
- },
907
- {
908
- "type": "url"
909
- }
910
- ],
911
- "url": "https://www.imgix.com/docs/reference/mask#param-mask",
912
- "short_description": "Specifies the location of the mask image."
913
- },
914
- "mono": {
915
- "display_name": "monochrome",
916
- "category": "stylize",
917
- "expects": [
918
- {
919
- "type": "hex_color"
920
- }
921
- ],
922
- "aliases": [
923
- "monochrome"
924
- ],
925
- "url": "https://www.imgix.com/docs/reference/stylize#param-mono",
926
- "short_description": "Applies a monochrome effect to the source image."
927
- },
928
- "nr": {
929
- "display_name": "noise blur",
930
- "category": "noise",
931
- "expects": [
932
- {
933
- "type": "number",
934
- "min": -100,
935
- "max": 100
936
- }
937
- ],
938
- "default": 20,
939
- "url": "https://www.imgix.com/docs/reference/noise#param-nr",
940
- "short_description": "Reduces the noise in an image."
941
- },
942
- "nrs": {
943
- "display_name": "noise sharpen",
944
- "category": "noise",
945
- "expects": [
946
- {
947
- "type": "number",
948
- "min": -100,
949
- "max": 100
950
- }
951
- ],
952
- "default": 20,
953
- "url": "https://www.imgix.com/docs/reference/noise#param-nrs",
954
- "short_description": "Provides a threshold by which to sharpen an image."
955
- },
956
- "or": {
957
- "display_name": "orientation",
958
- "category": "rotation",
959
- "expects": [
960
- {
961
- "type": "integer",
962
- "possible_values": [
963
- 0,
964
- 1,
965
- 2,
966
- 3,
967
- 4,
968
- 5,
969
- 6,
970
- 7,
971
- 8,
972
- 90,
973
- 180,
974
- 270
975
- ]
976
- }
977
- ],
978
- "aliases": [
979
- "orient"
980
- ],
981
- "url": "https://www.imgix.com/docs/reference/rotation#param-or",
982
- "short_description": "Changes the image orientation."
983
- },
984
- "pad": {
985
- "display_name": "padding",
986
- "category": "border_and_padding",
987
- "expects": [
988
- {
989
- "type": "integer",
990
- "min": 0
991
- }
992
- ],
993
- "default": 0,
994
- "url": "https://www.imgix.com/docs/reference/border-padding#param-pad",
995
- "short_description": "Pads an image."
996
- },
997
- "page": {
998
- "display_name": "pdf page number",
999
- "category": "pdf",
1000
- "expects": [
1001
- {
1002
- "type": "integer",
1003
- "min": 1
1004
- }
1005
- ],
1006
- "default": 1,
1007
- "url": "https://www.imgix.com/docs/reference/pdf#param-page",
1008
- "short_description": "Selects a page from a PDF for display."
1009
- },
1010
- "palette": {
1011
- "display_name": "palette extraction",
1012
- "category": "palette",
1013
- "expects": [
1014
- {
1015
- "type": "string",
1016
- "possible_values": [
1017
- "css",
1018
- "json"
1019
- ]
1020
- }
1021
- ],
1022
- "url": "https://www.imgix.com/docs/reference/palette#param-palette",
1023
- "short_description": "Specifies an output format for palette-extraction."
1024
- },
1025
- "prefix": {
1026
- "display_name": "css prefix",
1027
- "category": "palette",
1028
- "expects": [
1029
- {
1030
- "type": "string"
1031
- }
1032
- ],
1033
- "default": "image",
1034
- "depends": [
1035
- "palette=css"
1036
- ],
1037
- "url": "https://www.imgix.com/docs/reference/palette#param-prefix",
1038
- "short_description": "Specifies a CSS prefix for all classes in palette-extraction."
1039
- },
1040
- "px": {
1041
- "display_name": "pixellate",
1042
- "category": "stylize",
1043
- "expects": [
1044
- {
1045
- "type": "number",
1046
- "min": 0,
1047
- "max": 100
1048
- }
1049
- ],
1050
- "default": 0,
1051
- "url": "https://www.imgix.com/docs/reference/stylize#param-px",
1052
- "short_description": "Applies a pixelation effect to an image."
1053
- },
1054
- "q": {
1055
- "display_name": "output quality",
1056
- "category": "format",
1057
- "expects": [
1058
- {
1059
- "type": "number",
1060
- "min": 0,
1061
- "max": 100
1062
- }
1063
- ],
1064
- "default": 75,
1065
- "depends": [
1066
- "fm=jpg",
1067
- "fm=pjpg",
1068
- "fm=webp",
1069
- "fm=jxr"
1070
- ],
1071
- "url": "https://www.imgix.com/docs/reference/format#param-q",
1072
- "short_description": "Adjusts the quality of an output image."
1073
- },
1074
- "rect": {
1075
- "display_name": "crop rectangle",
1076
- "category": "size",
1077
- "expects": [
1078
- {
1079
- "0": {
1080
- "type": "number",
1081
- "min": 0
1082
- },
1083
- "1": {
1084
- "type": "number",
1085
- "min": 0
1086
- },
1087
- "2": {
1088
- "type": "number",
1089
- "min": 0
1090
- },
1091
- "3": {
1092
- "type": "number",
1093
- "min": 0
1094
- },
1095
- "type": "list"
1096
- }
1097
- ],
1098
- "url": "https://www.imgix.com/docs/reference/size#param-rect",
1099
- "short_description": "Crops an image to a specified rectangle."
1100
- },
1101
- "rot": {
1102
- "display_name": "rotation angle",
1103
- "category": "rotation",
1104
- "expects": [
1105
- {
1106
- "type": "number",
1107
- "min": 0,
1108
- "max": 359
1109
- }
1110
- ],
1111
- "default": 0,
1112
- "url": "https://www.imgix.com/docs/reference/rotation#param-rot",
1113
- "short_description": "Rotates an image by a specified number of degrees."
1114
- },
1115
- "sat": {
1116
- "display_name": "saturation",
1117
- "category": "adjustment",
1118
- "expects": [
1119
- {
1120
- "type": "number",
1121
- "min": -100,
1122
- "max": 100
1123
- }
1124
- ],
1125
- "default": 0,
1126
- "url": "https://www.imgix.com/docs/reference/adjustment#param-sat",
1127
- "short_description": "Adjusts the saturation of an image."
1128
- },
1129
- "sepia": {
1130
- "display_name": "sepia",
1131
- "category": "stylize",
1132
- "expects": [
1133
- {
1134
- "type": "number",
1135
- "min": 0,
1136
- "max": 100
1137
- }
1138
- ],
1139
- "default": 0,
1140
- "url": "https://www.imgix.com/docs/reference/stylize#param-sepia",
1141
- "short_description": "Applies a sepia effect to an image."
1142
- },
1143
- "shad": {
1144
- "display_name": "shadow",
1145
- "category": "adjustment",
1146
- "expects": [
1147
- {
1148
- "type": "number",
1149
- "min": -100,
1150
- "max": 100
1151
- }
1152
- ],
1153
- "default": 0,
1154
- "url": "https://www.imgix.com/docs/reference/adjustment#param-shad",
1155
- "short_description": "Adjusts the highlights of the source image."
1156
- },
1157
- "sharp": {
1158
- "display_name": "sharpen",
1159
- "category": "adjustment",
1160
- "expects": [
1161
- {
1162
- "type": "number",
1163
- "min": 0,
1164
- "max": 100
1165
- }
1166
- ],
1167
- "default": 0,
1168
- "url": "https://www.imgix.com/docs/reference/adjustment#param-sharp",
1169
- "short_description": "Adjusts the sharpness of the source image."
1170
- },
1171
- "trim": {
1172
- "display_name": "trim mode",
1173
- "category": "trim",
1174
- "expects": [
1175
- {
1176
- "type": "string",
1177
- "possible_values": [
1178
- "auto",
1179
- "color"
1180
- ]
1181
- }
1182
- ],
1183
- "url": "https://www.imgix.com/docs/reference/trim#param-trim",
1184
- "short_description": "Trims the source image."
1185
- },
1186
- "trimcolor": {
1187
- "display_name": "trim color",
1188
- "category": "trim",
1189
- "expects": [
1190
- {
1191
- "type": "hex_color"
1192
- }
1193
- ],
1194
- "depends": [
1195
- "trim=color"
1196
- ],
1197
- "url": "https://www.imgix.com/docs/reference/trim#param-trimcolor",
1198
- "short_description": "Specifies a trim color on a trim operation."
1199
- },
1200
- "trimmd": {
1201
- "display_name": "trim mean difference",
1202
- "category": "trim",
1203
- "expects": [
1204
- {
1205
- "type": "number"
1206
- }
1207
- ],
1208
- "default": 11,
1209
- "depends": [
1210
- "trim=auto"
1211
- ],
1212
- "url": "https://www.imgix.com/docs/reference/text#param-trimmd",
1213
- "short_description": "Specifies the mean difference on a trim operation."
1214
- },
1215
- "trimsd": {
1216
- "display_name": "trim standard deviation",
1217
- "category": "trim",
1218
- "expects": [
1219
- {
1220
- "type": "number"
1221
- }
1222
- ],
1223
- "default": 10,
1224
- "depends": [
1225
- "trim=auto"
1226
- ],
1227
- "url": "https://www.imgix.com/docs/reference/trim#param-trimsd",
1228
- "short_description": "Specifies the standard deviation on a trim operation."
1229
- },
1230
- "trimtol": {
1231
- "display_name": "trim tolerance",
1232
- "category": "trim",
1233
- "expects": [
1234
- {
1235
- "type": "number",
1236
- "min": 0
1237
- }
1238
- ],
1239
- "default": 0,
1240
- "depends": [
1241
- "trim=color"
1242
- ],
1243
- "url": "https://www.imgix.com/docs/reference/trim#param-trimtol",
1244
- "short_description": "Specifies the tolerance on a trim operation."
1245
- },
1246
- "txt": {
1247
- "display_name": "text",
1248
- "category": "text",
1249
- "expects": [
1250
- {
1251
- "type": "string"
1252
- }
1253
- ],
1254
- "aliases": [
1255
- "t"
1256
- ],
1257
- "url": "https://www.imgix.com/docs/reference/text#param-txt",
1258
- "short_description": "Sets the text to render."
1259
- },
1260
- "txtalign": {
1261
- "display_name": "text align",
1262
- "category": "text",
1263
- "expects": [
1264
- {
1265
- "type": "list",
1266
- "possible_values": [
1267
- "top",
1268
- "middle",
1269
- "bottom",
1270
- "left",
1271
- "center",
1272
- "right"
1273
- ]
1274
- }
1275
- ],
1276
- "aliases": [
1277
- "ta"
1278
- ],
1279
- "depends": [
1280
- "txt"
1281
- ],
1282
- "url": "https://www.imgix.com/docs/reference/text#param-txtalign",
1283
- "short_description": "Sets the alignment of rendered text."
1284
- },
1285
- "txtclip": {
1286
- "display_name": "text clipping",
1287
- "category": "text",
1288
- "expects": [
1289
- {
1290
- "type": "string",
1291
- "possible_values": [
1292
- "start",
1293
- "middle",
1294
- "end",
1295
- "ellipsis"
1296
- ]
1297
- }
1298
- ],
1299
- "default": "end",
1300
- "aliases": [
1301
- "tcl"
1302
- ],
1303
- "depends": [
1304
- "txt"
1305
- ],
1306
- "url": "https://www.imgix.com/docs/reference/text#param-txtclip",
1307
- "short_description": "Sets the clipping properties of rendered text."
1308
- },
1309
- "txtclr": {
1310
- "display_name": "text color",
1311
- "category": "text",
1312
- "expects": [
1313
- {
1314
- "type": "hex_color"
1315
- }
1316
- ],
1317
- "aliases": [
1318
- "txtcolor",
1319
- "tc"
1320
- ],
1321
- "depends": [
1322
- "txt"
1323
- ],
1324
- "url": "https://www.imgix.com/docs/reference/text#param-txtclr",
1325
- "short_description": "Specifies the color of rendered text"
1326
- },
1327
- "txtfit": {
1328
- "display_name": "text fit mode",
1329
- "category": "text",
1330
- "expects": [
1331
- {
1332
- "type": "string",
1333
- "possible_values": [
1334
- "max"
1335
- ]
1336
- }
1337
- ],
1338
- "depends": [
1339
- "txt"
1340
- ],
1341
- "url": "https://www.imgix.com/docs/reference/text#param-txtfit",
1342
- "short_description": "Specifies the fit approach for rendered text."
1343
- },
1344
- "txtfont": {
1345
- "display_name": "text font",
1346
- "category": "text",
1347
- "expects": [
1348
- {
1349
- "type": "list"
1350
- }
1351
- ],
1352
- "aliases": [
1353
- "tf"
1354
- ],
1355
- "depends": [
1356
- "txt"
1357
- ],
1358
- "url": "https://www.imgix.com/docs/reference/text#param-txtfont",
1359
- "short_description": "Selects a font for rendered text."
1360
- },
1361
- "txtline": {
1362
- "display_name": "text outline",
1363
- "category": "text",
1364
- "expects": [
1365
- {
1366
- "type": "number",
1367
- "min": 0
1368
- }
1369
- ],
1370
- "default": 0,
1371
- "aliases": [
1372
- "tl"
1373
- ],
1374
- "depends": [
1375
- "txt"
1376
- ],
1377
- "url": "https://www.imgix.com/docs/reference/text#param-txtline",
1378
- "short_description": "Outlines the rendered text with a specified color."
1379
- },
1380
- "txtlineclr": {
1381
- "display_name": "text outline color",
1382
- "category": "text",
1383
- "expects": [
1384
- {
1385
- "type": "hex_color"
1386
- }
1387
- ],
1388
- "default": "FFF",
1389
- "aliases": [
1390
- "txtlinecolor"
1391
- ],
1392
- "depends": [
1393
- "txt",
1394
- "txtline"
1395
- ],
1396
- "url": "https://www.imgix.com/docs/reference/text#param-txtlineclr",
1397
- "short_description": "Specifies a text outline color."
1398
- },
1399
- "txtpad": {
1400
- "display_name": "text padding",
1401
- "category": "text",
1402
- "expects": [
1403
- {
1404
- "type": "number"
1405
- }
1406
- ],
1407
- "default": 10,
1408
- "aliases": [
1409
- "tp"
1410
- ],
1411
- "depends": [
1412
- "txt"
1413
- ],
1414
- "url": "https://www.imgix.com/docs/reference/text#param-txtpad",
1415
- "short_description": "Specifies padding for rendered text."
1416
- },
1417
- "txtshad": {
1418
- "display_name": "text shadow",
1419
- "category": "text",
1420
- "expects": [
1421
- {
1422
- "type": "number"
1423
- }
1424
- ],
1425
- "default": 0,
1426
- "aliases": [
1427
- "tsh"
1428
- ],
1429
- "depends": [
1430
- "txt"
1431
- ],
1432
- "url": "https://www.imgix.com/docs/reference/text#param-txtshad",
1433
- "short_description": "Applies a shadow to rendered text."
1434
- },
1435
- "txtsize": {
1436
- "display_name": "text font size",
1437
- "category": "text",
1438
- "expects": [
1439
- {
1440
- "type": "number",
1441
- "min": 0
1442
- }
1443
- ],
1444
- "default": 12,
1445
- "aliases": [
1446
- "tsz"
1447
- ],
1448
- "depends": [
1449
- "txt"
1450
- ],
1451
- "url": "https://www.imgix.com/docs/reference/text#param-txtsize",
1452
- "short_description": "Sets the size of rendered text."
1453
- },
1454
- "txtwidth": {
1455
- "display_name": "text width",
1456
- "category": "text",
1457
- "expects": [
1458
- {
1459
- "type": "number",
1460
- "min": 0
1461
- }
1462
- ],
1463
- "depends": [
1464
- "txt"
1465
- ],
1466
- "url": "https://www.imgix.com/docs/reference/text#param-txtwidth",
1467
- "short_description": "Sets the width of rendered text."
1468
- },
1469
- "usm": {
1470
- "display_name": "unsharp mask",
1471
- "category": "adjustment",
1472
- "expects": [
1473
- {
1474
- "type": "number",
1475
- "min": -100,
1476
- "max": 100
1477
- }
1478
- ],
1479
- "default": 0,
1480
- "url": "https://www.imgix.com/docs/reference/adjustment#param-usm",
1481
- "short_description": "Sharpens the source image using an unsharp mask."
1482
- },
1483
- "usmrad": {
1484
- "display_name": "unsharp mask radius",
1485
- "category": "adjustment",
1486
- "expects": [
1487
- {
1488
- "type": "number",
1489
- "min": 0
1490
- }
1491
- ],
1492
- "default": 2.5,
1493
- "depends": [
1494
- "usm"
1495
- ],
1496
- "url": "https://www.imgix.com/docs/reference/adjustment#param-usmrad",
1497
- "short_description": "Specifies the radius for an unsharp mask operation."
1498
- },
1499
- "vib": {
1500
- "display_name": "vibrance",
1501
- "category": "adjustment",
1502
- "expects": [
1503
- {
1504
- "type": "number",
1505
- "min": -100,
1506
- "max": 100
1507
- }
1508
- ],
1509
- "default": 0,
1510
- "url": "https://www.imgix.com/docs/reference/adjustment#param-vib",
1511
- "short_description": "Adjusts the vibrance an image."
1512
- },
1513
- "w": {
1514
- "display_name": "width",
1515
- "category": "size",
1516
- "expects": [
1517
- {
1518
- "type": "number"
1519
- },
1520
- {
1521
- "type": "unit_scalar"
1522
- }
1523
- ],
1524
- "url": "https://www.imgix.com/docs/reference/size#param-w",
1525
- "short_description": "Adjusts the width of the output image."
1526
- }
1527
- },
1528
- "deprecatedParameters": {
1529
- "class": {
1530
- "display_name": "css class",
1531
- "category": "palette",
1532
- "expects": [
1533
- {
1534
- "type": "string"
1535
- }
1536
- ],
1537
- "depends": [
1538
- "palette=css"
1539
- ],
1540
- "deprecated": true,
1541
- "url": "https://www.imgix.com/docs/reference/palette#param-colors",
1542
- "short_description": "Specifies the CSS class to use for palette extraction."
1543
- },
1544
- "skin": {
1545
- "display_name": "skin detection",
1546
- "category": "misc",
1547
- "expects": [
1548
- {
1549
- "type": "string",
1550
- "possible_values": [
1551
- "map"
1552
- ]
1553
- }
1554
- ],
1555
- "experimental": true,
1556
- "deprecated": true
1557
- }
1558
- },
1559
- "experimentalParameters": {
1560
- "fps": {
1561
- "display_name": "frames per second",
1562
- "category": "animation",
1563
- "expects": [
1564
- {
1565
- "type": "number"
1566
- }
1567
- ],
1568
- "experimental": true,
1569
- "short_description": "Specifies the framerate of the generated image."
1570
- },
1571
- "frame": {
1572
- "display_name": "frame number",
1573
- "category": "animation",
1574
- "expects": [
1575
- {
1576
- "type": "integer",
1577
- "min": 1
1578
- }
1579
- ],
1580
- "experimental": true,
1581
- "short_description": "Specifies the frame of an animated image to use."
1582
- },
1583
- "loop": {
1584
- "display_name": "animation loop count",
1585
- "category": "animation",
1586
- "expects": [
1587
- {
1588
- "type": "integer",
1589
- "min": 0
1590
- }
1591
- ],
1592
- "default": 0,
1593
- "experimental": true,
1594
- "short_description": "Specifies the number of times an animated image should repeat. A value of 0 means infinite looping."
1595
- },
1596
- "reverse": {
1597
- "display_name": "frame number",
1598
- "category": "animation",
1599
- "expects": [
1600
- {
1601
- "type": "integer",
1602
- "possible_values": [
1603
- 0,
1604
- 1
1605
- ]
1606
- },
1607
- {
1608
- "type": "string",
1609
- "possible_values": [
1610
- "false",
1611
- "true"
1612
- ]
1613
- }
1614
- ],
1615
- "default": "false",
1616
- "experimental": true,
1617
- "short_description": "Reverses the frame order on the source animation."
1618
- },
1619
- "rott": {
1620
- "display_name": "rotation type",
1621
- "category": "rotation",
1622
- "expects": [
1623
- {
1624
- "type": "string",
1625
- "possible_values": [
1626
- "pivot",
1627
- "straighten"
1628
- ]
1629
- }
1630
- ],
1631
- "experimental": true,
1632
- "short_description": "Changes the rotation type."
1633
- },
1634
- "skin": {
1635
- "display_name": "skin detection",
1636
- "category": "misc",
1637
- "expects": [
1638
- {
1639
- "type": "string",
1640
- "possible_values": [
1641
- "map"
1642
- ]
1643
- }
1644
- ],
1645
- "experimental": true,
1646
- "deprecated": true
1647
- },
1648
- "txtlead": {
1649
- "display_name": "text leading",
1650
- "category": "text",
1651
- "expects": [
1652
- {
1653
- "type": "number",
1654
- "min": 0
1655
- }
1656
- ],
1657
- "default": 0,
1658
- "depends": [
1659
- "txt"
1660
- ],
1661
- "experimental": true,
1662
- "short_description": "Sets the leading for rendered text. Only works on the multi-line text endpoint."
1663
- },
1664
- "txttrack": {
1665
- "display_name": "text tracking",
1666
- "category": "text",
1667
- "expects": [
1668
- {
1669
- "type": "number",
1670
- "min": -4
1671
- }
1672
- ],
1673
- "default": 0,
1674
- "aliases": [
1675
- "tt"
1676
- ],
1677
- "depends": [
1678
- "txt"
1679
- ],
1680
- "experimental": true,
1681
- "short_description": "Sets the tracking for rendered text. Only works on the multi-line text endpoint."
1682
- }
1683
- },
1684
- "aliases": {
1685
- "f": "fit",
1686
- "m": "mark",
1687
- "ma": "markalign",
1688
- "mb": "markbase",
1689
- "mf": "markfit",
1690
- "mh": "markh",
1691
- "mp": "markpad",
1692
- "ms": "markscale",
1693
- "mw": "markw",
1694
- "mx": "markx",
1695
- "my": "marky",
1696
- "monochrome": "mono",
1697
- "orient": "or",
1698
- "t": "txt",
1699
- "ta": "txtalign",
1700
- "tcl": "txtclip",
1701
- "txtcolor": "txtclr",
1702
- "tc": "txtclr",
1703
- "tf": "txtfont",
1704
- "tl": "txtline",
1705
- "txtlinecolor": "txtlineclr",
1706
- "tp": "txtpad",
1707
- "tsh": "txtshad",
1708
- "tsz": "txtsize",
1709
- "tt": "txttrack"
1710
- },
1711
- "version": "2.3.1"
1712
- }