Table of Contents

Interface ISvgSvgElement

Namespace
SharpVectors.Dom.Svg
Assembly
SharpVectors.Core.dll

A key interface definition is the ISvgSvgElement interface, which is the interface that corresponds to the 'svg' element.

public interface ISvgSvgElement : ISvgElement, IElement, IXmlElement, INode, IXmlNode, ISvgTests, ISvgLangSpace, ISvgExternalResourcesRequired, ISvgStylable, ISvgLocatable, ISvgFitToViewBox, ISvgZoomAndPan, IEventTarget, ISvgElementVisitorTarget
Inherited Members

Remarks

This interface contains various miscellaneous commonly-used utility methods, such as matrix operations and the ability to control the time of redraw on visual rendering devices. ISvgSvgElement extends ViewCSS and DocumentCSS to provide access to the computed values of properties and the override style sheet as described in DOM2.

Properties

ContentScriptType

Corresponds to attribute contentScriptType on the given 'svg' element.

ContentStyleType

Corresponds to attribute contentStyleType on the given 'svg' element.

CurrentScale

This attribute indicates the current scale factor relative to the initial view to take into account user magnification and panning operations, as described under Magnification and panning.

CurrentTime

The current time in seconds relative to the start time for the current SVG document fragment.

CurrentTranslate

The corresponding translation factor that takes into account user "magnification".

CurrentView

The definition of the initial view (i.e., before magnification and panning) of the current innermost SVG document fragment.

Height

Corresponds to attribute height on the given 'svg' element.

PixelUnitToMillimeterX

Size of a pixel unit (as defined by CSS2) along the x-axis of the viewport, which represents a unit somewhere in the range of 70dpi to 120dpi, and, on systems that support this, might actually match the characteristics of the target medium.

PixelUnitToMillimeterY

Corresponding size of a pixel unit along the y-axis of the viewport.

ScreenPixelToMillimeterX

User interface (UI) events in DOM Level 2 indicate the screen positions at which the given UI event occurred. When the user agent actually knows the physical size of a "screen unit", this attribute will express that information; otherwise, user agents will provide a suitable default value such as .28mm.

ScreenPixelToMillimeterY

Corresponding size of a screen pixel along the y-axis of the viewport.

UseCurrentView

The initial view (i.e., before magnification and panning) of the current innermost SVG document fragment can be either the "standard" view (i.e., based on attributes on the 'svg' element such as fitBoxToViewport) or to a "custom" view (i.e., a hyperlink into a particular 'view' or other element - see Linking into SVG content: URI fragments and SVG views). If the initial view is the "standard" view, then this attribute is false. If the initial view is a "custom" view, then this attribute is true.

Viewport

The position and size of the viewport (implicit or explicit) that corresponds to this 'svg' element.

Width

Corresponds to attribute width on the given 'svg' element.

X

Corresponds to attribute x on the given 'svg' element.

Y

Corresponds to attribute y on the given 'svg' element.

Methods

AnimationsPaused()

Returns true if this SVG document fragment is in a paused state.

CheckEnclosure(ISvgElement, ISvgRect)

Returns true if the rendered content of the given element is entirely contained within the supplied rectangle, honoring the 'pointer-events' property value on each candidate graphics element.

CheckIntersection(ISvgElement, ISvgRect)

Returns true if the rendered content of the given element intersects the supplied rectangle, honoring the 'pointer-events' property value on each candidate graphics element.

CreateSvgAngle()

Creates an SVGAngle object outside of any document trees. The object is initialized to the value 0 degrees (unitless).

CreateSvgLength()

Creates an SVGLength object outside of any document trees. The object is initialized to the value of 0 user units.

CreateSvgMatrix()

Creates an SVGMatrix object outside of any document trees. The object is initialized to the identity matrix.

CreateSvgNumber()

Creates an SVGNumber object outside of any document trees. The object is initialized to a value of zero.

CreateSvgPoint()

Creates an SVGPoint object outside of any document trees. The object is initialized to the point (0,0) in the user coordinate system.

CreateSvgRect()

Creates an SVGRect object outside of any document trees. The object is initialized such that all values are set to 0 user units.

CreateSvgTransform()

Creates an SVGTransform object outside of any document trees. The object is initialized to an identity matrix transform (SVG_TRANSFORM_MATRIX).

CreateSvgTransformFromMatrix(ISvgMatrix)

Creates an SVGTransform object outside of any document trees. The object is initialized to the given matrix transform (i.e., SVG_TRANSFORM_MATRIX).

DeselectAll()

Unselects any selected objects, including any selections of text strings and type-in bars.

ForceRedraw()

In rendering environments supporting interactivity, forces the user agent to immediately redraw all regions of the viewport that require updating.

GetElementById(string)

Searches this SVG document fragment (i.e., the search is restricted to a subset of the document tree) for an Element whose id is given by elementId.

GetEnclosureList(ISvgRect, ISvgElement)

Returns the list of graphics elements whose rendered content is entirely contained within the supplied rectangle, honoring the 'pointer-events' property value on each candidate graphics element.

GetIntersectionList(ISvgRect, ISvgElement)

Returns the list of graphics elements whose rendered content intersects the supplied rectangle, honoring the 'pointer-events' property value on each candidate graphics element.

PauseAnimations()

Suspends (i.e., pauses) all currently running animations that are defined within the SVG document fragment corresponding to this 'svg' element, causing the animation clock corresponding to this document fragment to stand still until it is unpaused.

SuspendRedraw(int)

Takes a time-out value which indicates that redraw shall not occur until certain conditions are met.

UnpauseAnimations()

Unsuspends (i.e., unpauses) currently running animations that are defined within the SVG document fragment, causing the animation clock to continue from the time at which it was suspended.

UnsuspendRedraw(int)

Cancels a specified suspendRedraw() by providing a unique suspend_handle_id.

UnsuspendRedrawAll()

Cancels all currently active suspendRedraw() method calls. been cancelled.