SVGFEImageElement: preserveAspectRatio property

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

The preserveAspectRatio read-only property of the SVGFEImageElement interface reflects the preserveAspectRatio attribute of the given <feImage> element.

Value

An SVGAnimatedPreserveAspectRatio object.

Example

Accessing the preserveAspectRatio property

html
<svg xmlns="http://www.w3.org/2000/svg" width="400" height="200">
  <defs>
    <filter id="image-filter">
      <!-- feImage element with preserveAspectRatio attribute -->
      <feImage
        href="https://via.placeholder.com/150"
        x="0"
        y="0"
        width="150"
        height="150"
        preserveAspectRatio="xMidYMid meet" />
    </filter>
  </defs>

  <!-- Rectangle with the filter applied -->
  <rect
    x="50"
    y="50"
    width="200"
    height="100"
    style="fill:blue;"
    filter="url(#image-filter)" />
</svg>
js
// Select the feImage element
const feImageElement = document.querySelector("feImage");

// Access the preserveAspectRatio property
console.dir(feImageElement.preserveAspectRatio); // Output: SVGAnimatedPreserveAspectRatio object

Specifications

Specification
Filter Effects Module Level 1
# dom-svgfeimageelement-preserveaspectratio

Browser compatibility

BCD tables only load in the browser

See also