> For the complete documentation index, see [llms.txt](https://boxlang.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://boxlang.ortusbooks.com/boxlang-framework/modularity/image-manipulation/reference/components/image.md). # Image The `` component provides tag-based image manipulation in BoxLang. ## Syntax ```boxlang ``` ## Attributes | Name | Type | Required | Default | Description | | ------------- | ------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------- | | action | string | Yes | | The action to perform. One of: `border`, `captcha`, `convert`, `info`, `read`, `resize`, `rotate`, `write`, `writeToBrowser`. | | angle | numeric | No | | The angle for rotation in degrees (used with `rotate` action). | | color | string | No | | The color for border. Accepts color names ("red", "blue") or hex codes ("#FF0000"). | | destination | string | No | | The file path to write the image to (used with `write` action). | | difficulty | string | No | | Difficulty level for captcha generation: "low", "medium", "high". | | fontSize | numeric | No | | Font size for text/captcha in points. | | fonts | string | No | | Comma-separated list of font names for captcha text. | | format | string | No | | Image format for writing/converting: "png", "jpg", "gif", etc. | | height | numeric | No | | Height in pixels for resizing or creating images. | | interpolation | string | No | bilinear | Interpolation method for resizing: "bilinear", "nearest", "bicubic". | | isBase64 | boolean | No | false | If true, treats the source as a base64-encoded string. | | name | string | No | | The variable name to assign the image to in the execution context. | | overwrite | boolean | No | false | Whether to overwrite the destination file if it exists. | | quality | numeric | No | | Image quality for JPEG compression (0.0 to 1.0). | | source | any | No | | The source of the image: file path, URL, BoxImage object, or base64 string. | | structName | string | No | | The name of the struct to assign image info to (used with `info` action). | | text | string | No | | Text string for captcha generation. | | thickness | numeric | No | 1 | Border thickness in pixels. | | width | numeric | No | | Width in pixels for resizing or creating images. | | writeType | string | No | url | How to write to browser: "url" (cached, returns URL) or "base64" (inline Base64 data URI). | ## Description The `Image` component provides a flexible, tag-based interface for image processing in BoxLang. It supports reading, writing, resizing, rotating, adding borders, generating captchas, and extracting image metadata. ## Actions ### read Loads an image from a file, URL, or base64 string and assigns it to a variable. ```boxlang ``` **Required Attributes:** `source`, `name` ### resize Resizes an image to the specified dimensions. ```boxlang ``` **Required Attributes:** `source`, `width`, `height` **Optional Attributes:** `interpolation` ### rotate Rotates an image by the specified angle (in degrees). ```boxlang ``` **Required Attributes:** `source`, `angle` **Optional Attributes:** `destination` ### border Adds a solid border around the image. ```boxlang ``` **Required Attributes:** `source`, `color`, `thickness` ### write Writes the image to a file on disk. ```boxlang ``` **Required Attributes:** `source`, `destination` **Optional Attributes:** `overwrite` ### info Extracts metadata and information about the image (dimensions, color model, EXIF data, etc.). ```boxlang Width: #imageInfo.width#, Height: #imageInfo.height# ``` **Required Attributes:** `source`, `structName` ### convert Converts the image to a different format. The format is auto-detected from the destination file extension. ```boxlang ``` **Required Attributes:** `source`, `destination` **Optional Attributes:** `format` (auto-detected from extension if omitted) ### captcha Generates a CAPTCHA image with the specified text. When neither `name` nor `destination` is specified, the image is automatically streamed to the browser. ```boxlang ``` **Required Attributes:** `text` **Optional Attributes:** `name`, `destination`, `width`, `height`, `fontSize`, `difficulty` ("low"/"medium"/"high"), `fonts`, `overwrite` ### writeToBrowser Streams the image directly to the browser response. Returns an `` tag with the image URL or inline data. ```boxlang ``` **Required Attributes:** `source` **Optional Attributes:** `format` (output format: "png", "jpg", "webp", "gif"), `quality` (0.0–1.0 for lossy formats), `writeType` ("url" or "base64"), plus any HTML img attributes (alt, class, style, etc.) ## Complete Example ```boxlang

Dimensions: #imgInfo.width# x #imgInfo.height#

Color Model: #imgInfo.colormodel.colormodel_type#

 ``` ## Related Functions * ImageRead * ImageWrite * ImageResize * ImageRotate * ImageInfo ## Notes * The `source` attribute can be a file path, URL, BoxImage object, or base64 string (with `isBase64=true`). * The `name` attribute assigns the resulting image to a variable in the execution context for further use. * The component does not allow a body; all configuration is via attributes. * For complex workflows with multiple operations, consider using the fluent BoxImage API instead of components. * File handles are properly managed - no file locking issues on Windows after reading/writing. * Parent directories are automatically created when writing files. * The `writeToBrowser` action with `writeType="url"` caches the image in memory and returns a URL for retrieval. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://boxlang.ortusbooks.com/boxlang-framework/modularity/image-manipulation/reference/components/image.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.