Image
API reference › HTML SVG › Image
Represents the SVG <image> (image) element for embedding bitmap images.
Provides a concrete <image> element implementation that returns SvgVoid::IMAGE and provides linking,
geometry, presentation, and transform attribute methods.
The <image> element embeds an external image into the SVG.
See also: https://developer.mozilla.org/en-US/docs/Web/SVG/Element/image (BaseVoid for the base implementation.).
Properties
Section titled “Properties”| Property | Type | Description | Defined by |
|---|---|---|---|
$attributes protected | mixed[] | HTML attributes array used by the implementing class. Default: []. | UIAwesome\ |
Methods
Section titled “Methods”Method details
Section titled “Method details”decoding()
Section titled “decoding() ”public function decoding(string|Stringable|UnitEnum|null $value): staticSets the decoding attribute.
Usage example:
$element->decoding('async');$element->decoding(Decoding::ASYNC);$element->decoding(null);Parameters
| Parameter | Type | Description |
|---|---|---|
$value | string|Stringable|UnitEnum| | Decoding hint value. Use ‘async’, ‘sync’, or ‘auto’, or null to remove the attribute. |
Returns
static: New instance with the updated decoding attribute. Decoding for predefined enum values.
fetchpriority()
Section titled “fetchpriority() ”public function fetchpriority(string|UnitEnum|null $value): staticSets the fetchpriority attribute.
Usage example:
$element->fetchpriority('high');$element->fetchpriority(Fetchpriority::HIGH);$element->fetchpriority(null);Parameters
| Parameter | Type | Description |
|---|---|---|
$value | string|UnitEnum| | Fetch priority token, or null to remove the attribute. |
Returns
static: New instance with the updated fetchpriority attribute. Fetchpriority for predefined enum values.
height()
Section titled “height() ”public function height(int|string|Stringable|UnitEnum|null $value): staticSets the height attribute.
Usage example:
$element->height(200);$element->height('50%');$element->height('auto');Parameters
| Parameter | Type | Description |
|---|---|---|
$value | int|Stringable|UnitEnum| | Height value in pixels or CSS units, or null to remove the attribute. |
Returns
static: New instance with the updated height attribute.
href()
Section titled “href() ”public function href(string|Stringable|UnitEnum|null $value): staticSets the href attribute.
Usage example:
$element->href('https://example.com/image.png');$element->href('#image');$element->href(null);Parameters
| Parameter | Type | Description |
|---|---|---|
$value | string|Stringable|UnitEnum| | URL, path, or fragment, or null to remove the attribute. |
Returns
static: New instance with the updated href attribute.
opacity()
Section titled “opacity() ”public function opacity(float|int|string|null $value): staticSets the SVG opacity attribute for the element.
Creates a new instance with the specified opacity value for the rendered element.
Parameters
| Parameter | Type | Description |
|---|---|---|
$value | float| | Opacity value (for example, ‘0.5’ or null to unset). |
Returns
static: New instance with the updated opacity attribute.
Throws
InvalidArgumentException: If the value is outside the allowed range (‘0’-‘1’) and notnull.
preserveAspectRatio()
Section titled “preserveAspectRatio() ”public function preserveAspectRatio(UIAwesome\Html\Svg\Values\PreserveAspectRatio|string|null $value): staticSets the SVG preserveAspectRatio attribute for the element.
Creates a new instance with the specified preserve aspect ratio value for the rendered element.
Parameters
| Parameter | Type | Description |
|---|---|---|
$value | UIAwesome\| | Preserve aspect ratio value (for example, ‘xMidYMid meet’, PreserveAspectRatio enum, or null to unset). |
Returns
static: New instance with the updated preserveAspectRatio attribute.
Throws
InvalidArgumentException: If the provided value is not a validPreserveAspectRatioenum orstring.
transform()
Section titled “transform() ”public function transform(string|null $value): staticSets the SVG transform attribute for the element.
Creates a new instance with the specified transform value for the rendered element.
Parameters
| Parameter | Type | Description |
|---|---|---|
$value | string| | Transform value (for example, ‘rotate(45)’, ‘scale(2)’, or null to unset). |
Returns
static: New instance with the updated transform attribute.
width()
Section titled “width() ”public function width(int|string|Stringable|UnitEnum|null $value): staticSets the width attribute.
Usage example:
$element->width(400);$element->width('50%');$element->width('auto');$element->width(null);Parameters
| Parameter | Type | Description |
|---|---|---|
$value | int|Stringable|UnitEnum| | Width value in pixels or CSS units, or null to remove the attribute. |
Returns
static: New instance with the updated width attribute.
public function x(float|int|string|null $value): staticSets the SVG x attribute for the element.
Creates a new instance with the specified x-coordinate value for the rendered element.
Parameters
| Parameter | Type | Description |
|---|---|---|
$value | float| | X coordinate value (for example, ‘10’, ‘10.3’, ‘50%’, or null to unset). |
Returns
static: New instance with the updated x attribute.
public function y(float|int|string|null $value): staticSets the SVG y attribute for the element.
Creates a new instance with the specified y-coordinate value for the rendered element.
Parameters
| Parameter | Type | Description |
|---|---|---|
$value | float| | Y coordinate value (for example, ‘20’, ‘10.3’, ‘50%’, or null to unset). |
Returns
static: New instance with the updated y attribute.
getTag()
Section titled “getTag() ”protected function getTag(): BackedEnumReturns the tag enumeration for the <image> element.
Returns
BackedEnum: Tag enumeration instance for <image>. SvgVoid for valid SVG void-level tags.