W3cubDocs

/Web APIs

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.

<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"
    fill="red"
    filter="url(#filter1)" />
</svg>

We can access the scale attribute and get its value:

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

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

Specifications

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

Browser compatibility

	Desktop					Mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on IOS	Samsung Internet	WebView Android	WebView on iOS
`scale`	5	12	3	≤12.1	6	18	4	≤12.1	6	1.0	4.4	6