SVGFEDisplacementMapElement: scale property

{{APIRef("SVG")}}

The scale read-only property of the {{domxref("SVGFEDisplacementMapElement")}} interface reflects the {{SVGAttr("scale")}} attribute of the given {{SVGElement("feDisplacementMap")}} element.

Value

An {{domxref("SVGAnimatedNumber")}} object.

Examples

Accessing the scale attribute

In this example, the {{SVGElement("feDisplacementMap")}} element defined in the {{SVGElement("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

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• {{domxref("SVGAnimatedNumber")}}