imgix-url-builder 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -0
- package/README.md +108 -0
- package/dist/index.cjs +59 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.ts +2602 -0
- package/dist/index.mjs +52 -0
- package/dist/index.mjs.map +1 -0
- package/dist/node/index.cjs +118 -0
- package/dist/node/index.cjs.map +1 -0
- package/dist/node/index.d.ts +3053 -0
- package/dist/node/index.d.ts.map +1 -0
- package/dist/node/index.mjs +109 -0
- package/dist/node/index.mjs.map +1 -0
- package/package.json +81 -0
- package/src/Client.ts +164 -0
- package/src/buildPixelDensitySrcSet.ts +70 -0
- package/src/buildURL.ts +63 -0
- package/src/buildWidthSrcSet.ts +66 -0
- package/src/index.ts +17 -0
- package/src/node/SecureClient.ts +565 -0
- package/src/node/buildSignedPixelDensitySrcSet.ts +67 -0
- package/src/node/buildSignedURL.ts +56 -0
- package/src/node/buildSignedWidthSrcSet.ts +68 -0
- package/src/node/index.ts +19 -0
- package/src/node/signURL.ts +44 -0
- package/src/types.generated.ts +2822 -0
|
@@ -0,0 +1,2822 @@
|
|
|
1
|
+
// Types generated using `imgix-url-params` as a source.
|
|
2
|
+
|
|
3
|
+
export type Ratio = `${number}:${number}`;
|
|
4
|
+
export type ColorKeyword =
|
|
5
|
+
| "aliceblue"
|
|
6
|
+
| "antiquewhite"
|
|
7
|
+
| "aqua"
|
|
8
|
+
| "aquamarine"
|
|
9
|
+
| "azure"
|
|
10
|
+
| "beige"
|
|
11
|
+
| "bisque"
|
|
12
|
+
| "black"
|
|
13
|
+
| "blanchedalmond"
|
|
14
|
+
| "blue"
|
|
15
|
+
| "blueviolet"
|
|
16
|
+
| "brown"
|
|
17
|
+
| "burlywood"
|
|
18
|
+
| "cadetblue"
|
|
19
|
+
| "chartreuse"
|
|
20
|
+
| "chocolate"
|
|
21
|
+
| "coral"
|
|
22
|
+
| "cornflowerblue"
|
|
23
|
+
| "cornsilk"
|
|
24
|
+
| "crimson"
|
|
25
|
+
| "cyan"
|
|
26
|
+
| "darkblue"
|
|
27
|
+
| "darkcyan"
|
|
28
|
+
| "darkgoldenrod"
|
|
29
|
+
| "darkgray"
|
|
30
|
+
| "darkgreen"
|
|
31
|
+
| "darkgrey"
|
|
32
|
+
| "darkkhaki"
|
|
33
|
+
| "darkmagenta"
|
|
34
|
+
| "darkolivegreen"
|
|
35
|
+
| "darkorange"
|
|
36
|
+
| "darkorchid"
|
|
37
|
+
| "darkred"
|
|
38
|
+
| "darksalmon"
|
|
39
|
+
| "darkseagreen"
|
|
40
|
+
| "darkslateblue"
|
|
41
|
+
| "darkslategray"
|
|
42
|
+
| "darkslategrey"
|
|
43
|
+
| "darkturquoise"
|
|
44
|
+
| "darkviolet"
|
|
45
|
+
| "deeppink"
|
|
46
|
+
| "deepskyblue"
|
|
47
|
+
| "dimgray"
|
|
48
|
+
| "dimgrey"
|
|
49
|
+
| "dodgerblue"
|
|
50
|
+
| "firebrick"
|
|
51
|
+
| "floralwhite"
|
|
52
|
+
| "forestgreen"
|
|
53
|
+
| "fuchsia"
|
|
54
|
+
| "gainsboro"
|
|
55
|
+
| "ghostwhite"
|
|
56
|
+
| "gold"
|
|
57
|
+
| "goldenrod"
|
|
58
|
+
| "gray"
|
|
59
|
+
| "green"
|
|
60
|
+
| "greenyellow"
|
|
61
|
+
| "grey"
|
|
62
|
+
| "honeydew"
|
|
63
|
+
| "hotpink"
|
|
64
|
+
| "imgixorange"
|
|
65
|
+
| "imgixblue"
|
|
66
|
+
| "indianred"
|
|
67
|
+
| "indigo"
|
|
68
|
+
| "ivory"
|
|
69
|
+
| "khaki"
|
|
70
|
+
| "lavender"
|
|
71
|
+
| "lavenderblush"
|
|
72
|
+
| "lawngreen"
|
|
73
|
+
| "lemonchiffon"
|
|
74
|
+
| "lightblue"
|
|
75
|
+
| "lightcoral"
|
|
76
|
+
| "lightcyan"
|
|
77
|
+
| "lightgoldenrodyellow"
|
|
78
|
+
| "lightgray"
|
|
79
|
+
| "lightgreen"
|
|
80
|
+
| "lightgrey"
|
|
81
|
+
| "lightpink"
|
|
82
|
+
| "lightsalmon"
|
|
83
|
+
| "lightseagreen"
|
|
84
|
+
| "lightskyblue"
|
|
85
|
+
| "lightslategray"
|
|
86
|
+
| "lightslategrey"
|
|
87
|
+
| "lightsteelblue"
|
|
88
|
+
| "lightyellow"
|
|
89
|
+
| "lime"
|
|
90
|
+
| "limegreen"
|
|
91
|
+
| "linen"
|
|
92
|
+
| "magenta"
|
|
93
|
+
| "maroon"
|
|
94
|
+
| "mediumaquamarine"
|
|
95
|
+
| "mediumblue"
|
|
96
|
+
| "mediumorchid"
|
|
97
|
+
| "mediumpurple"
|
|
98
|
+
| "mediumseagreen"
|
|
99
|
+
| "mediumslateblue"
|
|
100
|
+
| "mediumspringgreen"
|
|
101
|
+
| "mediumturquoise"
|
|
102
|
+
| "mediumvioletred"
|
|
103
|
+
| "midnightblue"
|
|
104
|
+
| "mintcream"
|
|
105
|
+
| "mistyrose"
|
|
106
|
+
| "moccasin"
|
|
107
|
+
| "navajowhite"
|
|
108
|
+
| "navy"
|
|
109
|
+
| "oldlace"
|
|
110
|
+
| "olive"
|
|
111
|
+
| "olivedrab"
|
|
112
|
+
| "orange"
|
|
113
|
+
| "orangered"
|
|
114
|
+
| "orchid"
|
|
115
|
+
| "palegoldenrod"
|
|
116
|
+
| "palegreen"
|
|
117
|
+
| "paleturquoise"
|
|
118
|
+
| "palevioletred"
|
|
119
|
+
| "papayawhip"
|
|
120
|
+
| "peachpuff"
|
|
121
|
+
| "peru"
|
|
122
|
+
| "pink"
|
|
123
|
+
| "plum"
|
|
124
|
+
| "powderblue"
|
|
125
|
+
| "purple"
|
|
126
|
+
| "rebeccapurple"
|
|
127
|
+
| "red"
|
|
128
|
+
| "rosybrown"
|
|
129
|
+
| "royalblue"
|
|
130
|
+
| "saddlebrown"
|
|
131
|
+
| "salmon"
|
|
132
|
+
| "sandybrown"
|
|
133
|
+
| "seagreen"
|
|
134
|
+
| "seashell"
|
|
135
|
+
| "sienna"
|
|
136
|
+
| "silver"
|
|
137
|
+
| "skyblue"
|
|
138
|
+
| "slateblue"
|
|
139
|
+
| "slategray"
|
|
140
|
+
| "slategrey"
|
|
141
|
+
| "snow"
|
|
142
|
+
| "springgreen"
|
|
143
|
+
| "steelblue"
|
|
144
|
+
| "tan"
|
|
145
|
+
| "teal"
|
|
146
|
+
| "thistle"
|
|
147
|
+
| "tomato"
|
|
148
|
+
| "turquoise"
|
|
149
|
+
| "violet"
|
|
150
|
+
| "wheat"
|
|
151
|
+
| "white"
|
|
152
|
+
| "whitesmoke"
|
|
153
|
+
| "yellow"
|
|
154
|
+
| "yellowgreen";
|
|
155
|
+
export type Font =
|
|
156
|
+
| "serif"
|
|
157
|
+
| "sans-serif"
|
|
158
|
+
| "monospace"
|
|
159
|
+
| "cursive"
|
|
160
|
+
| "fantasy"
|
|
161
|
+
| "serif,bold"
|
|
162
|
+
| "sans-serif,bold"
|
|
163
|
+
| "monospace,bold"
|
|
164
|
+
| "fantasy,bold"
|
|
165
|
+
| "serif,italic"
|
|
166
|
+
| "sans-serif,italic"
|
|
167
|
+
| "monospace,italic"
|
|
168
|
+
| "serif,bold,italic"
|
|
169
|
+
| "sans-serif,bold,italic"
|
|
170
|
+
| "monospace,bold,italic"
|
|
171
|
+
| "American Typewriter"
|
|
172
|
+
| "American Typewriter Condensed"
|
|
173
|
+
| "American Typewriter Condensed Light"
|
|
174
|
+
| "American Typewriter Condensed,Bold"
|
|
175
|
+
| "American Typewriter Light"
|
|
176
|
+
| "American Typewriter,Bold"
|
|
177
|
+
| "AndaleMono"
|
|
178
|
+
| "Arial Narrow"
|
|
179
|
+
| "Arial Narrow,Bold"
|
|
180
|
+
| "Arial Narrow,BoldItalic"
|
|
181
|
+
| "Arial Narrow,Italic"
|
|
182
|
+
| "Arial Rounded MT,Bold"
|
|
183
|
+
| "Arial UnicodeMS"
|
|
184
|
+
| "Arial,BoldItalicMT"
|
|
185
|
+
| "Arial,BoldMT"
|
|
186
|
+
| "Arial,ItalicMT"
|
|
187
|
+
| "Arial-Black"
|
|
188
|
+
| "ArialMT"
|
|
189
|
+
| "Athelas,Bold"
|
|
190
|
+
| "Athelas,BoldItalic"
|
|
191
|
+
| "Athelas,Italic"
|
|
192
|
+
| "Athelas-Regular"
|
|
193
|
+
| "Avenir Next Condensed Demi,Bold"
|
|
194
|
+
| "Avenir Next Condensed Demi,BoldItalic"
|
|
195
|
+
| "Avenir Next Condensed Heavy"
|
|
196
|
+
| "Avenir Next Condensed Heavy,Italic"
|
|
197
|
+
| "Avenir Next Condensed Medium"
|
|
198
|
+
| "Avenir Next Condensed Medium,Italic"
|
|
199
|
+
| "Avenir Next Condensed Regular"
|
|
200
|
+
| "Avenir Next Condensed Ultra Light"
|
|
201
|
+
| "Avenir Next Condensed Ultra Light,Italic"
|
|
202
|
+
| "Avenir Next Condensed,Bold"
|
|
203
|
+
| "Avenir Next Condensed,BoldItalic"
|
|
204
|
+
| "Avenir Next Condensed,Italic"
|
|
205
|
+
| "Avenir Next Demi,Bold"
|
|
206
|
+
| "Avenir Next Demi,BoldItalic"
|
|
207
|
+
| "Avenir Next Heavy"
|
|
208
|
+
| "Avenir Next Heavy,Italic"
|
|
209
|
+
| "Avenir Next Medium"
|
|
210
|
+
| "Avenir Next Medium,Italic"
|
|
211
|
+
| "Avenir Next Regular"
|
|
212
|
+
| "Avenir Next Ultra Light"
|
|
213
|
+
| "Avenir Next Ultra Light,Italic"
|
|
214
|
+
| "Avenir Next,Bold"
|
|
215
|
+
| "Avenir Next,BoldItalic"
|
|
216
|
+
| "Avenir Next,Italic"
|
|
217
|
+
| "Avenir-Black"
|
|
218
|
+
| "Avenir-BlackOblique"
|
|
219
|
+
| "Avenir-Book"
|
|
220
|
+
| "Avenir-BookOblique"
|
|
221
|
+
| "Avenir-Heavy"
|
|
222
|
+
| "Avenir-HeavyOblique"
|
|
223
|
+
| "Avenir-Light"
|
|
224
|
+
| "Avenir-LightOblique"
|
|
225
|
+
| "Avenir-Medium"
|
|
226
|
+
| "Avenir-MediumOblique"
|
|
227
|
+
| "Avenir-Oblique"
|
|
228
|
+
| "Avenir-Roman"
|
|
229
|
+
| "Baskerville"
|
|
230
|
+
| "Baskerville,Bold"
|
|
231
|
+
| "Baskerville,BoldItalic"
|
|
232
|
+
| "Baskerville,Italic"
|
|
233
|
+
| "BigCaslon-Medium"
|
|
234
|
+
| "BrushScriptMT"
|
|
235
|
+
| "Chalkboard"
|
|
236
|
+
| "Chalkboard SE Light"
|
|
237
|
+
| "Chalkboard SE Regular"
|
|
238
|
+
| "Chalkboard SE,Bold"
|
|
239
|
+
| "Chalkboard,Bold"
|
|
240
|
+
| "Chalkduster"
|
|
241
|
+
| "CharcoalCY"
|
|
242
|
+
| "Charter Black,Italic"
|
|
243
|
+
| "Charter,Bold"
|
|
244
|
+
| "Charter,BoldItalic"
|
|
245
|
+
| "Charter,Italic"
|
|
246
|
+
| "Charter-Black"
|
|
247
|
+
| "Charter-Roman"
|
|
248
|
+
| "Cochin"
|
|
249
|
+
| "Cochin,Bold"
|
|
250
|
+
| "Cochin,BoldItalic"
|
|
251
|
+
| "Cochin,Italic"
|
|
252
|
+
| "Comic Sans MS,Bold"
|
|
253
|
+
| "ComicSansMS"
|
|
254
|
+
| "Copperplate"
|
|
255
|
+
| "Copperplate,Bold"
|
|
256
|
+
| "Copperplate-Light"
|
|
257
|
+
| "Courier"
|
|
258
|
+
| "Courier New,Bold"
|
|
259
|
+
| "Courier New,BoldItalic"
|
|
260
|
+
| "Courier New,Italic"
|
|
261
|
+
| "Courier,Bold"
|
|
262
|
+
| "Courier-Oblique"
|
|
263
|
+
| "CourierNewPSMT"
|
|
264
|
+
| "DIN Alternate,Bold"
|
|
265
|
+
| "DIN Condensed,Bold"
|
|
266
|
+
| "Didot"
|
|
267
|
+
| "Didot,Bold"
|
|
268
|
+
| "Didot,Italic"
|
|
269
|
+
| "Futura Medium,Italic"
|
|
270
|
+
| "Futura-CondensedMedium"
|
|
271
|
+
| "Futura-Medium"
|
|
272
|
+
| "Geneva"
|
|
273
|
+
| "GenevaCyr"
|
|
274
|
+
| "Georgia"
|
|
275
|
+
| "Georgia,Bold"
|
|
276
|
+
| "Georgia,BoldItalic"
|
|
277
|
+
| "Georgia,Italic"
|
|
278
|
+
| "Gill Sans"
|
|
279
|
+
| "Gill Sans Light,Italic"
|
|
280
|
+
| "Gill Sans,Bold"
|
|
281
|
+
| "Gill Sans,BoldItalic"
|
|
282
|
+
| "Gill Sans,UltraBold"
|
|
283
|
+
| "GillSans,Italic"
|
|
284
|
+
| "GillSans-Light"
|
|
285
|
+
| "Helvetica"
|
|
286
|
+
| "Helvetica CY,Bold"
|
|
287
|
+
| "Helvetica Neue"
|
|
288
|
+
| "Helvetica Neue Condensed Black"
|
|
289
|
+
| "Helvetica Neue Condensed,Bold"
|
|
290
|
+
| "Helvetica Neue Light"
|
|
291
|
+
| "Helvetica Neue Light,Italic"
|
|
292
|
+
| "Helvetica Neue Medium"
|
|
293
|
+
| "Helvetica Neue Medium,Italic"
|
|
294
|
+
| "Helvetica Neue Thin"
|
|
295
|
+
| "Helvetica Neue Thin,Italic"
|
|
296
|
+
| "Helvetica Neue UltraLight"
|
|
297
|
+
| "Helvetica Neue UltraLight,Italic"
|
|
298
|
+
| "Helvetica Neue,Bold"
|
|
299
|
+
| "Helvetica Neue,BoldItalic"
|
|
300
|
+
| "Helvetica Neue,Italic"
|
|
301
|
+
| "Helvetica,Bold"
|
|
302
|
+
| "Helvetica-Light"
|
|
303
|
+
| "Helvetica-LightOblique"
|
|
304
|
+
| "Helvetica-Oblique"
|
|
305
|
+
| "HelveticaCY-Oblique"
|
|
306
|
+
| "HelveticaCY-Plain"
|
|
307
|
+
| "Herculanum"
|
|
308
|
+
| "Hoefler Text Black,Italic"
|
|
309
|
+
| "Hoefler Text,Italic"
|
|
310
|
+
| "HoeflerText-Black"
|
|
311
|
+
| "HoeflerText-Ornaments"
|
|
312
|
+
| "HoeflerText-Regular"
|
|
313
|
+
| "Impact"
|
|
314
|
+
| "Iowan Old Style Black,Italic"
|
|
315
|
+
| "Iowan Old Style,Bold"
|
|
316
|
+
| "Iowan Old Style,BoldItalic"
|
|
317
|
+
| "Iowan Old Style,Italic"
|
|
318
|
+
| "IowanOldStyle-Black"
|
|
319
|
+
| "IowanOldStyle-Roman"
|
|
320
|
+
| "IowanOldStyle-Titling"
|
|
321
|
+
| "Lucida Grande"
|
|
322
|
+
| "Lucida Grande,Bold"
|
|
323
|
+
| "Marion,Bold"
|
|
324
|
+
| "Marion,Italic"
|
|
325
|
+
| "Marion-Regular"
|
|
326
|
+
| "Marker Felt Thin"
|
|
327
|
+
| "Marker Felt Wide"
|
|
328
|
+
| "Menlo,Bold"
|
|
329
|
+
| "Menlo,BoldItalic"
|
|
330
|
+
| "Menlo,Italic"
|
|
331
|
+
| "Menlo-Regular"
|
|
332
|
+
| "Monaco"
|
|
333
|
+
| "Noteworthy,Bold"
|
|
334
|
+
| "Noteworthy-Light"
|
|
335
|
+
| "Optima,Bold"
|
|
336
|
+
| "Optima,BoldItalic"
|
|
337
|
+
| "Optima,Italic"
|
|
338
|
+
| "Optima-ExtraBlack"
|
|
339
|
+
| "Optima-Regular"
|
|
340
|
+
| "PT Mono,Bold"
|
|
341
|
+
| "PT Sans Caption,Bold"
|
|
342
|
+
| "PT Sans Narrow,Bold"
|
|
343
|
+
| "PT Sans,Bold"
|
|
344
|
+
| "PT Sans,BoldItalic"
|
|
345
|
+
| "PT Sans,Italic"
|
|
346
|
+
| "PT Serif Caption,Italic"
|
|
347
|
+
| "PT Serif,Bold"
|
|
348
|
+
| "PT Serif,BoldItalic"
|
|
349
|
+
| "PT Serif,Italic"
|
|
350
|
+
| "PTMono-Regular"
|
|
351
|
+
| "PTSans-Caption"
|
|
352
|
+
| "PTSans-Narrow"
|
|
353
|
+
| "PTSans-Regular"
|
|
354
|
+
| "PTSerif-Caption"
|
|
355
|
+
| "PTSerif-Regular"
|
|
356
|
+
| "Palatino,Bold"
|
|
357
|
+
| "Palatino,BoldItalic"
|
|
358
|
+
| "Palatino,Italic"
|
|
359
|
+
| "Palatino-Roman"
|
|
360
|
+
| "Papyrus"
|
|
361
|
+
| "Papyrus-Condensed"
|
|
362
|
+
| "PlantagenetCherokee"
|
|
363
|
+
| "STBaoli-SC-Regular"
|
|
364
|
+
| "STYuanti-SC-Light"
|
|
365
|
+
| "STYuanti-SC-Regular"
|
|
366
|
+
| "SavoyeLetPlain"
|
|
367
|
+
| "Seravek"
|
|
368
|
+
| "Seravek ExtraLight, Italic"
|
|
369
|
+
| "Seravek Light,Italic"
|
|
370
|
+
| "Seravek Medium,Italic"
|
|
371
|
+
| "Seravek,Bold"
|
|
372
|
+
| "Seravek,BoldItalic"
|
|
373
|
+
| "Seravek,Italic"
|
|
374
|
+
| "Seravek-ExtraLight"
|
|
375
|
+
| "Seravek-Light"
|
|
376
|
+
| "Seravek-Medium"
|
|
377
|
+
| "Skia-Regular"
|
|
378
|
+
| "Skia-Regular_Black"
|
|
379
|
+
| "Skia-Regular_Black-Condensed"
|
|
380
|
+
| "Skia-Regular_Black-Extended"
|
|
381
|
+
| "Skia-Regular_Condensed"
|
|
382
|
+
| "Skia-Regular_Extended"
|
|
383
|
+
| "Skia-Regular_Light"
|
|
384
|
+
| "Skia-Regular_Light-Condensed"
|
|
385
|
+
| "Skia-Regular_Light-Extended"
|
|
386
|
+
| "Snell Roundhand,Bold"
|
|
387
|
+
| "SnellRoundhand"
|
|
388
|
+
| "SnellRoundhand-Black"
|
|
389
|
+
| "Superclarendon Black,Italic"
|
|
390
|
+
| "Superclarendon Light,Italic"
|
|
391
|
+
| "Superclarendon,Bold"
|
|
392
|
+
| "Superclarendon,BoldItalic"
|
|
393
|
+
| "Superclarendon,Italic"
|
|
394
|
+
| "Superclarendon-Black"
|
|
395
|
+
| "Superclarendon-Light"
|
|
396
|
+
| "Superclarendon-Regular"
|
|
397
|
+
| "Tahoma"
|
|
398
|
+
| "Tahoma,Bold"
|
|
399
|
+
| "Times New Roman,Bold"
|
|
400
|
+
| "Times New Roman,BoldItalic"
|
|
401
|
+
| "Times New Roman,Italic"
|
|
402
|
+
| "Times,Bold"
|
|
403
|
+
| "Times,BoldItalic"
|
|
404
|
+
| "Times,Italic"
|
|
405
|
+
| "Times-Roman"
|
|
406
|
+
| "TimesNewRomanPSMT"
|
|
407
|
+
| "Trebuchet MS,Bold"
|
|
408
|
+
| "Trebuchet MS,BoldItalic"
|
|
409
|
+
| "Trebuchet MS,Italic"
|
|
410
|
+
| "TrebuchetMS"
|
|
411
|
+
| "Verdana"
|
|
412
|
+
| "Verdana,Bold"
|
|
413
|
+
| "Verdana,BoldItalic"
|
|
414
|
+
| "Verdana,Italic"
|
|
415
|
+
| "Waseem"
|
|
416
|
+
| "WaseemLight"
|
|
417
|
+
| "Webdings"
|
|
418
|
+
| "Wingdings-Regular"
|
|
419
|
+
| "Wingdings2"
|
|
420
|
+
| "Wingdings3"
|
|
421
|
+
| "Yuanti SC,Bold"
|
|
422
|
+
| "YuppySC-Regular"
|
|
423
|
+
| "Zapf Dingbats"
|
|
424
|
+
| "Zapfino";
|
|
425
|
+
|
|
426
|
+
export interface ImgixURLParams {
|
|
427
|
+
/**
|
|
428
|
+
* Aspect ratio
|
|
429
|
+
*
|
|
430
|
+
* Specifies an aspect ratio to maintain when resizing and cropping the image
|
|
431
|
+
*
|
|
432
|
+
* @see https://docs.imgix.com/apis/url/size/ar
|
|
433
|
+
*/
|
|
434
|
+
ar?: Ratio;
|
|
435
|
+
/**
|
|
436
|
+
* Automatic
|
|
437
|
+
*
|
|
438
|
+
* Applies automatic enhancements to images.
|
|
439
|
+
*
|
|
440
|
+
* @see https://docs.imgix.com/apis/url/auto
|
|
441
|
+
*/
|
|
442
|
+
auto?: ("enhance" | "format" | "redeye" | "compress" | "true")[];
|
|
443
|
+
/**
|
|
444
|
+
* Background color
|
|
445
|
+
*
|
|
446
|
+
* Colors the background of padded and partially-transparent images.
|
|
447
|
+
*
|
|
448
|
+
* @defaultValue `"fff"`
|
|
449
|
+
*
|
|
450
|
+
* @see https://docs.imgix.com/apis/url/bg
|
|
451
|
+
*/
|
|
452
|
+
bg?: string | ColorKeyword;
|
|
453
|
+
/**
|
|
454
|
+
* Blend align
|
|
455
|
+
*
|
|
456
|
+
* Changes the blend alignment relative to the parent image.
|
|
457
|
+
*
|
|
458
|
+
* Aliases: `blendalign`, `ba`
|
|
459
|
+
*
|
|
460
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-align
|
|
461
|
+
*/
|
|
462
|
+
blendAlign?: ("top" | "bottom" | "middle" | "left" | "right" | "center")[];
|
|
463
|
+
/**
|
|
464
|
+
* Blend align
|
|
465
|
+
*
|
|
466
|
+
* Changes the blend alignment relative to the parent image.
|
|
467
|
+
*
|
|
468
|
+
* Alias for: `blendAlign`
|
|
469
|
+
*
|
|
470
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-align
|
|
471
|
+
*/
|
|
472
|
+
blendalign?: ("top" | "bottom" | "middle" | "left" | "right" | "center")[];
|
|
473
|
+
/**
|
|
474
|
+
* Blend align
|
|
475
|
+
*
|
|
476
|
+
* Changes the blend alignment relative to the parent image.
|
|
477
|
+
*
|
|
478
|
+
* Alias for: `blendAlign`
|
|
479
|
+
*
|
|
480
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-align
|
|
481
|
+
*/
|
|
482
|
+
ba?: ("top" | "bottom" | "middle" | "left" | "right" | "center")[];
|
|
483
|
+
/**
|
|
484
|
+
* Blend alpha
|
|
485
|
+
*
|
|
486
|
+
* Changes the alpha of the blend image.
|
|
487
|
+
*
|
|
488
|
+
* Aliases: `blendalpha`, `balph`
|
|
489
|
+
*
|
|
490
|
+
* @defaultValue `100`
|
|
491
|
+
*
|
|
492
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-alpha
|
|
493
|
+
*/
|
|
494
|
+
blendAlpha?: number;
|
|
495
|
+
/**
|
|
496
|
+
* Blend alpha
|
|
497
|
+
*
|
|
498
|
+
* Changes the alpha of the blend image.
|
|
499
|
+
*
|
|
500
|
+
* Alias for: `blendAlpha`
|
|
501
|
+
*
|
|
502
|
+
* @defaultValue `100`
|
|
503
|
+
*
|
|
504
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-alpha
|
|
505
|
+
*/
|
|
506
|
+
blendalpha?: number;
|
|
507
|
+
/**
|
|
508
|
+
* Blend alpha
|
|
509
|
+
*
|
|
510
|
+
* Changes the alpha of the blend image.
|
|
511
|
+
*
|
|
512
|
+
* Alias for: `blendAlpha`
|
|
513
|
+
*
|
|
514
|
+
* @defaultValue `100`
|
|
515
|
+
*
|
|
516
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-alpha
|
|
517
|
+
*/
|
|
518
|
+
balph?: number;
|
|
519
|
+
/**
|
|
520
|
+
* Blend color
|
|
521
|
+
*
|
|
522
|
+
* Specifies a color to use when applying the blend.
|
|
523
|
+
*
|
|
524
|
+
* Aliases: `blendcolor`, `blendClr`, `blendclr`
|
|
525
|
+
*
|
|
526
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-color
|
|
527
|
+
*/
|
|
528
|
+
blendColor?: string | ColorKeyword;
|
|
529
|
+
/**
|
|
530
|
+
* Blend color
|
|
531
|
+
*
|
|
532
|
+
* Specifies a color to use when applying the blend.
|
|
533
|
+
*
|
|
534
|
+
* Alias for: `blendColor`
|
|
535
|
+
*
|
|
536
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-color
|
|
537
|
+
*/
|
|
538
|
+
blendcolor?: string | ColorKeyword;
|
|
539
|
+
/**
|
|
540
|
+
* Blend color
|
|
541
|
+
*
|
|
542
|
+
* Specifies a color to use when applying the blend.
|
|
543
|
+
*
|
|
544
|
+
* Alias for: `blendColor`
|
|
545
|
+
*
|
|
546
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-color
|
|
547
|
+
*/
|
|
548
|
+
blendClr?: string | ColorKeyword;
|
|
549
|
+
/**
|
|
550
|
+
* Blend color
|
|
551
|
+
*
|
|
552
|
+
* Specifies a color to use when applying the blend.
|
|
553
|
+
*
|
|
554
|
+
* Alias for: `blendColor`
|
|
555
|
+
*
|
|
556
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-color
|
|
557
|
+
*/
|
|
558
|
+
blendclr?: string | ColorKeyword;
|
|
559
|
+
/**
|
|
560
|
+
* Blend crop
|
|
561
|
+
*
|
|
562
|
+
* Specifies the type of crop for blend images.
|
|
563
|
+
*
|
|
564
|
+
* Aliases: `blendcrop`, `bc`
|
|
565
|
+
*
|
|
566
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-crop
|
|
567
|
+
*/
|
|
568
|
+
blendCrop?: ("top" | "bottom" | "left" | "right" | "faces")[];
|
|
569
|
+
/**
|
|
570
|
+
* Blend crop
|
|
571
|
+
*
|
|
572
|
+
* Specifies the type of crop for blend images.
|
|
573
|
+
*
|
|
574
|
+
* Alias for: `blendCrop`
|
|
575
|
+
*
|
|
576
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-crop
|
|
577
|
+
*/
|
|
578
|
+
blendcrop?: ("top" | "bottom" | "left" | "right" | "faces")[];
|
|
579
|
+
/**
|
|
580
|
+
* Blend crop
|
|
581
|
+
*
|
|
582
|
+
* Specifies the type of crop for blend images.
|
|
583
|
+
*
|
|
584
|
+
* Alias for: `blendCrop`
|
|
585
|
+
*
|
|
586
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-crop
|
|
587
|
+
*/
|
|
588
|
+
bc?: ("top" | "bottom" | "left" | "right" | "faces")[];
|
|
589
|
+
/**
|
|
590
|
+
* Blend fit
|
|
591
|
+
*
|
|
592
|
+
* Specifies the fit mode for blend images.
|
|
593
|
+
*
|
|
594
|
+
* Aliases: `blendfit`, `bf`
|
|
595
|
+
*
|
|
596
|
+
* @defaultValue `"clip"`
|
|
597
|
+
*
|
|
598
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-fit
|
|
599
|
+
*/
|
|
600
|
+
blendFit?: "clamp" | "clip" | "crop" | "scale" | "max";
|
|
601
|
+
/**
|
|
602
|
+
* Blend fit
|
|
603
|
+
*
|
|
604
|
+
* Specifies the fit mode for blend images.
|
|
605
|
+
*
|
|
606
|
+
* Alias for: `blendFit`
|
|
607
|
+
*
|
|
608
|
+
* @defaultValue `"clip"`
|
|
609
|
+
*
|
|
610
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-fit
|
|
611
|
+
*/
|
|
612
|
+
blendfit?: "clamp" | "clip" | "crop" | "scale" | "max";
|
|
613
|
+
/**
|
|
614
|
+
* Blend fit
|
|
615
|
+
*
|
|
616
|
+
* Specifies the fit mode for blend images.
|
|
617
|
+
*
|
|
618
|
+
* Alias for: `blendFit`
|
|
619
|
+
*
|
|
620
|
+
* @defaultValue `"clip"`
|
|
621
|
+
*
|
|
622
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-fit
|
|
623
|
+
*/
|
|
624
|
+
bf?: "clamp" | "clip" | "crop" | "scale" | "max";
|
|
625
|
+
/**
|
|
626
|
+
* Blend height
|
|
627
|
+
*
|
|
628
|
+
* Adjusts the height of the blend image.
|
|
629
|
+
*
|
|
630
|
+
* Aliases: `blendh`, `bh`
|
|
631
|
+
*
|
|
632
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-h
|
|
633
|
+
*/
|
|
634
|
+
blendH?: number;
|
|
635
|
+
/**
|
|
636
|
+
* Blend height
|
|
637
|
+
*
|
|
638
|
+
* Adjusts the height of the blend image.
|
|
639
|
+
*
|
|
640
|
+
* Alias for: `blendH`
|
|
641
|
+
*
|
|
642
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-h
|
|
643
|
+
*/
|
|
644
|
+
blendh?: number;
|
|
645
|
+
/**
|
|
646
|
+
* Blend height
|
|
647
|
+
*
|
|
648
|
+
* Adjusts the height of the blend image.
|
|
649
|
+
*
|
|
650
|
+
* Alias for: `blendH`
|
|
651
|
+
*
|
|
652
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-h
|
|
653
|
+
*/
|
|
654
|
+
bh?: number;
|
|
655
|
+
/**
|
|
656
|
+
* Blend mode
|
|
657
|
+
*
|
|
658
|
+
* Sets the blend mode for a blend image.
|
|
659
|
+
*
|
|
660
|
+
* Aliases: `blendmode`, `bm`
|
|
661
|
+
*
|
|
662
|
+
* @defaultValue `"overlay"`
|
|
663
|
+
*
|
|
664
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-mode
|
|
665
|
+
*/
|
|
666
|
+
blendMode?:
|
|
667
|
+
| "color"
|
|
668
|
+
| "burn"
|
|
669
|
+
| "dodge"
|
|
670
|
+
| "darken"
|
|
671
|
+
| "difference"
|
|
672
|
+
| "exclusion"
|
|
673
|
+
| "hardlight"
|
|
674
|
+
| "hue"
|
|
675
|
+
| "lighten"
|
|
676
|
+
| "luminosity"
|
|
677
|
+
| "multiply"
|
|
678
|
+
| "overlay"
|
|
679
|
+
| "saturation"
|
|
680
|
+
| "screen"
|
|
681
|
+
| "softlight"
|
|
682
|
+
| "normal";
|
|
683
|
+
/**
|
|
684
|
+
* Blend mode
|
|
685
|
+
*
|
|
686
|
+
* Sets the blend mode for a blend image.
|
|
687
|
+
*
|
|
688
|
+
* Alias for: `blendMode`
|
|
689
|
+
*
|
|
690
|
+
* @defaultValue `"overlay"`
|
|
691
|
+
*
|
|
692
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-mode
|
|
693
|
+
*/
|
|
694
|
+
blendmode?:
|
|
695
|
+
| "color"
|
|
696
|
+
| "burn"
|
|
697
|
+
| "dodge"
|
|
698
|
+
| "darken"
|
|
699
|
+
| "difference"
|
|
700
|
+
| "exclusion"
|
|
701
|
+
| "hardlight"
|
|
702
|
+
| "hue"
|
|
703
|
+
| "lighten"
|
|
704
|
+
| "luminosity"
|
|
705
|
+
| "multiply"
|
|
706
|
+
| "overlay"
|
|
707
|
+
| "saturation"
|
|
708
|
+
| "screen"
|
|
709
|
+
| "softlight"
|
|
710
|
+
| "normal";
|
|
711
|
+
/**
|
|
712
|
+
* Blend mode
|
|
713
|
+
*
|
|
714
|
+
* Sets the blend mode for a blend image.
|
|
715
|
+
*
|
|
716
|
+
* Alias for: `blendMode`
|
|
717
|
+
*
|
|
718
|
+
* @defaultValue `"overlay"`
|
|
719
|
+
*
|
|
720
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-mode
|
|
721
|
+
*/
|
|
722
|
+
bm?:
|
|
723
|
+
| "color"
|
|
724
|
+
| "burn"
|
|
725
|
+
| "dodge"
|
|
726
|
+
| "darken"
|
|
727
|
+
| "difference"
|
|
728
|
+
| "exclusion"
|
|
729
|
+
| "hardlight"
|
|
730
|
+
| "hue"
|
|
731
|
+
| "lighten"
|
|
732
|
+
| "luminosity"
|
|
733
|
+
| "multiply"
|
|
734
|
+
| "overlay"
|
|
735
|
+
| "saturation"
|
|
736
|
+
| "screen"
|
|
737
|
+
| "softlight"
|
|
738
|
+
| "normal";
|
|
739
|
+
/**
|
|
740
|
+
* Blend padding
|
|
741
|
+
*
|
|
742
|
+
* Applies padding to the blend image.
|
|
743
|
+
*
|
|
744
|
+
* Aliases: `blendpad`, `bp`
|
|
745
|
+
*
|
|
746
|
+
* @defaultValue `0`
|
|
747
|
+
*
|
|
748
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-pad
|
|
749
|
+
*/
|
|
750
|
+
blendPad?: number;
|
|
751
|
+
/**
|
|
752
|
+
* Blend padding
|
|
753
|
+
*
|
|
754
|
+
* Applies padding to the blend image.
|
|
755
|
+
*
|
|
756
|
+
* Alias for: `blendPad`
|
|
757
|
+
*
|
|
758
|
+
* @defaultValue `0`
|
|
759
|
+
*
|
|
760
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-pad
|
|
761
|
+
*/
|
|
762
|
+
blendpad?: number;
|
|
763
|
+
/**
|
|
764
|
+
* Blend padding
|
|
765
|
+
*
|
|
766
|
+
* Applies padding to the blend image.
|
|
767
|
+
*
|
|
768
|
+
* Alias for: `blendPad`
|
|
769
|
+
*
|
|
770
|
+
* @defaultValue `0`
|
|
771
|
+
*
|
|
772
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-pad
|
|
773
|
+
*/
|
|
774
|
+
bp?: number;
|
|
775
|
+
/**
|
|
776
|
+
* Blend size
|
|
777
|
+
*
|
|
778
|
+
* Adjusts the size of the blend image.
|
|
779
|
+
*
|
|
780
|
+
* Aliases: `blendsize`, `bs`
|
|
781
|
+
*
|
|
782
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-size
|
|
783
|
+
*/
|
|
784
|
+
blendSize?: "inherit";
|
|
785
|
+
/**
|
|
786
|
+
* Blend size
|
|
787
|
+
*
|
|
788
|
+
* Adjusts the size of the blend image.
|
|
789
|
+
*
|
|
790
|
+
* Alias for: `blendSize`
|
|
791
|
+
*
|
|
792
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-size
|
|
793
|
+
*/
|
|
794
|
+
blendsize?: "inherit";
|
|
795
|
+
/**
|
|
796
|
+
* Blend size
|
|
797
|
+
*
|
|
798
|
+
* Adjusts the size of the blend image.
|
|
799
|
+
*
|
|
800
|
+
* Alias for: `blendSize`
|
|
801
|
+
*
|
|
802
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-size
|
|
803
|
+
*/
|
|
804
|
+
bs?: "inherit";
|
|
805
|
+
/**
|
|
806
|
+
* Blend width
|
|
807
|
+
*
|
|
808
|
+
* Adjusts the width of the blend image.
|
|
809
|
+
*
|
|
810
|
+
* Aliases: `blendw`, `bw`
|
|
811
|
+
*
|
|
812
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-w
|
|
813
|
+
*/
|
|
814
|
+
blendW?: number;
|
|
815
|
+
/**
|
|
816
|
+
* Blend width
|
|
817
|
+
*
|
|
818
|
+
* Adjusts the width of the blend image.
|
|
819
|
+
*
|
|
820
|
+
* Alias for: `blendW`
|
|
821
|
+
*
|
|
822
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-w
|
|
823
|
+
*/
|
|
824
|
+
blendw?: number;
|
|
825
|
+
/**
|
|
826
|
+
* Blend width
|
|
827
|
+
*
|
|
828
|
+
* Adjusts the width of the blend image.
|
|
829
|
+
*
|
|
830
|
+
* Alias for: `blendW`
|
|
831
|
+
*
|
|
832
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-w
|
|
833
|
+
*/
|
|
834
|
+
bw?: number;
|
|
835
|
+
/**
|
|
836
|
+
* Blend x position
|
|
837
|
+
*
|
|
838
|
+
* Adjusts the x-offset of the blend image relative to its parent.
|
|
839
|
+
*
|
|
840
|
+
* Aliases: `blendx`, `bx`
|
|
841
|
+
*
|
|
842
|
+
* @defaultValue `0`
|
|
843
|
+
*
|
|
844
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-x
|
|
845
|
+
*/
|
|
846
|
+
blendX?: number;
|
|
847
|
+
/**
|
|
848
|
+
* Blend x position
|
|
849
|
+
*
|
|
850
|
+
* Adjusts the x-offset of the blend image relative to its parent.
|
|
851
|
+
*
|
|
852
|
+
* Alias for: `blendX`
|
|
853
|
+
*
|
|
854
|
+
* @defaultValue `0`
|
|
855
|
+
*
|
|
856
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-x
|
|
857
|
+
*/
|
|
858
|
+
blendx?: number;
|
|
859
|
+
/**
|
|
860
|
+
* Blend x position
|
|
861
|
+
*
|
|
862
|
+
* Adjusts the x-offset of the blend image relative to its parent.
|
|
863
|
+
*
|
|
864
|
+
* Alias for: `blendX`
|
|
865
|
+
*
|
|
866
|
+
* @defaultValue `0`
|
|
867
|
+
*
|
|
868
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-x
|
|
869
|
+
*/
|
|
870
|
+
bx?: number;
|
|
871
|
+
/**
|
|
872
|
+
* Blend y position
|
|
873
|
+
*
|
|
874
|
+
* Adjusts the y-offset of the blend image relative to its parent.
|
|
875
|
+
*
|
|
876
|
+
* Aliases: `blendy`, `by`
|
|
877
|
+
*
|
|
878
|
+
* @defaultValue `0`
|
|
879
|
+
*
|
|
880
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-y
|
|
881
|
+
*/
|
|
882
|
+
blendY?: number;
|
|
883
|
+
/**
|
|
884
|
+
* Blend y position
|
|
885
|
+
*
|
|
886
|
+
* Adjusts the y-offset of the blend image relative to its parent.
|
|
887
|
+
*
|
|
888
|
+
* Alias for: `blendY`
|
|
889
|
+
*
|
|
890
|
+
* @defaultValue `0`
|
|
891
|
+
*
|
|
892
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-y
|
|
893
|
+
*/
|
|
894
|
+
blendy?: number;
|
|
895
|
+
/**
|
|
896
|
+
* Blend y position
|
|
897
|
+
*
|
|
898
|
+
* Adjusts the y-offset of the blend image relative to its parent.
|
|
899
|
+
*
|
|
900
|
+
* Alias for: `blendY`
|
|
901
|
+
*
|
|
902
|
+
* @defaultValue `0`
|
|
903
|
+
*
|
|
904
|
+
* @see https://docs.imgix.com/apis/url/blending/blend-y
|
|
905
|
+
*/
|
|
906
|
+
by?: number;
|
|
907
|
+
/**
|
|
908
|
+
* Blend
|
|
909
|
+
*
|
|
910
|
+
* Specifies the location of the blend image.
|
|
911
|
+
*
|
|
912
|
+
* Aliases: `b`
|
|
913
|
+
*
|
|
914
|
+
* @see https://docs.imgix.com/apis/url/blending/blend
|
|
915
|
+
*/
|
|
916
|
+
blend?: string | ColorKeyword;
|
|
917
|
+
/**
|
|
918
|
+
* Blend
|
|
919
|
+
*
|
|
920
|
+
* Specifies the location of the blend image.
|
|
921
|
+
*
|
|
922
|
+
* Alias for: `blend`
|
|
923
|
+
*
|
|
924
|
+
* @see https://docs.imgix.com/apis/url/blending/blend
|
|
925
|
+
*/
|
|
926
|
+
b?: string | ColorKeyword;
|
|
927
|
+
/**
|
|
928
|
+
* Gaussian blur
|
|
929
|
+
*
|
|
930
|
+
* Applies a gaussian blur to an image.
|
|
931
|
+
*
|
|
932
|
+
* @defaultValue `0`
|
|
933
|
+
*
|
|
934
|
+
* @see https://docs.imgix.com/apis/url/stylize/blur
|
|
935
|
+
*/
|
|
936
|
+
blur?: number;
|
|
937
|
+
/**
|
|
938
|
+
* Border bottom
|
|
939
|
+
*
|
|
940
|
+
* Sets bottom border of an image.
|
|
941
|
+
*
|
|
942
|
+
* @see https://docs.imgix.com/apis/url/border-and-padding/border-bottom
|
|
943
|
+
*/
|
|
944
|
+
borderBottom?: number;
|
|
945
|
+
/**
|
|
946
|
+
* Border left
|
|
947
|
+
*
|
|
948
|
+
* Sets left border of an image.
|
|
949
|
+
*
|
|
950
|
+
* @see https://docs.imgix.com/apis/url/border-and-padding/border-left
|
|
951
|
+
*/
|
|
952
|
+
borderLeft?: number;
|
|
953
|
+
/**
|
|
954
|
+
* Inner border radius
|
|
955
|
+
*
|
|
956
|
+
* Sets the inner radius of the image's border in pixels.
|
|
957
|
+
*
|
|
958
|
+
* @see https://docs.imgix.com/apis/url/border-and-padding/border-radius-inner
|
|
959
|
+
*/
|
|
960
|
+
borderRadiusInner?: number | [number, number, number, number];
|
|
961
|
+
/**
|
|
962
|
+
* Outer border radius
|
|
963
|
+
*
|
|
964
|
+
* Sets the outer radius of the image's border in pixels.
|
|
965
|
+
*
|
|
966
|
+
* @see https://docs.imgix.com/apis/url/border-and-padding/border-radius
|
|
967
|
+
*/
|
|
968
|
+
borderRadius?: number | [number, number, number, number];
|
|
969
|
+
/**
|
|
970
|
+
* Border right
|
|
971
|
+
*
|
|
972
|
+
* Sets right border of an image.
|
|
973
|
+
*
|
|
974
|
+
* @see https://docs.imgix.com/apis/url/border-and-padding/border-right
|
|
975
|
+
*/
|
|
976
|
+
borderRight?: number;
|
|
977
|
+
/**
|
|
978
|
+
* Border top
|
|
979
|
+
*
|
|
980
|
+
* Sets top border of an image.
|
|
981
|
+
*
|
|
982
|
+
* @see https://docs.imgix.com/apis/url/border-and-padding/border-top
|
|
983
|
+
*/
|
|
984
|
+
borderTop?: number;
|
|
985
|
+
/**
|
|
986
|
+
* Border size & color
|
|
987
|
+
*
|
|
988
|
+
* Applies a border to an image.
|
|
989
|
+
*
|
|
990
|
+
* @see https://docs.imgix.com/apis/url/border-and-padding/border
|
|
991
|
+
*/
|
|
992
|
+
border?: [number, string | ColorKeyword];
|
|
993
|
+
/**
|
|
994
|
+
* Brightness
|
|
995
|
+
*
|
|
996
|
+
* Adjusts the brightness of the source image.
|
|
997
|
+
*
|
|
998
|
+
* @defaultValue `0`
|
|
999
|
+
*
|
|
1000
|
+
* @see https://docs.imgix.com/apis/url/adjustment/bri
|
|
1001
|
+
*/
|
|
1002
|
+
bri?: number;
|
|
1003
|
+
/**
|
|
1004
|
+
* Client hints
|
|
1005
|
+
*
|
|
1006
|
+
* Sets one or more Client-Hints headers
|
|
1007
|
+
*
|
|
1008
|
+
* @see https://docs.imgix.com/apis/url/format/ch
|
|
1009
|
+
*/
|
|
1010
|
+
ch?: ("width" | "dpr" | "save-data")[];
|
|
1011
|
+
/**
|
|
1012
|
+
* Chroma subsampling
|
|
1013
|
+
*
|
|
1014
|
+
* Specifies the output chroma subsampling rate.
|
|
1015
|
+
*
|
|
1016
|
+
* @defaultValue `420`
|
|
1017
|
+
*
|
|
1018
|
+
* @see https://docs.imgix.com/apis/url/format/chromasub
|
|
1019
|
+
*/
|
|
1020
|
+
chromasub?: 444 | 422 | 420;
|
|
1021
|
+
/**
|
|
1022
|
+
* Color quantization
|
|
1023
|
+
*
|
|
1024
|
+
* Limits the number of unique colors in an image.
|
|
1025
|
+
*
|
|
1026
|
+
* @see https://docs.imgix.com/apis/url/format/colorquant
|
|
1027
|
+
*/
|
|
1028
|
+
colorquant?: number;
|
|
1029
|
+
/**
|
|
1030
|
+
* Palette color count
|
|
1031
|
+
*
|
|
1032
|
+
* Specifies how many colors to include in a palette-extraction response.
|
|
1033
|
+
*
|
|
1034
|
+
* @defaultValue `6`
|
|
1035
|
+
*
|
|
1036
|
+
* @see https://docs.imgix.com/apis/url/color-palette/colors
|
|
1037
|
+
*/
|
|
1038
|
+
colors?: number;
|
|
1039
|
+
/**
|
|
1040
|
+
* Contrast
|
|
1041
|
+
*
|
|
1042
|
+
* Adjusts the contrast of the source image.
|
|
1043
|
+
*
|
|
1044
|
+
* @defaultValue `0`
|
|
1045
|
+
*
|
|
1046
|
+
* @see https://docs.imgix.com/apis/url/adjustment/con
|
|
1047
|
+
*/
|
|
1048
|
+
con?: number;
|
|
1049
|
+
/**
|
|
1050
|
+
* Mask corner radius
|
|
1051
|
+
*
|
|
1052
|
+
* Specifies the radius value for a rounded corner mask.
|
|
1053
|
+
*
|
|
1054
|
+
* @see https://docs.imgix.com/apis/url/mask/corner-radius
|
|
1055
|
+
*/
|
|
1056
|
+
cornerRadius?: number | [number, number, number, number];
|
|
1057
|
+
/**
|
|
1058
|
+
* Crop mode
|
|
1059
|
+
*
|
|
1060
|
+
* Specifies how to crop an image.
|
|
1061
|
+
*
|
|
1062
|
+
* @see https://docs.imgix.com/apis/url/size/crop
|
|
1063
|
+
*/
|
|
1064
|
+
crop?: (
|
|
1065
|
+
| "top"
|
|
1066
|
+
| "bottom"
|
|
1067
|
+
| "left"
|
|
1068
|
+
| "right"
|
|
1069
|
+
| "faces"
|
|
1070
|
+
| "entropy"
|
|
1071
|
+
| "edges"
|
|
1072
|
+
| "focalpoint"
|
|
1073
|
+
)[];
|
|
1074
|
+
/**
|
|
1075
|
+
* Color space
|
|
1076
|
+
*
|
|
1077
|
+
* Specifies the color space of the output image.
|
|
1078
|
+
*
|
|
1079
|
+
* @see https://docs.imgix.com/apis/url/format/cs
|
|
1080
|
+
*/
|
|
1081
|
+
cs?: "srgb" | "adobergb1998" | "tinysrgb" | "strip";
|
|
1082
|
+
/**
|
|
1083
|
+
* Download
|
|
1084
|
+
*
|
|
1085
|
+
* Forces a URL to use send-file in its response.
|
|
1086
|
+
*
|
|
1087
|
+
* @see https://docs.imgix.com/apis/url/format/dl
|
|
1088
|
+
*/
|
|
1089
|
+
dl?: string;
|
|
1090
|
+
/**
|
|
1091
|
+
* Dots per inch
|
|
1092
|
+
*
|
|
1093
|
+
* Sets the DPI value in the EXIF header.
|
|
1094
|
+
*
|
|
1095
|
+
* @see https://docs.imgix.com/apis/url/format/dpi
|
|
1096
|
+
*/
|
|
1097
|
+
dpi?: number;
|
|
1098
|
+
/**
|
|
1099
|
+
* Device pixel ratio
|
|
1100
|
+
*
|
|
1101
|
+
* Adjusts the device-pixel ratio of the output image.
|
|
1102
|
+
*
|
|
1103
|
+
* @defaultValue `1`
|
|
1104
|
+
*
|
|
1105
|
+
* @see https://docs.imgix.com/apis/url/dpr
|
|
1106
|
+
*/
|
|
1107
|
+
dpr?: number;
|
|
1108
|
+
/**
|
|
1109
|
+
* Duotone alpha
|
|
1110
|
+
*
|
|
1111
|
+
* Changes the alpha of the duotone effect atop the source image.
|
|
1112
|
+
*
|
|
1113
|
+
* @defaultValue `100`
|
|
1114
|
+
*
|
|
1115
|
+
* @see https://docs.imgix.com/apis/url/stylize/duotone-alpha
|
|
1116
|
+
*/
|
|
1117
|
+
duotoneAlpha?: number;
|
|
1118
|
+
/**
|
|
1119
|
+
* Duotone
|
|
1120
|
+
*
|
|
1121
|
+
* Applies a duotone effect to the source image.
|
|
1122
|
+
*
|
|
1123
|
+
* @see https://docs.imgix.com/apis/url/stylize/duotone
|
|
1124
|
+
*/
|
|
1125
|
+
duotone?: [string | ColorKeyword, string | ColorKeyword];
|
|
1126
|
+
/**
|
|
1127
|
+
* Exposure
|
|
1128
|
+
*
|
|
1129
|
+
* Adjusts the exposure of the output image.
|
|
1130
|
+
*
|
|
1131
|
+
* @defaultValue `0`
|
|
1132
|
+
*
|
|
1133
|
+
* @see https://docs.imgix.com/apis/url/adjustment/exp
|
|
1134
|
+
*/
|
|
1135
|
+
exp?: number;
|
|
1136
|
+
/**
|
|
1137
|
+
* URL expiration timestamp
|
|
1138
|
+
*
|
|
1139
|
+
* A Unix timestamp specifying a UTC time. Requests made to this URL after
|
|
1140
|
+
* that time will output a 404 status code.
|
|
1141
|
+
*
|
|
1142
|
+
* @see https://docs.imgix.com/apis/url/expires
|
|
1143
|
+
*/
|
|
1144
|
+
expires?: number;
|
|
1145
|
+
/**
|
|
1146
|
+
* Face index
|
|
1147
|
+
*
|
|
1148
|
+
* Selects a face to crop to.
|
|
1149
|
+
*
|
|
1150
|
+
* @see https://docs.imgix.com/apis/url/face-detection/faceindex
|
|
1151
|
+
*/
|
|
1152
|
+
faceindex?: number;
|
|
1153
|
+
/**
|
|
1154
|
+
* Face padding
|
|
1155
|
+
*
|
|
1156
|
+
* Adjusts padding around a selected face.
|
|
1157
|
+
*
|
|
1158
|
+
* @defaultValue `1`
|
|
1159
|
+
*
|
|
1160
|
+
* @see https://docs.imgix.com/apis/url/face-detection/facepad
|
|
1161
|
+
*/
|
|
1162
|
+
facepad?: number;
|
|
1163
|
+
/**
|
|
1164
|
+
* Json face data
|
|
1165
|
+
*
|
|
1166
|
+
* Specifies that face data should be included in output when combined with `fm=json`.
|
|
1167
|
+
*
|
|
1168
|
+
* @see https://docs.imgix.com/apis/url/face-detection/faces
|
|
1169
|
+
*/
|
|
1170
|
+
faces?: 1;
|
|
1171
|
+
/**
|
|
1172
|
+
* Fill color
|
|
1173
|
+
*
|
|
1174
|
+
* Sets the fill color for images with additional space created by the fit setting
|
|
1175
|
+
*
|
|
1176
|
+
* Aliases: `fillcolor`
|
|
1177
|
+
*
|
|
1178
|
+
* @defaultValue `"fff"`
|
|
1179
|
+
*
|
|
1180
|
+
* @see https://docs.imgix.com/apis/url/fill/fill-color
|
|
1181
|
+
*/
|
|
1182
|
+
fillColor?: string | ColorKeyword;
|
|
1183
|
+
/**
|
|
1184
|
+
* Fill color
|
|
1185
|
+
*
|
|
1186
|
+
* Sets the fill color for images with additional space created by the fit setting
|
|
1187
|
+
*
|
|
1188
|
+
* Alias for: `fillColor`
|
|
1189
|
+
*
|
|
1190
|
+
* @defaultValue `"fff"`
|
|
1191
|
+
*
|
|
1192
|
+
* @see https://docs.imgix.com/apis/url/fill/fill-color
|
|
1193
|
+
*/
|
|
1194
|
+
fillcolor?: string | ColorKeyword;
|
|
1195
|
+
/**
|
|
1196
|
+
* Fill mode
|
|
1197
|
+
*
|
|
1198
|
+
* Determines how to fill in additional space created by the fit setting
|
|
1199
|
+
*
|
|
1200
|
+
* @see https://docs.imgix.com/apis/url/fill/fill
|
|
1201
|
+
*/
|
|
1202
|
+
fill?: "solid" | "blur";
|
|
1203
|
+
/**
|
|
1204
|
+
* Resize fit mode
|
|
1205
|
+
*
|
|
1206
|
+
* Specifies how to map the source image to the output image dimensions.
|
|
1207
|
+
*
|
|
1208
|
+
* Aliases: `f`
|
|
1209
|
+
*
|
|
1210
|
+
* @defaultValue `"clip"`
|
|
1211
|
+
*
|
|
1212
|
+
* @see https://docs.imgix.com/apis/url/size/fit
|
|
1213
|
+
*/
|
|
1214
|
+
fit?:
|
|
1215
|
+
| "clamp"
|
|
1216
|
+
| "clip"
|
|
1217
|
+
| "crop"
|
|
1218
|
+
| "facearea"
|
|
1219
|
+
| "fill"
|
|
1220
|
+
| "fillmax"
|
|
1221
|
+
| "max"
|
|
1222
|
+
| "min"
|
|
1223
|
+
| "scale";
|
|
1224
|
+
/**
|
|
1225
|
+
* Resize fit mode
|
|
1226
|
+
*
|
|
1227
|
+
* Specifies how to map the source image to the output image dimensions.
|
|
1228
|
+
*
|
|
1229
|
+
* Alias for: `fit`
|
|
1230
|
+
*
|
|
1231
|
+
* @defaultValue `"clip"`
|
|
1232
|
+
*
|
|
1233
|
+
* @see https://docs.imgix.com/apis/url/size/fit
|
|
1234
|
+
*/
|
|
1235
|
+
f?:
|
|
1236
|
+
| "clamp"
|
|
1237
|
+
| "clip"
|
|
1238
|
+
| "crop"
|
|
1239
|
+
| "facearea"
|
|
1240
|
+
| "fill"
|
|
1241
|
+
| "fillmax"
|
|
1242
|
+
| "max"
|
|
1243
|
+
| "min"
|
|
1244
|
+
| "scale";
|
|
1245
|
+
/**
|
|
1246
|
+
* Flip axis
|
|
1247
|
+
*
|
|
1248
|
+
* Flips an image on a specified axis.
|
|
1249
|
+
*
|
|
1250
|
+
* @see https://docs.imgix.com/apis/url/rotation/flip
|
|
1251
|
+
*/
|
|
1252
|
+
flip?: "h" | "v" | "hv";
|
|
1253
|
+
/**
|
|
1254
|
+
* Output format
|
|
1255
|
+
*
|
|
1256
|
+
* Changes the format of the output image.
|
|
1257
|
+
*
|
|
1258
|
+
* @see https://docs.imgix.com/apis/url/format/fm
|
|
1259
|
+
*/
|
|
1260
|
+
fm?:
|
|
1261
|
+
| "gif"
|
|
1262
|
+
| "jpg"
|
|
1263
|
+
| "jp2"
|
|
1264
|
+
| "json"
|
|
1265
|
+
| "jxr"
|
|
1266
|
+
| "pjpg"
|
|
1267
|
+
| "mp4"
|
|
1268
|
+
| "png"
|
|
1269
|
+
| "png8"
|
|
1270
|
+
| "png32"
|
|
1271
|
+
| "webp"
|
|
1272
|
+
| "webm"
|
|
1273
|
+
| "blurhash"
|
|
1274
|
+
| "avif";
|
|
1275
|
+
/**
|
|
1276
|
+
* Focal point debug
|
|
1277
|
+
*
|
|
1278
|
+
* Displays crosshairs identifying the location of the set focal point
|
|
1279
|
+
*
|
|
1280
|
+
* @defaultValue `false`
|
|
1281
|
+
*
|
|
1282
|
+
* @see https://docs.imgix.com/apis/url/focalpoint-crop/fp-debug
|
|
1283
|
+
*/
|
|
1284
|
+
fpDebug?: boolean;
|
|
1285
|
+
/**
|
|
1286
|
+
* Focal point x position
|
|
1287
|
+
*
|
|
1288
|
+
* Sets the relative horizontal value for the focal point of an image
|
|
1289
|
+
*
|
|
1290
|
+
* @see https://docs.imgix.com/apis/url/focalpoint-crop/fp-x
|
|
1291
|
+
*/
|
|
1292
|
+
fpX?: number;
|
|
1293
|
+
/**
|
|
1294
|
+
* Focal point y position
|
|
1295
|
+
*
|
|
1296
|
+
* Sets the relative vertical value for the focal point of an image
|
|
1297
|
+
*
|
|
1298
|
+
* @see https://docs.imgix.com/apis/url/focalpoint-crop/fp-y
|
|
1299
|
+
*/
|
|
1300
|
+
fpY?: number;
|
|
1301
|
+
/**
|
|
1302
|
+
* Focal point zoom
|
|
1303
|
+
*
|
|
1304
|
+
* Sets the relative zoom value for the focal point of an image
|
|
1305
|
+
*
|
|
1306
|
+
* @see https://docs.imgix.com/apis/url/focalpoint-crop/fp-z
|
|
1307
|
+
*/
|
|
1308
|
+
fpZ?: number;
|
|
1309
|
+
/**
|
|
1310
|
+
* Gamma
|
|
1311
|
+
*
|
|
1312
|
+
* Adjusts the gamma of the source image.
|
|
1313
|
+
*
|
|
1314
|
+
* @defaultValue `0`
|
|
1315
|
+
*
|
|
1316
|
+
* @see https://docs.imgix.com/apis/url/adjustment/gam
|
|
1317
|
+
*/
|
|
1318
|
+
gam?: number;
|
|
1319
|
+
/**
|
|
1320
|
+
* Grid colors
|
|
1321
|
+
*
|
|
1322
|
+
* Sets grid colors for the transparency checkerboard grid.
|
|
1323
|
+
*/
|
|
1324
|
+
gridColors?: [string | ColorKeyword, string | ColorKeyword];
|
|
1325
|
+
/**
|
|
1326
|
+
* Grid size
|
|
1327
|
+
*
|
|
1328
|
+
* Sets grid size for the transparency checkerboard grid.
|
|
1329
|
+
*/
|
|
1330
|
+
gridSize?: number;
|
|
1331
|
+
/**
|
|
1332
|
+
* Image height
|
|
1333
|
+
*
|
|
1334
|
+
* Adjusts the height of the output image.
|
|
1335
|
+
*
|
|
1336
|
+
* Aliases: `height`
|
|
1337
|
+
*
|
|
1338
|
+
* @see https://docs.imgix.com/apis/url/size/h
|
|
1339
|
+
*/
|
|
1340
|
+
h?: number;
|
|
1341
|
+
/**
|
|
1342
|
+
* Image height
|
|
1343
|
+
*
|
|
1344
|
+
* Adjusts the height of the output image.
|
|
1345
|
+
*
|
|
1346
|
+
* Alias for: `h`
|
|
1347
|
+
*
|
|
1348
|
+
* @see https://docs.imgix.com/apis/url/size/h
|
|
1349
|
+
*/
|
|
1350
|
+
height?: number;
|
|
1351
|
+
/**
|
|
1352
|
+
* Highlight
|
|
1353
|
+
*
|
|
1354
|
+
* Adjusts the highlights of the source image.
|
|
1355
|
+
*
|
|
1356
|
+
* @defaultValue `0`
|
|
1357
|
+
*
|
|
1358
|
+
* @see https://docs.imgix.com/apis/url/adjustment/high
|
|
1359
|
+
*/
|
|
1360
|
+
high?: number;
|
|
1361
|
+
/**
|
|
1362
|
+
* Halftone
|
|
1363
|
+
*
|
|
1364
|
+
* Applies a half-tone effect to the source image.
|
|
1365
|
+
*
|
|
1366
|
+
* @defaultValue `0`
|
|
1367
|
+
*
|
|
1368
|
+
* @see https://docs.imgix.com/apis/url/stylize/htn
|
|
1369
|
+
*/
|
|
1370
|
+
htn?: number;
|
|
1371
|
+
/**
|
|
1372
|
+
* Hue shift
|
|
1373
|
+
*
|
|
1374
|
+
* Adjusts the hue of the source image.
|
|
1375
|
+
*
|
|
1376
|
+
* @defaultValue `0`
|
|
1377
|
+
*
|
|
1378
|
+
* @see https://docs.imgix.com/apis/url/adjustment/hue
|
|
1379
|
+
*/
|
|
1380
|
+
hue?: number;
|
|
1381
|
+
/**
|
|
1382
|
+
* Invert
|
|
1383
|
+
*
|
|
1384
|
+
* Inverts the colors on the source image.
|
|
1385
|
+
*
|
|
1386
|
+
* Aliases: `inv`
|
|
1387
|
+
*
|
|
1388
|
+
* @defaultValue `false`
|
|
1389
|
+
*
|
|
1390
|
+
* @see https://docs.imgix.com/apis/url/adjustment/invert
|
|
1391
|
+
*/
|
|
1392
|
+
invert?: boolean;
|
|
1393
|
+
/**
|
|
1394
|
+
* Invert
|
|
1395
|
+
*
|
|
1396
|
+
* Inverts the colors on the source image.
|
|
1397
|
+
*
|
|
1398
|
+
* Alias for: `invert`
|
|
1399
|
+
*
|
|
1400
|
+
* @defaultValue `false`
|
|
1401
|
+
*
|
|
1402
|
+
* @see https://docs.imgix.com/apis/url/adjustment/invert
|
|
1403
|
+
*/
|
|
1404
|
+
inv?: boolean;
|
|
1405
|
+
/**
|
|
1406
|
+
* IPTC Passthrough
|
|
1407
|
+
*
|
|
1408
|
+
* Determine if IPTC data should be passed for JPEG images.
|
|
1409
|
+
*/
|
|
1410
|
+
iptc?: "allow" | "block";
|
|
1411
|
+
/**
|
|
1412
|
+
* Lossless compression
|
|
1413
|
+
*
|
|
1414
|
+
* Specifies that the output image should be a lossless variant.
|
|
1415
|
+
*
|
|
1416
|
+
* @defaultValue `false`
|
|
1417
|
+
*
|
|
1418
|
+
* @see https://docs.imgix.com/apis/url/format/lossless
|
|
1419
|
+
*/
|
|
1420
|
+
lossless?: boolean;
|
|
1421
|
+
/**
|
|
1422
|
+
* Watermark alignment mode
|
|
1423
|
+
*
|
|
1424
|
+
* Changes the watermark alignment relative to the parent image.
|
|
1425
|
+
*
|
|
1426
|
+
* Aliases: `ma`, `markalign`
|
|
1427
|
+
*
|
|
1428
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-align
|
|
1429
|
+
*/
|
|
1430
|
+
markAlign?: ("top" | "middle" | "bottom" | "left" | "center" | "right")[];
|
|
1431
|
+
/**
|
|
1432
|
+
* Watermark alignment mode
|
|
1433
|
+
*
|
|
1434
|
+
* Changes the watermark alignment relative to the parent image.
|
|
1435
|
+
*
|
|
1436
|
+
* Alias for: `markAlign`
|
|
1437
|
+
*
|
|
1438
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-align
|
|
1439
|
+
*/
|
|
1440
|
+
ma?: ("top" | "middle" | "bottom" | "left" | "center" | "right")[];
|
|
1441
|
+
/**
|
|
1442
|
+
* Watermark alignment mode
|
|
1443
|
+
*
|
|
1444
|
+
* Changes the watermark alignment relative to the parent image.
|
|
1445
|
+
*
|
|
1446
|
+
* Alias for: `markAlign`
|
|
1447
|
+
*
|
|
1448
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-align
|
|
1449
|
+
*/
|
|
1450
|
+
markalign?: ("top" | "middle" | "bottom" | "left" | "center" | "right")[];
|
|
1451
|
+
/**
|
|
1452
|
+
* Watermark alpha
|
|
1453
|
+
*
|
|
1454
|
+
* Changes the alpha of the watermark image.
|
|
1455
|
+
*
|
|
1456
|
+
* Aliases: `markalpha`, `malph`
|
|
1457
|
+
*
|
|
1458
|
+
* @defaultValue `100`
|
|
1459
|
+
*
|
|
1460
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-alpha
|
|
1461
|
+
*/
|
|
1462
|
+
markAlpha?: number;
|
|
1463
|
+
/**
|
|
1464
|
+
* Watermark alpha
|
|
1465
|
+
*
|
|
1466
|
+
* Changes the alpha of the watermark image.
|
|
1467
|
+
*
|
|
1468
|
+
* Alias for: `markAlpha`
|
|
1469
|
+
*
|
|
1470
|
+
* @defaultValue `100`
|
|
1471
|
+
*
|
|
1472
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-alpha
|
|
1473
|
+
*/
|
|
1474
|
+
markalpha?: number;
|
|
1475
|
+
/**
|
|
1476
|
+
* Watermark alpha
|
|
1477
|
+
*
|
|
1478
|
+
* Changes the alpha of the watermark image.
|
|
1479
|
+
*
|
|
1480
|
+
* Alias for: `markAlpha`
|
|
1481
|
+
*
|
|
1482
|
+
* @defaultValue `100`
|
|
1483
|
+
*
|
|
1484
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-alpha
|
|
1485
|
+
*/
|
|
1486
|
+
malph?: number;
|
|
1487
|
+
/**
|
|
1488
|
+
* Watermark base url
|
|
1489
|
+
*
|
|
1490
|
+
* Changes base URL of the watermark image.
|
|
1491
|
+
*
|
|
1492
|
+
* Aliases: `mb`, `markbase`
|
|
1493
|
+
*
|
|
1494
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-base
|
|
1495
|
+
*/
|
|
1496
|
+
markBase?: string;
|
|
1497
|
+
/**
|
|
1498
|
+
* Watermark base url
|
|
1499
|
+
*
|
|
1500
|
+
* Changes base URL of the watermark image.
|
|
1501
|
+
*
|
|
1502
|
+
* Alias for: `markBase`
|
|
1503
|
+
*
|
|
1504
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-base
|
|
1505
|
+
*/
|
|
1506
|
+
mb?: string;
|
|
1507
|
+
/**
|
|
1508
|
+
* Watermark base url
|
|
1509
|
+
*
|
|
1510
|
+
* Changes base URL of the watermark image.
|
|
1511
|
+
*
|
|
1512
|
+
* Alias for: `markBase`
|
|
1513
|
+
*
|
|
1514
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-base
|
|
1515
|
+
*/
|
|
1516
|
+
markbase?: string;
|
|
1517
|
+
/**
|
|
1518
|
+
* Watermark fit mode
|
|
1519
|
+
*
|
|
1520
|
+
* Specifies the fit mode for watermark images.
|
|
1521
|
+
*
|
|
1522
|
+
* Aliases: `mf`, `markfit`
|
|
1523
|
+
*
|
|
1524
|
+
* @defaultValue `"clip"`
|
|
1525
|
+
*
|
|
1526
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-fit
|
|
1527
|
+
*/
|
|
1528
|
+
markFit?: "clip" | "crop" | "fill" | "max" | "scale";
|
|
1529
|
+
/**
|
|
1530
|
+
* Watermark fit mode
|
|
1531
|
+
*
|
|
1532
|
+
* Specifies the fit mode for watermark images.
|
|
1533
|
+
*
|
|
1534
|
+
* Alias for: `markFit`
|
|
1535
|
+
*
|
|
1536
|
+
* @defaultValue `"clip"`
|
|
1537
|
+
*
|
|
1538
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-fit
|
|
1539
|
+
*/
|
|
1540
|
+
mf?: "clip" | "crop" | "fill" | "max" | "scale";
|
|
1541
|
+
/**
|
|
1542
|
+
* Watermark fit mode
|
|
1543
|
+
*
|
|
1544
|
+
* Specifies the fit mode for watermark images.
|
|
1545
|
+
*
|
|
1546
|
+
* Alias for: `markFit`
|
|
1547
|
+
*
|
|
1548
|
+
* @defaultValue `"clip"`
|
|
1549
|
+
*
|
|
1550
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-fit
|
|
1551
|
+
*/
|
|
1552
|
+
markfit?: "clip" | "crop" | "fill" | "max" | "scale";
|
|
1553
|
+
/**
|
|
1554
|
+
* Watermark height
|
|
1555
|
+
*
|
|
1556
|
+
* Adjusts the height of the watermark image.
|
|
1557
|
+
*
|
|
1558
|
+
* Aliases: `mh`, `markh`
|
|
1559
|
+
*
|
|
1560
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-h
|
|
1561
|
+
*/
|
|
1562
|
+
markH?: number;
|
|
1563
|
+
/**
|
|
1564
|
+
* Watermark height
|
|
1565
|
+
*
|
|
1566
|
+
* Adjusts the height of the watermark image.
|
|
1567
|
+
*
|
|
1568
|
+
* Alias for: `markH`
|
|
1569
|
+
*
|
|
1570
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-h
|
|
1571
|
+
*/
|
|
1572
|
+
mh?: number;
|
|
1573
|
+
/**
|
|
1574
|
+
* Watermark height
|
|
1575
|
+
*
|
|
1576
|
+
* Adjusts the height of the watermark image.
|
|
1577
|
+
*
|
|
1578
|
+
* Alias for: `markH`
|
|
1579
|
+
*
|
|
1580
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-h
|
|
1581
|
+
*/
|
|
1582
|
+
markh?: number;
|
|
1583
|
+
/**
|
|
1584
|
+
* Watermark padding
|
|
1585
|
+
*
|
|
1586
|
+
* Applies padding to the watermark image.
|
|
1587
|
+
*
|
|
1588
|
+
* Aliases: `mp`, `markpad`
|
|
1589
|
+
*
|
|
1590
|
+
* @defaultValue `5`
|
|
1591
|
+
*
|
|
1592
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-pad
|
|
1593
|
+
*/
|
|
1594
|
+
markPad?: number;
|
|
1595
|
+
/**
|
|
1596
|
+
* Watermark padding
|
|
1597
|
+
*
|
|
1598
|
+
* Applies padding to the watermark image.
|
|
1599
|
+
*
|
|
1600
|
+
* Alias for: `markPad`
|
|
1601
|
+
*
|
|
1602
|
+
* @defaultValue `5`
|
|
1603
|
+
*
|
|
1604
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-pad
|
|
1605
|
+
*/
|
|
1606
|
+
mp?: number;
|
|
1607
|
+
/**
|
|
1608
|
+
* Watermark padding
|
|
1609
|
+
*
|
|
1610
|
+
* Applies padding to the watermark image.
|
|
1611
|
+
*
|
|
1612
|
+
* Alias for: `markPad`
|
|
1613
|
+
*
|
|
1614
|
+
* @defaultValue `5`
|
|
1615
|
+
*
|
|
1616
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-pad
|
|
1617
|
+
*/
|
|
1618
|
+
markpad?: number;
|
|
1619
|
+
/**
|
|
1620
|
+
* Watermark rotation
|
|
1621
|
+
*
|
|
1622
|
+
* Rotates a watermark or tiled watermarks by a specified number of degrees.
|
|
1623
|
+
*
|
|
1624
|
+
* @defaultValue `0`
|
|
1625
|
+
*
|
|
1626
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-rot
|
|
1627
|
+
*/
|
|
1628
|
+
markRot?: number;
|
|
1629
|
+
/**
|
|
1630
|
+
* Watermark scale
|
|
1631
|
+
*
|
|
1632
|
+
* Adjusts the scale of the watermark image.
|
|
1633
|
+
*
|
|
1634
|
+
* Aliases: `ms`, `markscale`
|
|
1635
|
+
*
|
|
1636
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-scale
|
|
1637
|
+
*/
|
|
1638
|
+
markScale?: number;
|
|
1639
|
+
/**
|
|
1640
|
+
* Watermark scale
|
|
1641
|
+
*
|
|
1642
|
+
* Adjusts the scale of the watermark image.
|
|
1643
|
+
*
|
|
1644
|
+
* Alias for: `markScale`
|
|
1645
|
+
*
|
|
1646
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-scale
|
|
1647
|
+
*/
|
|
1648
|
+
ms?: number;
|
|
1649
|
+
/**
|
|
1650
|
+
* Watermark scale
|
|
1651
|
+
*
|
|
1652
|
+
* Adjusts the scale of the watermark image.
|
|
1653
|
+
*
|
|
1654
|
+
* Alias for: `markScale`
|
|
1655
|
+
*
|
|
1656
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-scale
|
|
1657
|
+
*/
|
|
1658
|
+
markscale?: number;
|
|
1659
|
+
/**
|
|
1660
|
+
* Watermark tile
|
|
1661
|
+
*
|
|
1662
|
+
* Adds tiled watermark.
|
|
1663
|
+
*
|
|
1664
|
+
* Aliases: `mtile`, `marktile`
|
|
1665
|
+
*
|
|
1666
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-tile
|
|
1667
|
+
*/
|
|
1668
|
+
markTile?: "grid";
|
|
1669
|
+
/**
|
|
1670
|
+
* Watermark tile
|
|
1671
|
+
*
|
|
1672
|
+
* Adds tiled watermark.
|
|
1673
|
+
*
|
|
1674
|
+
* Alias for: `markTile`
|
|
1675
|
+
*
|
|
1676
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-tile
|
|
1677
|
+
*/
|
|
1678
|
+
mtile?: "grid";
|
|
1679
|
+
/**
|
|
1680
|
+
* Watermark tile
|
|
1681
|
+
*
|
|
1682
|
+
* Adds tiled watermark.
|
|
1683
|
+
*
|
|
1684
|
+
* Alias for: `markTile`
|
|
1685
|
+
*
|
|
1686
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-tile
|
|
1687
|
+
*/
|
|
1688
|
+
marktile?: "grid";
|
|
1689
|
+
/**
|
|
1690
|
+
* Watermark width
|
|
1691
|
+
*
|
|
1692
|
+
* Adjusts the width of the watermark image.
|
|
1693
|
+
*
|
|
1694
|
+
* Aliases: `mw`, `markw`
|
|
1695
|
+
*
|
|
1696
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-w
|
|
1697
|
+
*/
|
|
1698
|
+
markW?: number;
|
|
1699
|
+
/**
|
|
1700
|
+
* Watermark width
|
|
1701
|
+
*
|
|
1702
|
+
* Adjusts the width of the watermark image.
|
|
1703
|
+
*
|
|
1704
|
+
* Alias for: `markW`
|
|
1705
|
+
*
|
|
1706
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-w
|
|
1707
|
+
*/
|
|
1708
|
+
mw?: number;
|
|
1709
|
+
/**
|
|
1710
|
+
* Watermark width
|
|
1711
|
+
*
|
|
1712
|
+
* Adjusts the width of the watermark image.
|
|
1713
|
+
*
|
|
1714
|
+
* Alias for: `markW`
|
|
1715
|
+
*
|
|
1716
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-w
|
|
1717
|
+
*/
|
|
1718
|
+
markw?: number;
|
|
1719
|
+
/**
|
|
1720
|
+
* Watermark x position
|
|
1721
|
+
*
|
|
1722
|
+
* Adjusts the x-offset of the watermark image relative to its parent.
|
|
1723
|
+
*
|
|
1724
|
+
* Aliases: `mx`, `markx`
|
|
1725
|
+
*
|
|
1726
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-x
|
|
1727
|
+
*/
|
|
1728
|
+
markX?: number;
|
|
1729
|
+
/**
|
|
1730
|
+
* Watermark x position
|
|
1731
|
+
*
|
|
1732
|
+
* Adjusts the x-offset of the watermark image relative to its parent.
|
|
1733
|
+
*
|
|
1734
|
+
* Alias for: `markX`
|
|
1735
|
+
*
|
|
1736
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-x
|
|
1737
|
+
*/
|
|
1738
|
+
mx?: number;
|
|
1739
|
+
/**
|
|
1740
|
+
* Watermark x position
|
|
1741
|
+
*
|
|
1742
|
+
* Adjusts the x-offset of the watermark image relative to its parent.
|
|
1743
|
+
*
|
|
1744
|
+
* Alias for: `markX`
|
|
1745
|
+
*
|
|
1746
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-x
|
|
1747
|
+
*/
|
|
1748
|
+
markx?: number;
|
|
1749
|
+
/**
|
|
1750
|
+
* Watermark y position
|
|
1751
|
+
*
|
|
1752
|
+
* Adjusts the y-offset of the watermark image relative to its parent.
|
|
1753
|
+
*
|
|
1754
|
+
* Aliases: `my`, `marky`
|
|
1755
|
+
*
|
|
1756
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-y
|
|
1757
|
+
*/
|
|
1758
|
+
markY?: number;
|
|
1759
|
+
/**
|
|
1760
|
+
* Watermark y position
|
|
1761
|
+
*
|
|
1762
|
+
* Adjusts the y-offset of the watermark image relative to its parent.
|
|
1763
|
+
*
|
|
1764
|
+
* Alias for: `markY`
|
|
1765
|
+
*
|
|
1766
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-y
|
|
1767
|
+
*/
|
|
1768
|
+
my?: number;
|
|
1769
|
+
/**
|
|
1770
|
+
* Watermark y position
|
|
1771
|
+
*
|
|
1772
|
+
* Adjusts the y-offset of the watermark image relative to its parent.
|
|
1773
|
+
*
|
|
1774
|
+
* Alias for: `markY`
|
|
1775
|
+
*
|
|
1776
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark-y
|
|
1777
|
+
*/
|
|
1778
|
+
marky?: number;
|
|
1779
|
+
/**
|
|
1780
|
+
* Watermark image url
|
|
1781
|
+
*
|
|
1782
|
+
* Specifies the location of the watermark image.
|
|
1783
|
+
*
|
|
1784
|
+
* Aliases: `m`
|
|
1785
|
+
*
|
|
1786
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark
|
|
1787
|
+
*/
|
|
1788
|
+
mark?: string;
|
|
1789
|
+
/**
|
|
1790
|
+
* Watermark image url
|
|
1791
|
+
*
|
|
1792
|
+
* Specifies the location of the watermark image.
|
|
1793
|
+
*
|
|
1794
|
+
* Alias for: `mark`
|
|
1795
|
+
*
|
|
1796
|
+
* @see https://docs.imgix.com/apis/url/watermark/mark
|
|
1797
|
+
*/
|
|
1798
|
+
m?: string;
|
|
1799
|
+
/**
|
|
1800
|
+
* Mask background color
|
|
1801
|
+
*
|
|
1802
|
+
* Colors the background of the transparent mask area of images
|
|
1803
|
+
*
|
|
1804
|
+
* Aliases: `maskbg`
|
|
1805
|
+
*
|
|
1806
|
+
* @defaultValue `"fff"`
|
|
1807
|
+
*
|
|
1808
|
+
* @see https://docs.imgix.com/apis/url/mask/mask-bg
|
|
1809
|
+
*/
|
|
1810
|
+
maskBg?: string | ColorKeyword;
|
|
1811
|
+
/**
|
|
1812
|
+
* Mask background color
|
|
1813
|
+
*
|
|
1814
|
+
* Colors the background of the transparent mask area of images
|
|
1815
|
+
*
|
|
1816
|
+
* Alias for: `maskBg`
|
|
1817
|
+
*
|
|
1818
|
+
* @defaultValue `"fff"`
|
|
1819
|
+
*
|
|
1820
|
+
* @see https://docs.imgix.com/apis/url/mask/mask-bg
|
|
1821
|
+
*/
|
|
1822
|
+
maskbg?: string | ColorKeyword;
|
|
1823
|
+
/**
|
|
1824
|
+
* Mask type
|
|
1825
|
+
*
|
|
1826
|
+
* Defines the type of mask and specifies the URL if that type is selected.
|
|
1827
|
+
*
|
|
1828
|
+
* @see https://docs.imgix.com/apis/url/mask
|
|
1829
|
+
*/
|
|
1830
|
+
mask?: "ellipse" | "corners" | string;
|
|
1831
|
+
/**
|
|
1832
|
+
* Maximum height
|
|
1833
|
+
*
|
|
1834
|
+
* Specifies the maximum height of the output image in pixels.
|
|
1835
|
+
*
|
|
1836
|
+
* Aliases: `maxHeight`
|
|
1837
|
+
*
|
|
1838
|
+
* @see https://docs.imgix.com/apis/url/size/max-height
|
|
1839
|
+
*/
|
|
1840
|
+
maxH?: number;
|
|
1841
|
+
/**
|
|
1842
|
+
* Maximum height
|
|
1843
|
+
*
|
|
1844
|
+
* Specifies the maximum height of the output image in pixels.
|
|
1845
|
+
*
|
|
1846
|
+
* Alias for: `maxH`
|
|
1847
|
+
*
|
|
1848
|
+
* @see https://docs.imgix.com/apis/url/size/max-height
|
|
1849
|
+
*/
|
|
1850
|
+
maxHeight?: number;
|
|
1851
|
+
/**
|
|
1852
|
+
* Maximum width
|
|
1853
|
+
*
|
|
1854
|
+
* Specifies the maximum width of the output image in pixels.
|
|
1855
|
+
*
|
|
1856
|
+
* Aliases: `maxWidth`
|
|
1857
|
+
*
|
|
1858
|
+
* @see https://docs.imgix.com/apis/url/size/max-width
|
|
1859
|
+
*/
|
|
1860
|
+
maxW?: number;
|
|
1861
|
+
/**
|
|
1862
|
+
* Maximum width
|
|
1863
|
+
*
|
|
1864
|
+
* Specifies the maximum width of the output image in pixels.
|
|
1865
|
+
*
|
|
1866
|
+
* Alias for: `maxW`
|
|
1867
|
+
*
|
|
1868
|
+
* @see https://docs.imgix.com/apis/url/size/max-width
|
|
1869
|
+
*/
|
|
1870
|
+
maxWidth?: number;
|
|
1871
|
+
/**
|
|
1872
|
+
* Minimum height
|
|
1873
|
+
*
|
|
1874
|
+
* Specifies the minimum height of the output image in pixels.
|
|
1875
|
+
*
|
|
1876
|
+
* Aliases: `minHeight`
|
|
1877
|
+
*
|
|
1878
|
+
* @see https://docs.imgix.com/apis/url/size/min-height
|
|
1879
|
+
*/
|
|
1880
|
+
minH?: number;
|
|
1881
|
+
/**
|
|
1882
|
+
* Minimum height
|
|
1883
|
+
*
|
|
1884
|
+
* Specifies the minimum height of the output image in pixels.
|
|
1885
|
+
*
|
|
1886
|
+
* Alias for: `minH`
|
|
1887
|
+
*
|
|
1888
|
+
* @see https://docs.imgix.com/apis/url/size/min-height
|
|
1889
|
+
*/
|
|
1890
|
+
minHeight?: number;
|
|
1891
|
+
/**
|
|
1892
|
+
* Minimum width
|
|
1893
|
+
*
|
|
1894
|
+
* Specifies the minimum width of the output image in pixels.
|
|
1895
|
+
*
|
|
1896
|
+
* Aliases: `minWidth`
|
|
1897
|
+
*
|
|
1898
|
+
* @see https://docs.imgix.com/apis/url/size/min-width
|
|
1899
|
+
*/
|
|
1900
|
+
minW?: number;
|
|
1901
|
+
/**
|
|
1902
|
+
* Minimum width
|
|
1903
|
+
*
|
|
1904
|
+
* Specifies the minimum width of the output image in pixels.
|
|
1905
|
+
*
|
|
1906
|
+
* Alias for: `minW`
|
|
1907
|
+
*
|
|
1908
|
+
* @see https://docs.imgix.com/apis/url/size/min-width
|
|
1909
|
+
*/
|
|
1910
|
+
minWidth?: number;
|
|
1911
|
+
/**
|
|
1912
|
+
* Monochrome
|
|
1913
|
+
*
|
|
1914
|
+
* Applies a monochrome effect to the source image.
|
|
1915
|
+
*
|
|
1916
|
+
* Aliases: `mono`
|
|
1917
|
+
*
|
|
1918
|
+
* @see https://docs.imgix.com/apis/url/stylize/monochrome
|
|
1919
|
+
*/
|
|
1920
|
+
monochrome?: string | ColorKeyword;
|
|
1921
|
+
/**
|
|
1922
|
+
* Monochrome
|
|
1923
|
+
*
|
|
1924
|
+
* Applies a monochrome effect to the source image.
|
|
1925
|
+
*
|
|
1926
|
+
* Alias for: `monochrome`
|
|
1927
|
+
*
|
|
1928
|
+
* @see https://docs.imgix.com/apis/url/stylize/monochrome
|
|
1929
|
+
*/
|
|
1930
|
+
mono?: string | ColorKeyword;
|
|
1931
|
+
/**
|
|
1932
|
+
* Noise reduction bound
|
|
1933
|
+
*
|
|
1934
|
+
* Reduces the noise in an image.
|
|
1935
|
+
*
|
|
1936
|
+
* @defaultValue `20`
|
|
1937
|
+
*
|
|
1938
|
+
* @see https://docs.imgix.com/apis/url/noise-reduction/nr
|
|
1939
|
+
*/
|
|
1940
|
+
nr?: number;
|
|
1941
|
+
/**
|
|
1942
|
+
* Noise reduction sharpen
|
|
1943
|
+
*
|
|
1944
|
+
* Provides a threshold by which to sharpen an image.
|
|
1945
|
+
*
|
|
1946
|
+
* @defaultValue `20`
|
|
1947
|
+
*
|
|
1948
|
+
* @see https://docs.imgix.com/apis/url/noise-reduction/nrs
|
|
1949
|
+
*/
|
|
1950
|
+
nrs?: number;
|
|
1951
|
+
/**
|
|
1952
|
+
* Orientation
|
|
1953
|
+
*
|
|
1954
|
+
* Changes the image orientation.
|
|
1955
|
+
*
|
|
1956
|
+
* Aliases: `or`
|
|
1957
|
+
*
|
|
1958
|
+
* @see https://docs.imgix.com/apis/url/rotation/orient
|
|
1959
|
+
*/
|
|
1960
|
+
orient?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 90 | 180 | 270;
|
|
1961
|
+
/**
|
|
1962
|
+
* Orientation
|
|
1963
|
+
*
|
|
1964
|
+
* Changes the image orientation.
|
|
1965
|
+
*
|
|
1966
|
+
* Alias for: `orient`
|
|
1967
|
+
*
|
|
1968
|
+
* @see https://docs.imgix.com/apis/url/rotation/orient
|
|
1969
|
+
*/
|
|
1970
|
+
or?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 90 | 180 | 270;
|
|
1971
|
+
/**
|
|
1972
|
+
* Padding bottom
|
|
1973
|
+
*
|
|
1974
|
+
* Sets bottom padding of an image.
|
|
1975
|
+
*
|
|
1976
|
+
* @see https://docs.imgix.com/apis/url/border-and-padding/pad-bottom
|
|
1977
|
+
*/
|
|
1978
|
+
padBottom?: number;
|
|
1979
|
+
/**
|
|
1980
|
+
* Padding left
|
|
1981
|
+
*
|
|
1982
|
+
* Sets left padding of an image.
|
|
1983
|
+
*
|
|
1984
|
+
* @see https://docs.imgix.com/apis/url/border-and-padding/pad-left
|
|
1985
|
+
*/
|
|
1986
|
+
padLeft?: number;
|
|
1987
|
+
/**
|
|
1988
|
+
* Padding right
|
|
1989
|
+
*
|
|
1990
|
+
* Sets right padding of an image.
|
|
1991
|
+
*
|
|
1992
|
+
* @see https://docs.imgix.com/apis/url/border-and-padding/pad-right
|
|
1993
|
+
*/
|
|
1994
|
+
padRight?: number;
|
|
1995
|
+
/**
|
|
1996
|
+
* Padding top
|
|
1997
|
+
*
|
|
1998
|
+
* Sets top padding of an image.
|
|
1999
|
+
*
|
|
2000
|
+
* @see https://docs.imgix.com/apis/url/border-and-padding/pad-top
|
|
2001
|
+
*/
|
|
2002
|
+
padTop?: number;
|
|
2003
|
+
/**
|
|
2004
|
+
* Padding
|
|
2005
|
+
*
|
|
2006
|
+
* Pads an image.
|
|
2007
|
+
*
|
|
2008
|
+
* @defaultValue `0`
|
|
2009
|
+
*
|
|
2010
|
+
* @see https://docs.imgix.com/apis/url/border-and-padding/pad
|
|
2011
|
+
*/
|
|
2012
|
+
pad?: number;
|
|
2013
|
+
/**
|
|
2014
|
+
* Pdf page number
|
|
2015
|
+
*
|
|
2016
|
+
* Selects a page from a PDF for display.
|
|
2017
|
+
*
|
|
2018
|
+
* @defaultValue `1`
|
|
2019
|
+
*
|
|
2020
|
+
* @see https://docs.imgix.com/apis/url/pdf/page
|
|
2021
|
+
*/
|
|
2022
|
+
page?: number;
|
|
2023
|
+
/**
|
|
2024
|
+
* Color palette extraction
|
|
2025
|
+
*
|
|
2026
|
+
* Specifies an output format for palette-extraction.
|
|
2027
|
+
*
|
|
2028
|
+
* @see https://docs.imgix.com/apis/url/color-palette/palette
|
|
2029
|
+
*/
|
|
2030
|
+
palette?: "css" | "json";
|
|
2031
|
+
/**
|
|
2032
|
+
* Pdf annotation
|
|
2033
|
+
*
|
|
2034
|
+
* Enables or disables PDF annotation.
|
|
2035
|
+
*
|
|
2036
|
+
* Aliases: `annotation`
|
|
2037
|
+
*
|
|
2038
|
+
* @defaultValue `true`
|
|
2039
|
+
*
|
|
2040
|
+
* @see https://docs.imgix.com/apis/url/pdf/pdf-annotation
|
|
2041
|
+
*/
|
|
2042
|
+
pdfAnnotation?: boolean;
|
|
2043
|
+
/**
|
|
2044
|
+
* Pdf annotation
|
|
2045
|
+
*
|
|
2046
|
+
* Enables or disables PDF annotation.
|
|
2047
|
+
*
|
|
2048
|
+
* Alias for: `pdfAnnotation`
|
|
2049
|
+
*
|
|
2050
|
+
* @defaultValue `true`
|
|
2051
|
+
*
|
|
2052
|
+
* @see https://docs.imgix.com/apis/url/pdf/pdf-annotation
|
|
2053
|
+
*/
|
|
2054
|
+
annotation?: boolean;
|
|
2055
|
+
/**
|
|
2056
|
+
* Css prefix
|
|
2057
|
+
*
|
|
2058
|
+
* Specifies a CSS prefix for all classes in palette-extraction.
|
|
2059
|
+
*
|
|
2060
|
+
* @defaultValue `"image"`
|
|
2061
|
+
*
|
|
2062
|
+
* @see https://docs.imgix.com/apis/url/color-palette/prefix
|
|
2063
|
+
*/
|
|
2064
|
+
prefix?: string;
|
|
2065
|
+
/**
|
|
2066
|
+
* Pixellate
|
|
2067
|
+
*
|
|
2068
|
+
* Applies a pixelation effect to an image.
|
|
2069
|
+
*
|
|
2070
|
+
* @defaultValue `0`
|
|
2071
|
+
*
|
|
2072
|
+
* @see https://docs.imgix.com/apis/url/stylize/px
|
|
2073
|
+
*/
|
|
2074
|
+
px?: number;
|
|
2075
|
+
/**
|
|
2076
|
+
* Output quality
|
|
2077
|
+
*
|
|
2078
|
+
* Adjusts the quality of an output image.
|
|
2079
|
+
*
|
|
2080
|
+
* @defaultValue `75`
|
|
2081
|
+
*
|
|
2082
|
+
* @see https://docs.imgix.com/apis/url/format/q
|
|
2083
|
+
*/
|
|
2084
|
+
q?: number;
|
|
2085
|
+
/**
|
|
2086
|
+
* Source rectangle region
|
|
2087
|
+
*
|
|
2088
|
+
* Crops an image to a specified rectangle.
|
|
2089
|
+
*
|
|
2090
|
+
* @see https://docs.imgix.com/apis/url/size/rect
|
|
2091
|
+
*/
|
|
2092
|
+
rect?: [
|
|
2093
|
+
number | "left" | "center" | "right",
|
|
2094
|
+
number | "top" | "middle" | "bottom",
|
|
2095
|
+
number,
|
|
2096
|
+
number,
|
|
2097
|
+
];
|
|
2098
|
+
/**
|
|
2099
|
+
* Rotation
|
|
2100
|
+
*
|
|
2101
|
+
* Rotates an image by a specified number of degrees.
|
|
2102
|
+
*
|
|
2103
|
+
* @defaultValue `0`
|
|
2104
|
+
*
|
|
2105
|
+
* @see https://docs.imgix.com/apis/url/rotation/rot
|
|
2106
|
+
*/
|
|
2107
|
+
rot?: number;
|
|
2108
|
+
/**
|
|
2109
|
+
* Saturation
|
|
2110
|
+
*
|
|
2111
|
+
* Adjusts the saturation of an image.
|
|
2112
|
+
*
|
|
2113
|
+
* @defaultValue `0`
|
|
2114
|
+
*
|
|
2115
|
+
* @see https://docs.imgix.com/apis/url/adjustment/sat
|
|
2116
|
+
*/
|
|
2117
|
+
sat?: number;
|
|
2118
|
+
/**
|
|
2119
|
+
* Sepia tone
|
|
2120
|
+
*
|
|
2121
|
+
* Applies a sepia effect to an image.
|
|
2122
|
+
*
|
|
2123
|
+
* @defaultValue `0`
|
|
2124
|
+
*
|
|
2125
|
+
* @see https://docs.imgix.com/apis/url/stylize/sepia
|
|
2126
|
+
*/
|
|
2127
|
+
sepia?: number;
|
|
2128
|
+
/**
|
|
2129
|
+
* Shadow
|
|
2130
|
+
*
|
|
2131
|
+
* Adjusts the highlights of the source image.
|
|
2132
|
+
*
|
|
2133
|
+
* @defaultValue `0`
|
|
2134
|
+
*
|
|
2135
|
+
* @see https://docs.imgix.com/apis/url/adjustment/shad
|
|
2136
|
+
*/
|
|
2137
|
+
shad?: number;
|
|
2138
|
+
/**
|
|
2139
|
+
* Sharpen
|
|
2140
|
+
*
|
|
2141
|
+
* Adjusts the sharpness of the source image.
|
|
2142
|
+
*
|
|
2143
|
+
* @defaultValue `0`
|
|
2144
|
+
*
|
|
2145
|
+
* @see https://docs.imgix.com/apis/url/adjustment/sharp
|
|
2146
|
+
*/
|
|
2147
|
+
sharp?: number;
|
|
2148
|
+
/**
|
|
2149
|
+
* Transparency
|
|
2150
|
+
*
|
|
2151
|
+
* Adds checkerboard behind images which support transparency.
|
|
2152
|
+
*
|
|
2153
|
+
* @see https://docs.imgix.com/apis/url/fill/transparency
|
|
2154
|
+
*/
|
|
2155
|
+
transparency?: "grid";
|
|
2156
|
+
/**
|
|
2157
|
+
* Trim color
|
|
2158
|
+
*
|
|
2159
|
+
* Specifies a trim color on a trim operation.
|
|
2160
|
+
*
|
|
2161
|
+
* Aliases: `trimcolor`
|
|
2162
|
+
*
|
|
2163
|
+
* @see https://docs.imgix.com/apis/url/trim/trim-color
|
|
2164
|
+
*/
|
|
2165
|
+
trimColor?: string | ColorKeyword;
|
|
2166
|
+
/**
|
|
2167
|
+
* Trim color
|
|
2168
|
+
*
|
|
2169
|
+
* Specifies a trim color on a trim operation.
|
|
2170
|
+
*
|
|
2171
|
+
* Alias for: `trimColor`
|
|
2172
|
+
*
|
|
2173
|
+
* @see https://docs.imgix.com/apis/url/trim/trim-color
|
|
2174
|
+
*/
|
|
2175
|
+
trimcolor?: string | ColorKeyword;
|
|
2176
|
+
/**
|
|
2177
|
+
* Trim mean difference
|
|
2178
|
+
*
|
|
2179
|
+
* Specifies the mean difference on a trim operation.
|
|
2180
|
+
*
|
|
2181
|
+
* Aliases: `trimmd`
|
|
2182
|
+
*
|
|
2183
|
+
* @defaultValue `11`
|
|
2184
|
+
*
|
|
2185
|
+
* @see https://docs.imgix.com/apis/url/trim/trim-md
|
|
2186
|
+
*/
|
|
2187
|
+
trimMd?: number;
|
|
2188
|
+
/**
|
|
2189
|
+
* Trim mean difference
|
|
2190
|
+
*
|
|
2191
|
+
* Specifies the mean difference on a trim operation.
|
|
2192
|
+
*
|
|
2193
|
+
* Alias for: `trimMd`
|
|
2194
|
+
*
|
|
2195
|
+
* @defaultValue `11`
|
|
2196
|
+
*
|
|
2197
|
+
* @see https://docs.imgix.com/apis/url/trim/trim-md
|
|
2198
|
+
*/
|
|
2199
|
+
trimmd?: number;
|
|
2200
|
+
/**
|
|
2201
|
+
* Trim padding
|
|
2202
|
+
*
|
|
2203
|
+
* Pads the area of the source image before trimming.
|
|
2204
|
+
*
|
|
2205
|
+
* Aliases: `trimpad`
|
|
2206
|
+
*
|
|
2207
|
+
* @defaultValue `0`
|
|
2208
|
+
*
|
|
2209
|
+
* @see https://docs.imgix.com/apis/url/trim/trim-pad
|
|
2210
|
+
*/
|
|
2211
|
+
trimPad?: number;
|
|
2212
|
+
/**
|
|
2213
|
+
* Trim padding
|
|
2214
|
+
*
|
|
2215
|
+
* Pads the area of the source image before trimming.
|
|
2216
|
+
*
|
|
2217
|
+
* Alias for: `trimPad`
|
|
2218
|
+
*
|
|
2219
|
+
* @defaultValue `0`
|
|
2220
|
+
*
|
|
2221
|
+
* @see https://docs.imgix.com/apis/url/trim/trim-pad
|
|
2222
|
+
*/
|
|
2223
|
+
trimpad?: number;
|
|
2224
|
+
/**
|
|
2225
|
+
* Trim standard deviation
|
|
2226
|
+
*
|
|
2227
|
+
* Specifies the standard deviation on a trim operation.
|
|
2228
|
+
*
|
|
2229
|
+
* Aliases: `trimsd`
|
|
2230
|
+
*
|
|
2231
|
+
* @defaultValue `10`
|
|
2232
|
+
*
|
|
2233
|
+
* @see https://docs.imgix.com/apis/url/trim/trim-sd
|
|
2234
|
+
*/
|
|
2235
|
+
trimSd?: number;
|
|
2236
|
+
/**
|
|
2237
|
+
* Trim standard deviation
|
|
2238
|
+
*
|
|
2239
|
+
* Specifies the standard deviation on a trim operation.
|
|
2240
|
+
*
|
|
2241
|
+
* Alias for: `trimSd`
|
|
2242
|
+
*
|
|
2243
|
+
* @defaultValue `10`
|
|
2244
|
+
*
|
|
2245
|
+
* @see https://docs.imgix.com/apis/url/trim/trim-sd
|
|
2246
|
+
*/
|
|
2247
|
+
trimsd?: number;
|
|
2248
|
+
/**
|
|
2249
|
+
* Trim tolerance
|
|
2250
|
+
*
|
|
2251
|
+
* Specifies the tolerance on a trim operation.
|
|
2252
|
+
*
|
|
2253
|
+
* Aliases: `trimtol`
|
|
2254
|
+
*
|
|
2255
|
+
* @defaultValue `0`
|
|
2256
|
+
*
|
|
2257
|
+
* @see https://docs.imgix.com/apis/url/trim/trim-tol
|
|
2258
|
+
*/
|
|
2259
|
+
trimTol?: number;
|
|
2260
|
+
/**
|
|
2261
|
+
* Trim tolerance
|
|
2262
|
+
*
|
|
2263
|
+
* Specifies the tolerance on a trim operation.
|
|
2264
|
+
*
|
|
2265
|
+
* Alias for: `trimTol`
|
|
2266
|
+
*
|
|
2267
|
+
* @defaultValue `0`
|
|
2268
|
+
*
|
|
2269
|
+
* @see https://docs.imgix.com/apis/url/trim/trim-tol
|
|
2270
|
+
*/
|
|
2271
|
+
trimtol?: number;
|
|
2272
|
+
/**
|
|
2273
|
+
* Trim image
|
|
2274
|
+
*
|
|
2275
|
+
* Trims the source image.
|
|
2276
|
+
*
|
|
2277
|
+
* @see https://docs.imgix.com/apis/url/trim/trim
|
|
2278
|
+
*/
|
|
2279
|
+
trim?: "auto" | "color";
|
|
2280
|
+
/**
|
|
2281
|
+
* Text align
|
|
2282
|
+
*
|
|
2283
|
+
* Sets the vertical and horizontal alignment of rendered text relative to the
|
|
2284
|
+
* base image.
|
|
2285
|
+
*
|
|
2286
|
+
* Aliases: `txtalign`, `ta`
|
|
2287
|
+
*
|
|
2288
|
+
* @see https://docs.imgix.com/apis/url/text/txt-align
|
|
2289
|
+
*/
|
|
2290
|
+
txtAlign?: ("top" | "middle" | "bottom" | "left" | "center" | "right")[];
|
|
2291
|
+
/**
|
|
2292
|
+
* Text align
|
|
2293
|
+
*
|
|
2294
|
+
* Sets the vertical and horizontal alignment of rendered text relative to the
|
|
2295
|
+
* base image.
|
|
2296
|
+
*
|
|
2297
|
+
* Alias for: `txtAlign`
|
|
2298
|
+
*
|
|
2299
|
+
* @see https://docs.imgix.com/apis/url/text/txt-align
|
|
2300
|
+
*/
|
|
2301
|
+
txtalign?: ("top" | "middle" | "bottom" | "left" | "center" | "right")[];
|
|
2302
|
+
/**
|
|
2303
|
+
* Text align
|
|
2304
|
+
*
|
|
2305
|
+
* Sets the vertical and horizontal alignment of rendered text relative to the
|
|
2306
|
+
* base image.
|
|
2307
|
+
*
|
|
2308
|
+
* Alias for: `txtAlign`
|
|
2309
|
+
*
|
|
2310
|
+
* @see https://docs.imgix.com/apis/url/text/txt-align
|
|
2311
|
+
*/
|
|
2312
|
+
ta?: ("top" | "middle" | "bottom" | "left" | "center" | "right")[];
|
|
2313
|
+
/**
|
|
2314
|
+
* Text clipping mode
|
|
2315
|
+
*
|
|
2316
|
+
* Sets the clipping properties of rendered text.
|
|
2317
|
+
*
|
|
2318
|
+
* Aliases: `txtclip`, `tcl`
|
|
2319
|
+
*
|
|
2320
|
+
* @defaultValue `"end"`
|
|
2321
|
+
*
|
|
2322
|
+
* @see https://docs.imgix.com/apis/url/text/txt-clip
|
|
2323
|
+
*/
|
|
2324
|
+
txtClip?: ("start" | "middle" | "end" | "ellipsis")[];
|
|
2325
|
+
/**
|
|
2326
|
+
* Text clipping mode
|
|
2327
|
+
*
|
|
2328
|
+
* Sets the clipping properties of rendered text.
|
|
2329
|
+
*
|
|
2330
|
+
* Alias for: `txtClip`
|
|
2331
|
+
*
|
|
2332
|
+
* @defaultValue `"end"`
|
|
2333
|
+
*
|
|
2334
|
+
* @see https://docs.imgix.com/apis/url/text/txt-clip
|
|
2335
|
+
*/
|
|
2336
|
+
txtclip?: ("start" | "middle" | "end" | "ellipsis")[];
|
|
2337
|
+
/**
|
|
2338
|
+
* Text clipping mode
|
|
2339
|
+
*
|
|
2340
|
+
* Sets the clipping properties of rendered text.
|
|
2341
|
+
*
|
|
2342
|
+
* Alias for: `txtClip`
|
|
2343
|
+
*
|
|
2344
|
+
* @defaultValue `"end"`
|
|
2345
|
+
*
|
|
2346
|
+
* @see https://docs.imgix.com/apis/url/text/txt-clip
|
|
2347
|
+
*/
|
|
2348
|
+
tcl?: ("start" | "middle" | "end" | "ellipsis")[];
|
|
2349
|
+
/**
|
|
2350
|
+
* Text color
|
|
2351
|
+
*
|
|
2352
|
+
* Specifies the color of rendered text.
|
|
2353
|
+
*
|
|
2354
|
+
* Aliases: `txtcolor`, `txtClr`, `txtclr`, `tc`
|
|
2355
|
+
*
|
|
2356
|
+
* @see https://docs.imgix.com/apis/url/text/txt-color
|
|
2357
|
+
*/
|
|
2358
|
+
txtColor?: string | ColorKeyword;
|
|
2359
|
+
/**
|
|
2360
|
+
* Text color
|
|
2361
|
+
*
|
|
2362
|
+
* Specifies the color of rendered text.
|
|
2363
|
+
*
|
|
2364
|
+
* Alias for: `txtColor`
|
|
2365
|
+
*
|
|
2366
|
+
* @see https://docs.imgix.com/apis/url/text/txt-color
|
|
2367
|
+
*/
|
|
2368
|
+
txtcolor?: string | ColorKeyword;
|
|
2369
|
+
/**
|
|
2370
|
+
* Text color
|
|
2371
|
+
*
|
|
2372
|
+
* Specifies the color of rendered text.
|
|
2373
|
+
*
|
|
2374
|
+
* Alias for: `txtColor`
|
|
2375
|
+
*
|
|
2376
|
+
* @see https://docs.imgix.com/apis/url/text/txt-color
|
|
2377
|
+
*/
|
|
2378
|
+
txtClr?: string | ColorKeyword;
|
|
2379
|
+
/**
|
|
2380
|
+
* Text color
|
|
2381
|
+
*
|
|
2382
|
+
* Specifies the color of rendered text.
|
|
2383
|
+
*
|
|
2384
|
+
* Alias for: `txtColor`
|
|
2385
|
+
*
|
|
2386
|
+
* @see https://docs.imgix.com/apis/url/text/txt-color
|
|
2387
|
+
*/
|
|
2388
|
+
txtclr?: string | ColorKeyword;
|
|
2389
|
+
/**
|
|
2390
|
+
* Text color
|
|
2391
|
+
*
|
|
2392
|
+
* Specifies the color of rendered text.
|
|
2393
|
+
*
|
|
2394
|
+
* Alias for: `txtColor`
|
|
2395
|
+
*
|
|
2396
|
+
* @see https://docs.imgix.com/apis/url/text/txt-color
|
|
2397
|
+
*/
|
|
2398
|
+
tc?: string | ColorKeyword;
|
|
2399
|
+
/**
|
|
2400
|
+
* Text fit mode
|
|
2401
|
+
*
|
|
2402
|
+
* Specifies the fit approach for rendered text.
|
|
2403
|
+
*
|
|
2404
|
+
* Aliases: `txtfit`
|
|
2405
|
+
*
|
|
2406
|
+
* @see https://docs.imgix.com/apis/url/text/txt-fit
|
|
2407
|
+
*/
|
|
2408
|
+
txtFit?: "max";
|
|
2409
|
+
/**
|
|
2410
|
+
* Text fit mode
|
|
2411
|
+
*
|
|
2412
|
+
* Specifies the fit approach for rendered text.
|
|
2413
|
+
*
|
|
2414
|
+
* Alias for: `txtFit`
|
|
2415
|
+
*
|
|
2416
|
+
* @see https://docs.imgix.com/apis/url/text/txt-fit
|
|
2417
|
+
*/
|
|
2418
|
+
txtfit?: "max";
|
|
2419
|
+
/**
|
|
2420
|
+
* Text font
|
|
2421
|
+
*
|
|
2422
|
+
* Selects a font for rendered text.
|
|
2423
|
+
*
|
|
2424
|
+
* Aliases: `tf`, `txtfont`
|
|
2425
|
+
*
|
|
2426
|
+
* @see https://docs.imgix.com/apis/url/text/txt-font
|
|
2427
|
+
*/
|
|
2428
|
+
txtFont?: Font;
|
|
2429
|
+
/**
|
|
2430
|
+
* Text font
|
|
2431
|
+
*
|
|
2432
|
+
* Selects a font for rendered text.
|
|
2433
|
+
*
|
|
2434
|
+
* Alias for: `txtFont`
|
|
2435
|
+
*
|
|
2436
|
+
* @see https://docs.imgix.com/apis/url/text/txt-font
|
|
2437
|
+
*/
|
|
2438
|
+
tf?: Font;
|
|
2439
|
+
/**
|
|
2440
|
+
* Text font
|
|
2441
|
+
*
|
|
2442
|
+
* Selects a font for rendered text.
|
|
2443
|
+
*
|
|
2444
|
+
* Alias for: `txtFont`
|
|
2445
|
+
*
|
|
2446
|
+
* @see https://docs.imgix.com/apis/url/text/txt-font
|
|
2447
|
+
*/
|
|
2448
|
+
txtfont?: Font;
|
|
2449
|
+
/**
|
|
2450
|
+
* Text leading
|
|
2451
|
+
*
|
|
2452
|
+
* Sets the leading (line spacing) for rendered text. Only works on the
|
|
2453
|
+
* multi-line text endpoint.
|
|
2454
|
+
*
|
|
2455
|
+
* Aliases: `txtlead`
|
|
2456
|
+
*
|
|
2457
|
+
* @defaultValue `0`
|
|
2458
|
+
*
|
|
2459
|
+
* @see https://docs.imgix.com/apis/url/typesetting/txt-lead
|
|
2460
|
+
*/
|
|
2461
|
+
txtLead?: number;
|
|
2462
|
+
/**
|
|
2463
|
+
* Text leading
|
|
2464
|
+
*
|
|
2465
|
+
* Sets the leading (line spacing) for rendered text. Only works on the
|
|
2466
|
+
* multi-line text endpoint.
|
|
2467
|
+
*
|
|
2468
|
+
* Alias for: `txtLead`
|
|
2469
|
+
*
|
|
2470
|
+
* @defaultValue `0`
|
|
2471
|
+
*
|
|
2472
|
+
* @see https://docs.imgix.com/apis/url/typesetting/txt-lead
|
|
2473
|
+
*/
|
|
2474
|
+
txtlead?: number;
|
|
2475
|
+
/**
|
|
2476
|
+
* Text ligatures
|
|
2477
|
+
*
|
|
2478
|
+
* Controls the level of ligature substitution
|
|
2479
|
+
*
|
|
2480
|
+
* Aliases: `txtlig`
|
|
2481
|
+
*
|
|
2482
|
+
* @see https://docs.imgix.com/apis/url/text/txt-lig
|
|
2483
|
+
*/
|
|
2484
|
+
txtLig?: 0 | 1 | 2;
|
|
2485
|
+
/**
|
|
2486
|
+
* Text ligatures
|
|
2487
|
+
*
|
|
2488
|
+
* Controls the level of ligature substitution
|
|
2489
|
+
*
|
|
2490
|
+
* Alias for: `txtLig`
|
|
2491
|
+
*
|
|
2492
|
+
* @see https://docs.imgix.com/apis/url/text/txt-lig
|
|
2493
|
+
*/
|
|
2494
|
+
txtlig?: 0 | 1 | 2;
|
|
2495
|
+
/**
|
|
2496
|
+
* Text outline color
|
|
2497
|
+
*
|
|
2498
|
+
* Specifies a text outline color.
|
|
2499
|
+
*
|
|
2500
|
+
* Aliases: `txtlinecolor`, `txtLineClr`, `txtlineclr`
|
|
2501
|
+
*
|
|
2502
|
+
* @defaultValue `"fff"`
|
|
2503
|
+
*
|
|
2504
|
+
* @see https://docs.imgix.com/apis/url/text/txt-line-color
|
|
2505
|
+
*/
|
|
2506
|
+
txtLineColor?: string | ColorKeyword;
|
|
2507
|
+
/**
|
|
2508
|
+
* Text outline color
|
|
2509
|
+
*
|
|
2510
|
+
* Specifies a text outline color.
|
|
2511
|
+
*
|
|
2512
|
+
* Alias for: `txtLineColor`
|
|
2513
|
+
*
|
|
2514
|
+
* @defaultValue `"fff"`
|
|
2515
|
+
*
|
|
2516
|
+
* @see https://docs.imgix.com/apis/url/text/txt-line-color
|
|
2517
|
+
*/
|
|
2518
|
+
txtlinecolor?: string | ColorKeyword;
|
|
2519
|
+
/**
|
|
2520
|
+
* Text outline color
|
|
2521
|
+
*
|
|
2522
|
+
* Specifies a text outline color.
|
|
2523
|
+
*
|
|
2524
|
+
* Alias for: `txtLineColor`
|
|
2525
|
+
*
|
|
2526
|
+
* @defaultValue `"fff"`
|
|
2527
|
+
*
|
|
2528
|
+
* @see https://docs.imgix.com/apis/url/text/txt-line-color
|
|
2529
|
+
*/
|
|
2530
|
+
txtLineClr?: string | ColorKeyword;
|
|
2531
|
+
/**
|
|
2532
|
+
* Text outline color
|
|
2533
|
+
*
|
|
2534
|
+
* Specifies a text outline color.
|
|
2535
|
+
*
|
|
2536
|
+
* Alias for: `txtLineColor`
|
|
2537
|
+
*
|
|
2538
|
+
* @defaultValue `"fff"`
|
|
2539
|
+
*
|
|
2540
|
+
* @see https://docs.imgix.com/apis/url/text/txt-line-color
|
|
2541
|
+
*/
|
|
2542
|
+
txtlineclr?: string | ColorKeyword;
|
|
2543
|
+
/**
|
|
2544
|
+
* Text outline
|
|
2545
|
+
*
|
|
2546
|
+
* Outlines the rendered text with a specified color.
|
|
2547
|
+
*
|
|
2548
|
+
* Aliases: `txtline`, `tl`
|
|
2549
|
+
*
|
|
2550
|
+
* @defaultValue `0`
|
|
2551
|
+
*
|
|
2552
|
+
* @see https://docs.imgix.com/apis/url/text/txt-line
|
|
2553
|
+
*/
|
|
2554
|
+
txtLine?: number;
|
|
2555
|
+
/**
|
|
2556
|
+
* Text outline
|
|
2557
|
+
*
|
|
2558
|
+
* Outlines the rendered text with a specified color.
|
|
2559
|
+
*
|
|
2560
|
+
* Alias for: `txtLine`
|
|
2561
|
+
*
|
|
2562
|
+
* @defaultValue `0`
|
|
2563
|
+
*
|
|
2564
|
+
* @see https://docs.imgix.com/apis/url/text/txt-line
|
|
2565
|
+
*/
|
|
2566
|
+
txtline?: number;
|
|
2567
|
+
/**
|
|
2568
|
+
* Text outline
|
|
2569
|
+
*
|
|
2570
|
+
* Outlines the rendered text with a specified color.
|
|
2571
|
+
*
|
|
2572
|
+
* Alias for: `txtLine`
|
|
2573
|
+
*
|
|
2574
|
+
* @defaultValue `0`
|
|
2575
|
+
*
|
|
2576
|
+
* @see https://docs.imgix.com/apis/url/text/txt-line
|
|
2577
|
+
*/
|
|
2578
|
+
tl?: number;
|
|
2579
|
+
/**
|
|
2580
|
+
* Text padding
|
|
2581
|
+
*
|
|
2582
|
+
* Specifies the padding (in device-independent pixels) between a textbox and
|
|
2583
|
+
* the edges of the base image.
|
|
2584
|
+
*
|
|
2585
|
+
* Aliases: `txtpad`, `tp`
|
|
2586
|
+
*
|
|
2587
|
+
* @see https://docs.imgix.com/apis/url/text/txt-pad
|
|
2588
|
+
*/
|
|
2589
|
+
txtPad?: number;
|
|
2590
|
+
/**
|
|
2591
|
+
* Text padding
|
|
2592
|
+
*
|
|
2593
|
+
* Specifies the padding (in device-independent pixels) between a textbox and
|
|
2594
|
+
* the edges of the base image.
|
|
2595
|
+
*
|
|
2596
|
+
* Alias for: `txtPad`
|
|
2597
|
+
*
|
|
2598
|
+
* @see https://docs.imgix.com/apis/url/text/txt-pad
|
|
2599
|
+
*/
|
|
2600
|
+
txtpad?: number;
|
|
2601
|
+
/**
|
|
2602
|
+
* Text padding
|
|
2603
|
+
*
|
|
2604
|
+
* Specifies the padding (in device-independent pixels) between a textbox and
|
|
2605
|
+
* the edges of the base image.
|
|
2606
|
+
*
|
|
2607
|
+
* Alias for: `txtPad`
|
|
2608
|
+
*
|
|
2609
|
+
* @see https://docs.imgix.com/apis/url/text/txt-pad
|
|
2610
|
+
*/
|
|
2611
|
+
tp?: number;
|
|
2612
|
+
/**
|
|
2613
|
+
* Text shadow
|
|
2614
|
+
*
|
|
2615
|
+
* Applies a shadow to rendered text.
|
|
2616
|
+
*
|
|
2617
|
+
* Aliases: `txtshad`, `tsh`
|
|
2618
|
+
*
|
|
2619
|
+
* @defaultValue `0`
|
|
2620
|
+
*
|
|
2621
|
+
* @see https://docs.imgix.com/apis/url/text/txt-shad
|
|
2622
|
+
*/
|
|
2623
|
+
txtShad?: number;
|
|
2624
|
+
/**
|
|
2625
|
+
* Text shadow
|
|
2626
|
+
*
|
|
2627
|
+
* Applies a shadow to rendered text.
|
|
2628
|
+
*
|
|
2629
|
+
* Alias for: `txtShad`
|
|
2630
|
+
*
|
|
2631
|
+
* @defaultValue `0`
|
|
2632
|
+
*
|
|
2633
|
+
* @see https://docs.imgix.com/apis/url/text/txt-shad
|
|
2634
|
+
*/
|
|
2635
|
+
txtshad?: number;
|
|
2636
|
+
/**
|
|
2637
|
+
* Text shadow
|
|
2638
|
+
*
|
|
2639
|
+
* Applies a shadow to rendered text.
|
|
2640
|
+
*
|
|
2641
|
+
* Alias for: `txtShad`
|
|
2642
|
+
*
|
|
2643
|
+
* @defaultValue `0`
|
|
2644
|
+
*
|
|
2645
|
+
* @see https://docs.imgix.com/apis/url/text/txt-shad
|
|
2646
|
+
*/
|
|
2647
|
+
tsh?: number;
|
|
2648
|
+
/**
|
|
2649
|
+
* Text font size
|
|
2650
|
+
*
|
|
2651
|
+
* Sets the font size of rendered text.
|
|
2652
|
+
*
|
|
2653
|
+
* Aliases: `tsz`, `txtsize`
|
|
2654
|
+
*
|
|
2655
|
+
* @defaultValue `12`
|
|
2656
|
+
*
|
|
2657
|
+
* @see https://docs.imgix.com/apis/url/text/txt-size
|
|
2658
|
+
*/
|
|
2659
|
+
txtSize?: number;
|
|
2660
|
+
/**
|
|
2661
|
+
* Text font size
|
|
2662
|
+
*
|
|
2663
|
+
* Sets the font size of rendered text.
|
|
2664
|
+
*
|
|
2665
|
+
* Alias for: `txtSize`
|
|
2666
|
+
*
|
|
2667
|
+
* @defaultValue `12`
|
|
2668
|
+
*
|
|
2669
|
+
* @see https://docs.imgix.com/apis/url/text/txt-size
|
|
2670
|
+
*/
|
|
2671
|
+
tsz?: number;
|
|
2672
|
+
/**
|
|
2673
|
+
* Text font size
|
|
2674
|
+
*
|
|
2675
|
+
* Sets the font size of rendered text.
|
|
2676
|
+
*
|
|
2677
|
+
* Alias for: `txtSize`
|
|
2678
|
+
*
|
|
2679
|
+
* @defaultValue `12`
|
|
2680
|
+
*
|
|
2681
|
+
* @see https://docs.imgix.com/apis/url/text/txt-size
|
|
2682
|
+
*/
|
|
2683
|
+
txtsize?: number;
|
|
2684
|
+
/**
|
|
2685
|
+
* Text tracking
|
|
2686
|
+
*
|
|
2687
|
+
* Sets the tracking (letter spacing) for rendered text. Only works on the
|
|
2688
|
+
* multi-line text endpoint.
|
|
2689
|
+
*
|
|
2690
|
+
* Aliases: `txttrack`, `tt`
|
|
2691
|
+
*
|
|
2692
|
+
* @defaultValue `0`
|
|
2693
|
+
*
|
|
2694
|
+
* @see https://docs.imgix.com/apis/url/typesetting/txt-track
|
|
2695
|
+
*/
|
|
2696
|
+
txtTrack?: number;
|
|
2697
|
+
/**
|
|
2698
|
+
* Text tracking
|
|
2699
|
+
*
|
|
2700
|
+
* Sets the tracking (letter spacing) for rendered text. Only works on the
|
|
2701
|
+
* multi-line text endpoint.
|
|
2702
|
+
*
|
|
2703
|
+
* Alias for: `txtTrack`
|
|
2704
|
+
*
|
|
2705
|
+
* @defaultValue `0`
|
|
2706
|
+
*
|
|
2707
|
+
* @see https://docs.imgix.com/apis/url/typesetting/txt-track
|
|
2708
|
+
*/
|
|
2709
|
+
txttrack?: number;
|
|
2710
|
+
/**
|
|
2711
|
+
* Text tracking
|
|
2712
|
+
*
|
|
2713
|
+
* Sets the tracking (letter spacing) for rendered text. Only works on the
|
|
2714
|
+
* multi-line text endpoint.
|
|
2715
|
+
*
|
|
2716
|
+
* Alias for: `txtTrack`
|
|
2717
|
+
*
|
|
2718
|
+
* @defaultValue `0`
|
|
2719
|
+
*
|
|
2720
|
+
* @see https://docs.imgix.com/apis/url/typesetting/txt-track
|
|
2721
|
+
*/
|
|
2722
|
+
tt?: number;
|
|
2723
|
+
/**
|
|
2724
|
+
* Text width
|
|
2725
|
+
*
|
|
2726
|
+
* Sets the width of rendered text.
|
|
2727
|
+
*
|
|
2728
|
+
* Aliases: `txtwidth`
|
|
2729
|
+
*
|
|
2730
|
+
* @see https://docs.imgix.com/apis/url/text/txt-width
|
|
2731
|
+
*/
|
|
2732
|
+
txtWidth?: number;
|
|
2733
|
+
/**
|
|
2734
|
+
* Text width
|
|
2735
|
+
*
|
|
2736
|
+
* Sets the width of rendered text.
|
|
2737
|
+
*
|
|
2738
|
+
* Alias for: `txtWidth`
|
|
2739
|
+
*
|
|
2740
|
+
* @see https://docs.imgix.com/apis/url/text/txt-width
|
|
2741
|
+
*/
|
|
2742
|
+
txtwidth?: number;
|
|
2743
|
+
/**
|
|
2744
|
+
* Text string
|
|
2745
|
+
*
|
|
2746
|
+
* Sets the text string to render.
|
|
2747
|
+
*
|
|
2748
|
+
* Aliases: `t`
|
|
2749
|
+
*
|
|
2750
|
+
* @see https://docs.imgix.com/apis/url/text/txt
|
|
2751
|
+
*/
|
|
2752
|
+
txt?: string;
|
|
2753
|
+
/**
|
|
2754
|
+
* Text string
|
|
2755
|
+
*
|
|
2756
|
+
* Sets the text string to render.
|
|
2757
|
+
*
|
|
2758
|
+
* Alias for: `txt`
|
|
2759
|
+
*
|
|
2760
|
+
* @see https://docs.imgix.com/apis/url/text/txt
|
|
2761
|
+
*/
|
|
2762
|
+
t?: string;
|
|
2763
|
+
/**
|
|
2764
|
+
* Unsharp mask
|
|
2765
|
+
*
|
|
2766
|
+
* Sharpens the source image using an unsharp mask.
|
|
2767
|
+
*
|
|
2768
|
+
* @defaultValue `0`
|
|
2769
|
+
*
|
|
2770
|
+
* @see https://docs.imgix.com/apis/url/adjustment/usm
|
|
2771
|
+
*/
|
|
2772
|
+
usm?: number;
|
|
2773
|
+
/**
|
|
2774
|
+
* Unsharp mask radius
|
|
2775
|
+
*
|
|
2776
|
+
* Specifies the radius for an unsharp mask operation.
|
|
2777
|
+
*
|
|
2778
|
+
* @defaultValue `2.5`
|
|
2779
|
+
*
|
|
2780
|
+
* @see https://docs.imgix.com/apis/url/adjustment/usmrad
|
|
2781
|
+
*/
|
|
2782
|
+
usmrad?: number;
|
|
2783
|
+
/**
|
|
2784
|
+
* Vibrance
|
|
2785
|
+
*
|
|
2786
|
+
* Adjusts the vibrance of an image.
|
|
2787
|
+
*
|
|
2788
|
+
* @defaultValue `0`
|
|
2789
|
+
*
|
|
2790
|
+
* @see https://docs.imgix.com/apis/url/adjustment/vib
|
|
2791
|
+
*/
|
|
2792
|
+
vib?: number;
|
|
2793
|
+
/**
|
|
2794
|
+
* Image width
|
|
2795
|
+
*
|
|
2796
|
+
* Adjusts the width of the output image.
|
|
2797
|
+
*
|
|
2798
|
+
* Aliases: `width`
|
|
2799
|
+
*
|
|
2800
|
+
* @see https://docs.imgix.com/apis/url/size/w
|
|
2801
|
+
*/
|
|
2802
|
+
w?: number;
|
|
2803
|
+
/**
|
|
2804
|
+
* Image width
|
|
2805
|
+
*
|
|
2806
|
+
* Adjusts the width of the output image.
|
|
2807
|
+
*
|
|
2808
|
+
* Alias for: `w`
|
|
2809
|
+
*
|
|
2810
|
+
* @see https://docs.imgix.com/apis/url/size/w
|
|
2811
|
+
*/
|
|
2812
|
+
width?: number;
|
|
2813
|
+
/**
|
|
2814
|
+
* Signed URL hash
|
|
2815
|
+
*
|
|
2816
|
+
* Secure a URL to prevent URL parameter changes. Note that this parameter
|
|
2817
|
+
* requires a secret token and should only be generated on a server.
|
|
2818
|
+
*
|
|
2819
|
+
* @see https://docs.imgix.com/setup/securing-images
|
|
2820
|
+
*/
|
|
2821
|
+
s?: string;
|
|
2822
|
+
}
|