Filter
API reference › HTML SVG › Filter
Represents the SVG <filter> (filter) element for defining filter effects.
Provides a concrete <filter> element implementation that returns SvgBlock::FILTER and provides filter and
geometry attribute methods.
The <filter> element defines a filter that can be applied to other elements.
Usage example:
use UIAwesome\Html\Svg\Filter;
echo Filter::tag() ->id('shadow') ->content('<feDropShadow dx="0" dy="2" stdDeviation="2" flood-opacity="0.25" />') ->render();See also: https://developer.mozilla.org/en-US/docs/Web/SVG/Element/filter (BaseBlock for the base block-level implementation.).
Properties
Section titled “Properties”| Property | Type | Description | Defined by |
|---|---|---|---|
$attributes protected | mixed[] | HTML attributes array used by the implementing class. Default: []. | UIAwesome\ |
$content protected | string | Content string assigned to the element. Default: ''. | UIAwesome\ |
Methods
Section titled “Methods”Method details
Section titled “Method details”filterUnits()
Section titled “filterUnits() ”public function filterUnits(UIAwesome\Html\Svg\Values\CoordinateUnits|string|null $value): staticSets the filterUnits attribute for the <filter> element.
Creates a new instance with the specified filter units value for the rendered <filter> element.
Parameters
| Parameter | Type | Description |
|---|---|---|
$value | UIAwesome\| | Filter units value (for example, ‘objectBoundingBox’ or ‘userSpaceOnUse’). |
Returns
static: New instance with the updated filterUnits property.
Throws
InvalidArgumentException: if the provided value is not a validCoordinateUnitsenum or string.
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.
primitiveUnits()
Section titled “primitiveUnits() ”public function primitiveUnits(UIAwesome\Html\Svg\Values\CoordinateUnits|string|null $value): staticSets the primitiveUnits attribute for the <filter> element.
Creates a new instance with the specified primitive units value for the rendered <filter> element.
Parameters
| Parameter | Type | Description |
|---|---|---|
$value | UIAwesome\| | Primitive units value (for example, ‘objectBoundingBox’ or ‘userSpaceOnUse’). |
Returns
static: New instance with the updated primitiveUnits property.
Throws
InvalidArgumentException: if the provided value is not a validCoordinateUnitsenum or string.
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 <filter> element.
Returns
BackedEnum: Tag enumeration instance for <filter>. SvgBlock for valid SVG block-level tags.