SVGFEDisplacementMapElement: scale 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 scale read-only property of the SVGFEDisplacementMapElement interface reflects the scale attribute of the given <feDisplacementMap> element.

Value

An SVGAnimatedNumber object.

Examples

Accessing the scale attribute

In this example, the <feDisplacementMap> element defined in the <filter> includes a scale attribute.

html
<svg viewBox="0 0 200 200" xmlns="http://www.w3.org/2000/svg">
  <defs>
    <filter id="filter1">
      <!-- Displacement Map -->
      <feDisplacementMap in="SourceGraphic" scale="20">
        <feFuncR type="table" tableValues="0 1" />
      </feDisplacementMap>
    </filter>
  </defs>
  <rect
    x="20"
    y="20"
    width="100"
    height="100"
    style="fill:red;"
    filter="url(#filter1)" />
</svg>

We can access the scale attribute and get its value:

js
const displacementMap = document.querySelector("feDisplacementMap");

console.log(displacementMap.scale.baseVal); // Output: 20

Specifications

Specification
Filter Effects Module Level 1
# dom-svgfedisplacementmapelement-scale

Browser compatibility

BCD tables only load in the browser

See also