You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* {@link https://imagekit.io/docs/effects-and-enhancements#blurred-background|Effects and Enhancements - Blurred Background}
45
45
*
46
-
* - Expand the image boundaries using generative fill: `genfill`. Optionally, control the background scene by passing a text prompt:
46
+
* - Expand the image boundaries using generative fill: `genfill`. Not supported inside overlay. Optionally, control the background scene by passing a text prompt:
47
47
* `genfill[:-prompt-${text}]` or `genfill[:-prompte-${urlencoded_base64_encoded_text}]`.
48
48
*
49
49
* {@link https://imagekit.io/docs/ai-transformations#generative-fill-bg-genfill|AI Transformations - Generative Fill Background}
* Generates a variation of an image using AI. This produces a new image with slight variations from the original,
240
-
* such as changes in color, texture, and other visual elements, while preserving the structure and essence of the original image.
240
+
* such as changes in color, texture, and other visual elements, while preserving the structure and essence of the original image. Not supported inside overlay.
* Specifies the maximum width (in pixels) of the overlaid text. The text wraps automatically, and arithmetic expressions (e.g., `bw_mul_0.2` or `bh_div_2`) are supported. Useful when used in conjunction with the `backgroundColor`.
597
+
*/
598
+
width?: number|string;
599
+
600
+
/**
601
+
* Specifies the font size of the overlaid text. Accepts a numeric value, a percentage, or an arithmetic expression.
602
+
*/
603
+
fontSize?: number|string;
604
+
605
+
/**
606
+
* Specifies the font family of the overlaid text. Choose from the [supported fonts list](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) or use a [custom font](https://imagekit.io/docs/add-overlays-on-images#change-font-family-in-text-overlay).
607
+
*/
608
+
fontFamily?: string;
609
+
610
+
/**
611
+
* Specifies the font color of the overlaid text. Accepts an RGB hex code (e.g., `FF0000`), an RGBA code (e.g., `FFAABB50`), or a color name.
612
+
*/
613
+
fontColor?: string;
614
+
615
+
/**
616
+
* Specifies the inner alignment of the text when width is more than the text length.
617
+
* Supported values: `left`, `right`, and `center` (default).
618
+
*/
619
+
innerAlignment?: "left"|"right"|"center";
620
+
621
+
/**
622
+
* Specifies the padding around the overlaid text.
623
+
* Can be provided as a single positive integer or multiple values separated by underscores (following CSS shorthand order).
624
+
* Arithmetic expressions are also accepted.
625
+
*/
626
+
padding?: number|string;
627
+
628
+
/**
629
+
* Specifies the transparency level of the text overlay. Accepts integers from `1` to `9`.
630
+
*/
631
+
alpha?: number;
632
+
633
+
/**
634
+
* Specifies the typography style of the text.
635
+
* Supported values: `b` for bold, `i` for italics, and `b_i` for bold with italics.
636
+
*/
637
+
typography?: "b"|"i"|"b_i";
638
+
639
+
/**
640
+
* Specifies the background color of the text overlay.
641
+
* Accepts an RGB hex code, an RGBA code, or a color name.
642
+
*/
643
+
background?: string;
644
+
645
+
/**
646
+
* Specifies the corner radius of the text overlay.
647
+
* Set to `max` to achieve a circular or oval shape.
648
+
*/
649
+
radius?: number|"max";
650
+
651
+
/**
652
+
* Specifies the rotation angle of the text overlay.
653
+
* Accepts a numeric value for clockwise rotation or a string prefixed with "N" for counter-clockwise rotation.
654
+
*/
655
+
rotation?: number|string;
656
+
657
+
/**
658
+
* Flip/mirror the text horizontally, vertically, or in both directions.
659
+
* Acceptable values: `h` (horizontal), `v` (vertical), `h_v` (horizontal and vertical), or `v_h`.
660
+
*/
661
+
flip?: "h"|"v"|"h_v"|"v_h";
662
+
663
+
/**
664
+
* Specifies the line height for multi-line text overlays. It will come into effect only if the text wraps over multiple lines.
665
+
* Accepts either an integer value or an arithmetic expression.
666
+
*/
667
+
lineHeight?: number|string;
668
+
}
669
+
670
+
exporttypeSubtitleOverlayTransformation={
671
+
/**
672
+
* Specifies the subtitle background color using a standard color name, an RGB color code (e.g., `FF0000`), or an RGBA color code (e.g., `FFAABB50`).
673
+
*/
674
+
background?: string;
675
+
/**
676
+
* Sets the font size of subtitle text.
677
+
*/
678
+
fontSize?: number|string;
679
+
/**
680
+
* Sets the font family of subtitle text.
681
+
* Refer to the [supported fonts documented](https://imagekit.io/docs/add-overlays-on-images#supported-text-font-list) in the ImageKit transformations guide.
682
+
*/
683
+
fontFamily?: string;
684
+
/**
685
+
* Sets the font color of the subtitle text using a standard color name, an RGB color code (e.g., `FF0000`), or an RGBA color code (e.g., `FFAABB50`).
686
+
*/
687
+
color?: string;
688
+
/**
689
+
* Sets the typography style of the subtitle text.
690
+
* Supported values: `b` for bold, `i` for italics, and `b_i` for bold with italics.
691
+
*/
692
+
typography?: "b"|"i"|"b_i";
693
+
/**
694
+
* Sets the font outline of the subtitle text.
695
+
* Requires the outline width (an integer) and the outline color (as an RGB color code, RGBA color code, or standard web color name) separated by an underscore.
696
+
* Examples: `2_blue`, `2_A1CCDD`, or `2_A1CCDD50`.
697
+
*/
698
+
fontOutline?: string;
699
+
/**
700
+
* Sets the font shadow for the subtitle text.
701
+
* Requires the shadow color (as an RGB color code, RGBA color code, or standard web color name) and the shadow indent (an integer) separated by an underscore.
702
+
* Examples: `blue_2`, `A1CCDD_3`, or `A1CCDD50_3`.
0 commit comments