checkEnclosure method

Determines if the rendered content of the specified element is entirely contained within the specified rectangle.

Scalable Vector Graphics: Document Structure, Section 5.11.2

Syntax

var retval = SVGSVGElement.checkEnclosure(element, rect);

Parameters

element [in]

Type: ISVGElement

The element to test.

rect [in]

Type: ISVGRect

The rectangle that might contain the specified element element. The rectangle's coordinates are in the initial coordinate system of the current object.

Return value

Type: Boolean

true if the specified rectangle completely contains the rendered content of the specified element; otherwise, false.

Standards information

Scalable Vector Graphics: Document Structure, Section 5.11.2

Remarks

You can test a graphics element only when it can be a target of pointer events, as the graphic element's pointer-event property specifies. When a graphics element cannot be tested, the checkEnclosure method returns false.