Overlay
You can overlay images or text over other images for watermarking or creating a dynamic banner using custom text.
The above image is created using below URL:
https://ik.imagekit.io/demo/tr:oi-logo-white_SJwqB4Nfe.png/medium_cafe_B1iTdD0C.jpg
Let's first understand what all is possible in overlay and then you can deep dive into different options available based on what you need. To help you understand, we have added many examples in this documentation.
You can control the position of overlay image relative to base image using overlay focus (ofo), overlay X position (ox) or overlay Y position (oy).
You can control the dimension of overlay image using overlay height (oh) and overlay width (ow).
The following options are available for both image and text overlay.
Used to provide granular control over the position of the overlay image relative to the base image.
The top left corner of the input image is considered as (0,0), and the bottom right corner as (w,h), where w is the width and h is the height of the input image. If ox is 100, then the overlay image is placed at 100px from the left edge of the input image. If the ox value exceeds the dimensions of the input image, the values are adjusted and made equal to the corresponding dimension of the input image. Negative values are also supported with a leading N in front of the provided value.
Possible Values include any positive integer. If prefixed with N , then treated as a negative integer.
Used to provide granular control over the position of the overlay image relative to the base image.
The top left corner of the input image is considered as (0,0), and the bottom right corner as (w, h), where w is the width and h is the height of the input image. If oy is 150, then the overlay image is placed at 150px from the top edge of the input image. If the oy value exceeds the dimensions of the input image, the values are adjusted and made equal to the corresponding dimension of the input image. Negative values are also supported with a leading N in front of the provided value.
Possible Values include any positive integer. If prefixed with N , then treated as a negative integer.
Used to specify the height of the overlay image.
Used to specify the width of the overlaid image.
If you want to overlay a solid color block over a base image, use obg parameter.
Possible Values- Valid RGB Hex Code with optional alpha component
For example - 00AAFF (solid color) or 00AAFF55 (with 55% opacity)
Overlay Background Transparency is supported via alpha component in RGB hex code which takes a numeric value between 00 and 99.
If both obg and oa are set in a single transformation and obg has an alpha component, then that value is used to set overlay background transparency. Otherwise, oa value is used .
You can control the relative position of overlay image using ofo parameter. This position is relative to base image.
Possible values include center , top , left , bottom , right , top_left , top_right , bottom_left , and bottom_right .
Default Value- center
Used to overlay an image on top of another image (base image). This helps you generate watermarked images.
Let's say base image URL is - https://ik.imagekit.io/demo/medium_cafe_B1iTdD0C.jpg
Overlay image logo URL is - https://ik.imagekit.io/demo/logo-white_SJwqB4Nfe.png
Now to overlay this logo over the base image we will pass the path of overlay image in oi parameter i.e. logo-white_SJwqB4Nfe.png
ImageKit.io currently supports JPEG/JPG and PNG images for overlay.
The overlay image path should be accessible using your ImageKit.io account.
Final URL - https://ik.imagekit.io/demo/tr:oi-logo-white_SJwqB4Nfe.png/medium_cafe_B1iTdD0C.jpg
overlay image path base image path┌──────────────────────┐┌───────────────────────┐{url-endpoint}/tr:oi-logo-white_SJwqB4Nfe.png/medium_cafe_B1iTdD0C.jpg
In the above example, overlay image logo was stored in home folder i.e. /, so there was no slash in the overlay image path. However it could be possible that you have overlay images stored within a specific folder, in that case there will be slashes (/) in overlay image path. To overcome this you need to replace slash / with @@.
For example, if the overlay image is at https://ik.imagekit.io/demo/path/to/overlay.jpg
Then it can be used as an overlay like below:
https://ik.imagekit.io/demo/tr:[email protected]@[email protected]@overlay.jpg/medium_cafe_B1iTdD0C.jpg
By default, ImageKit.io trims the overlay image before overlaying it on the base image. Trimming removes the similar colored pixels from the edges. By default, overlay image is trimmed.
There might be cases where you do not need such trimming to happen. Then, you can do that from the URL itself using the overlay trim (oit) parameter and specifying it as false.
Possible values include true , false and integer values between 1 and 99 that specify the threshold level for considering a particular pixel as "background".
For example, consider the image below, which has the same white logo to be overlaid but this time inside a black rectangular box.
Overlay image logo with black rectangular box - https://ik.imagekit.io/demo/logo_white_black_bg.png
It is used to specify the aspect ratio of the overlay image or the ratio of width to height of the overlay image.
This parameter must be used along with either the overlay height(oh) or overlay width(ow) parameter. The format for specifying this transformation is oiar-<width>-<height>.
If you specify both overlay height(oh) and overlay width(ow) in the URL along with this parameter, then the overlay image aspect ratio (oiar) is ignored.
It is used to specify the background color in RGB Hex Code (e.g. FF0000) or an RGBA Code (e.g. FFAABB50) that must be used for the overlay image. If you specify an 8 character background, the last two characters must be a number between 00 and 99, which is used to indicate the opacity level of the overlay image background.
00 represents an opacity level of 0.00, 01 represents opacity level 0.01, and so on.
Default Value - Black 00000 Possible Values - Valid RGB Hex Code
This adds a border to the overlay image. It accepts two parameters - the width of the border and the color of the border.
Usage - oib-<border-width>-<hex code>
The width is specified as a number that is equivalent to the border width in pixels. The color code is specified as a 6-character hex code RRGGBB.
It is used to specify the device pixel ratio that is used to calculate the dimensions of the overlay image. Extremely helpful when creating image transformations for devices with high device pixel ratio (DPR > 1), like the iPhone or high-end Android devices.
The oidpr parameter can only be used when either the height or width of the desired output overlay image is specified. If the output image's height or width after considering the specified DPR is less than 1px or greater than 5000px, the value of oidpr is not considered and the overlay height or width used in the URL is used.
Possible Values - 0.1 to 5 .
It is used to specify the quality of the overlay image for lossy formats like JPEG and WebP. A large quality number results in a bigger image file size with high overlay image quality. A small quality number results in a smaller image file size with lower overlay image quality.
Default Value - 80 (can be managed from image settings in dashboard)
Cropping in overlay behave the same way as cropping works in ImageKit.io in general. The only difference is that all cropping and focus related parameters are prefixed with oi.
So essentially:
c-at_least becomes oic-at_least
c-at_max becomes oic-at_max
c-maintain_ratio becomes oic-maintain_ratio
cm-extract becomes oicm-extract
cm-pad_extract becomes oicm-pad_extract
cm-pad_resize becomes oicm-pad_resize
fo-custom becomes oifo-custom
It works same as c-at_least but used in context of overlay images only.
It works same as c-at_max but used in context of overlay images only.
It works same as c-force but used in context of overlay images only.
It works same as c-maintain_ratio but used in context of overlay images only.
It works same as cm-extract but used in context of overlay images only.
It works same as cm-pad_extract but used in context of overlay images only.
It works same as cm-pad_resize but used in context of overlay images only.
It works same as fo but used in context of overlay images only.
It works same as fo-auto but used in context of overlay images only.
It works same as fo-custom but used in context of overlay images only.
It works same as fo-face but used in context of overlay images only.
It works same as x but used in context of overlay images only.
It works same as y but used in context of overlay images only.
It works same as xc but used in context of overlay images only.
It works same as yc but used in context of overlay images only.
By default, ImageKit.io trims the overlay image before overlaying it on the base image. Trimming removes the similar colored pixels from the edges. There might be cases where you do not need such trimming to happen. Then, you can do that from the URL using oit-false.
This removes the transparency of the overlaid image.
Default Value - true
Learn more from example here.
To overlay text on an image. Supported characters include all alphabets, numbers, spaces, _, -, %, !, @, and &.
URL - https://ik.imagekit.io/demo/tr:ot-overlay%20made%20easy,ots-45/medium_cafe_B1iTdD0C.jpg
Font size is set to 45 using ots parameter.
It is similar to overlay text (ot) but it allows you to overlay special unicode characters (e.g. ©, ®, ™ etc.) that you cannot otherwise pass in a URL as plain string. It accepts base64 string.
The base64 string should be made URL safe to ensure that all padding characters(=) are included correctly. A function like
encodeUri()can be used for this.Input above the length of 144 characters will be truncated.
Example URL - https://ik.imagekit.io/demo/tr:ote-b3ZlcmxheSBtYWRlIGVhc3k%3D,ots-45/medium_cafe_B1iTdD0C.jpg
Here b3ZlcmxheSBtYWRlIGVhc3k%3D is the base64 string for "overlay made easy"
To specify the maximum width (in pixels) of the overlaid text on the image. The text is wrapped so that any words in a line that go beyond the given width are sent to the next line. Height of the text box is calculated automatically based on the total number of lines.
Possible values include any integer.
Example URL - https://ik.imagekit.io/demo/tr:ot-overlays%20made%20easy,ots-45,otc-00FFFF,otw-200/medium_cafe_B1iTdD0C.jpg
Overlay text color is controlled using otc parameter.
If you want to give the text block a solid background color (and transparency), use this parameter.
Possible Values - Valid RGB Hex Code with optional alpha component
Example values - 00AAFF (solid color) or 00AAFF55 (with 55% opacity)
This is supported via alpha component in RGB hex code which takes a numeric value between 00 and 99.
To specify the padding around the overlaid text on the image.
Possible values include any positive integer or a set of positive integers separated by underscores.
The set of integers follow CSS shorthand order for determining the padding along each side of the overlay. Learn from the examples:
Top padding is 25
Right padding is 50
Bottom padding is 75
Left padding is 100
Top padding is 25
Right and left paddings are 75
Bottom padding is 60
Top and bottom paddings are 25
Right and left paddings are 75
To specify the alignment of the overlaid text on the image when text is wrapped with overlay text width (otw).
Possible Values include left, right and center (default).
To specify the color and transparency of the overlaid text on the image. Possible Values: Valid RGB Hex Code with optional alpha component
For example - 00AAFF (solid color) or 00AAFF55 (with 55% opacity)
Overlay Text Transparency is supported via alpha component in RGB hex code which takes a numeric value between 00 and 99.
If both otc and oa are set in a single transformation and otc has an alpha component, then this value is used to set overlay text transparency. Otherwise, oa value is used.
To specify the font of the overlaid text on the image. You can choose any font from this list or use a custom font.
You can use a custom font in text overlay. Upload the font file in your media library and pass the path in otf parameter.
Note:
Here the font-file is available at path /Lacquer-Regular_nGqtVsBJT.ttf in media library. You will need to pass the whole path including extension.
To specify the size of the overlaid text on the image. Possible Values include any integer.
To specify the typography of the font used for the overlaid image.
Possible Values include bold b and italics i.
To add rounded corners to an overlay background, or to print a circular overlay, use this parameter.
Possible Values include any positive integer.
Note: Radius cannot exceed half the length of the shorter side of the overlay element.
To specify the transparency level of the overlaid image.
Possible Values include integers from 1 to 9 .
Note: Overlay Transparency is currently supported for overlay texts. It applies to overlay backgrounds only if alpha component is not set in obg parameter.
