com.aspose.html.dom.svg

Class SVGSVGElement

    • Constructor Detail

      • SVGSVGElement

        public SVGSVGElement(com.aspose.html.dom.DOMName name,
                             Document doc)

        Initializes a new instance of the SVGElement class.

        Parameters:
        name - The element name.
        doc - The document.
    • Method Detail

      • getSVGContext

        public com.aspose.html.dom.svg.SVGContext getSVGContext()
        Overrides:
        getSVGContext in class SVGElement
      • getX

        @DOMNameAttribute(name="x")
        public SVGAnimatedLength getX()

        Corresponds to attribute ‘x’ on the given ‘svg’ element.

        Value: Corresponds to attribute ‘x’ on the given ‘svg’ element.
      • getY

        @DOMNameAttribute(name="y")
        public SVGAnimatedLength getY()

        Corresponds to attribute ‘y’ on the given ‘svg’ element.

        Value: Corresponds to attribute ‘y’ on the given ‘svg’ element.
      • getWidth

        @DOMNameAttribute(name="width")
        public SVGAnimatedLength getWidth()

        Corresponds to attribute ‘width’ on the given ‘svg’ element.

        Value: Corresponds to attribute ‘width’ on the given ‘svg’ element.
      • getHeight

        @DOMNameAttribute(name="height")
        public SVGAnimatedLength getHeight()

        Corresponds to attribute ‘height’ on the given ‘svg’ element.

        Value: Corresponds to attribute ‘height’ on the given ‘svg’ element.
      • getUseCurrentView

        @DOMNameAttribute(name="useCurrentView")
        public boolean getUseCurrentView()

        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 ‘viewBox’) or to a "custom" view (i.e., a hyperlink into a particular ‘view’ or other element - see Linking into SVG content: IRI 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.

        Value: The initial view of the current innermost SVG document.
      • getCurrentScale

        @DOMNameAttribute(name="currentScale")
        public float getCurrentScale()

        On an outermost svg element, 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. DOM attributes currentScale and currentTranslate are equivalent to the 2x3 matrix [a b c d e f] = [currentScale 0 0 currentScale currentTranslate.x currentTranslate.y]. If "magnification" is enabled (i.e., zoomAndPan="magnify"), then the effect is as if an extra transformation were placed at the outermost level on the SVG document fragment (i.e., outside the outermost svg element). When accessed on an ‘svg’ element that is not an outermost svg element, it is undefined what behavior this attribute has.

        Value: The current scale.
      • setCurrentScale

        @DOMNameAttribute(name="currentScale")
        public void setCurrentScale(float value)

        On an outermost svg element, 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. DOM attributes currentScale and currentTranslate are equivalent to the 2x3 matrix [a b c d e f] = [currentScale 0 0 currentScale currentTranslate.x currentTranslate.y]. If "magnification" is enabled (i.e., zoomAndPan="magnify"), then the effect is as if an extra transformation were placed at the outermost level on the SVG document fragment (i.e., outside the outermost svg element). When accessed on an ‘svg’ element that is not an outermost svg element, it is undefined what behavior this attribute has.

        Value: The current scale.
      • getCurrentTranslate

        @DOMNameAttribute(name="currentTranslate")
        public SVGPoint getCurrentTranslate()

        On an outermost svg element, the corresponding translation factor that takes into account user "magnification". When accessed on an ‘svg’ element that is not an outermost svg element, it is undefined what behavior this attribute has.

        Value: The current translate.
      • getPixelUnitToMillimeterX

        @DOMNameAttribute(name="pixelUnitToMillimeterX")
        public float getPixelUnitToMillimeterX()

        Size of a pixel units (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. On systems where it is impossible to know the size of a pixel, a suitable default pixel size is provided.

        Value: Size of a pixel units (as defined by CSS2) along the x-axis of the viewport
      • getPixelUnitToMillimeterY

        @DOMNameAttribute(name="pixelUnitToMillimeterY")
        public float getPixelUnitToMillimeterY()

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

        Value: Size of a pixel unit along the y-axis of the viewport.
      • getScreenPixelToMillimeterX

        @DOMNameAttribute(name="screenPixelToMillimeterX")
        public float getScreenPixelToMillimeterX()

        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.

        Value: Size of a screen pixel along the x-axis of the viewport
      • getScreenPixelToMillimeterY

        @DOMNameAttribute(name="screenPixelToMillimeterY")
        public float getScreenPixelToMillimeterY()

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

        Value: Size of a screen pixel along the y-axis of the viewport
      • suspendRedraw

        @DOMNameAttribute(name="suspendRedraw")
        public long suspendRedraw(long maxWaitMilliseconds)

        Takes a time-out value which indicates that redraw shall not occur until: - the corresponding unsuspendRedraw() call has been made, - an unsuspendRedrawAll() call has been made, or - its timer has timed out. In environments that do not support interactivity(e.g., print media), then redraw shall not be suspended.Calls to suspendRedraw() and unsuspendRedraw() should, but need not be, made in balanced pairs. To suspend redraw actions as a collection of SVG DOM changes occur, precede the changes to the SVG DOM with a method call similar to:

        suspendHandleID = suspendRedraw(maxWaitMilliseconds);
        and follow the changes with a method call similar to:
        unsuspendRedraw(suspendHandleID);
        Note that multiple suspendRedraw calls can be used at once and that each such method call is treated independently of the other suspendRedraw method calls.

        Parameters:
        maxWaitMilliseconds - The amount of time in milliseconds to hold off before redrawing the device. Values greater than 60 seconds will be truncated down to 60 seconds.
        Returns:
        A number which acts as a unique identifier for the given suspendRedraw() call. This value must be passed as the parameter to the corresponding unsuspendRedraw() method call.
      • unsuspendRedraw

        @DOMNameAttribute(name="unsuspendRedraw")
        public void unsuspendRedraw(long suspendHandleID)

        Cancels a specified suspendRedraw() by providing a unique suspend handle ID that was returned by a previous suspendRedraw() call.

        Parameters:
        suspendHandleID - A number which acts as a unique identifier for the desired suspendRedraw() call. The number supplied must be a value returned from a previous call to suspendRedraw(). If an invalid handle ID value is provided then the request to unsuspendRedraw() is silently ignored.
      • unsuspendRedrawAll

        @DOMNameAttribute(name="unsuspendRedrawAll")
        public void unsuspendRedrawAll()

        Cancels all currently active suspendRedraw() method calls. This method is most useful at the very end of a set of SVG DOM calls to ensure that all pending suspendRedraw() method calls have been cancelled.

      • forceRedraw

        @DOMNameAttribute(name="forceRedraw")
        public void forceRedraw()

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

      • pauseAnimations

        @DOMNameAttribute(name="pauseAnimations")
        public void 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.

      • unpauseAnimations

        @DOMNameAttribute(name="unpauseAnimations")
        public void 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.

      • animationsPaused

        @DOMNameAttribute(name="animationsPaused")
        public boolean animationsPaused()

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

        Returns:
        Boolean indicating whether this SVG document fragment is in a paused state.
      • getCurrentTime

        @DOMNameAttribute(name="getCurrentTime")
        public float getCurrentTime()

        Returns the current time in seconds relative to the start time for the current SVG document fragment. If getCurrentTime is called before the document timeline has begun (for example, by script running in a ‘script’ element before the document's SVGLoad event is dispatched), then 0 is returned.

        Returns:
        The current time in seconds, or 0 if the document timeline has not yet begun.
      • setCurrentTime

        @DOMNameAttribute(name="setCurrentTime")
        public void setCurrentTime(float seconds)

        Adjusts the clock for this SVG document fragment, establishing a new current time. If setCurrentTime is called before the document timeline has begun (for example, by script running in a ‘script’ element before the document's SVGLoad event is dispatched), then the value of seconds in the last invocation of the method gives the time that the document will seek to once the document timeline has begun.

        Parameters:
        seconds - The new current time in seconds relative to the start time for the current SVG document fragment.
      • getIntersectionList

        @DOMNameAttribute(name="getIntersectionList")
        public NodeList getIntersectionList(SVGRect rect,
                                                                                           SVGElement referenceElement)

        Returns the list of graphics elements whose rendered content intersects the supplied rectangle. Each candidate graphics element is to be considered a match only if the same graphics element can be a target of pointer events as defined in ‘pointer-events’ processing.

        Parameters:
        rect - The test rectangle. The values are in the initial coordinate system for the current ‘svg’ element.
        referenceElement - If not null, then any intersected element that doesn't have the referenceElement as ancestor must not be included in the returned NodeList.
        Returns:
        A list of Elements whose content intersects the supplied rectangle. This NodeList must be implemented identically to the NodeList interface as defined in DOM Level 2 Core ([DOM2], section 1.2) with the exception that the interface is not live.
      • getEnclosureList

        @DOMNameAttribute(name="getEnclosureList")
        public NodeList getEnclosureList(SVGRect rect,
                                                                                     SVGElement referenceElement)

        Returns the list of graphics elements whose rendered content is entirely contained within the supplied rectangle. Each candidate graphics element is to be considered a match only if the same graphics element can be a target of pointer events as defined in ‘pointer-events’ processing.

        Parameters:
        rect - The test rectangle. The values are in the initial coordinate system for the current ‘svg’ element.
        referenceElement - If not null, then any intersected element that doesn't have the referenceElement as ancestor must not be included in the returned NodeList.
        Returns:
        A list of Elements whose content is enclosed by the supplied rectangle. This NodeList must be implemented identically to the NodeList interface as defined in DOM Level 2 Core ([DOM2], section 1.2) with the exception that the interface is not live.
      • checkIntersection

        @DOMNameAttribute(name="checkIntersection")
        public boolean checkIntersection(SVGElement element,
                                                                                      SVGRect rect)

        Returns true if the rendered content of the given element intersects the supplied rectangle. Each candidate graphics element is to be considered a match only if the same graphics element can be a target of pointer events as defined in ‘pointer-events’ processing.

        Parameters:
        element - The element on which to perform the given test.
        rect - The test rectangle. The values are in the initial coordinate system for the current ‘svg’ element.
        Returns:
        True or false, depending on whether the given element intersects the supplied rectangle.
      • checkEnclosure

        @DOMNameAttribute(name="checkEnclosure")
        public boolean checkEnclosure(SVGElement element,
                                                                                SVGRect rect)

        Returns true if the rendered content of the given element is entirely contained within the supplied rectangle. Each candidate graphics element is to be considered a match only if the same graphics element can be a target of pointer events as defined in ‘pointer-events’ processing.

        Parameters:
        element - The element on which to perform the given test.
        rect - The test rectangle. The values are in the initial coordinate system for the current ‘svg’ element.
        Returns:
        True or false, depending on whether the given element is enclosed by the supplied rectangle.
      • deselectAll

        @DOMNameAttribute(name="deselectAll")
        public void deselectAll()

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

      • createSVGNumber

        @DOMNameAttribute(name="createSVGNumber")
        public SVGNumber createSVGNumber()

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

        Returns:
        An SVGNumber object.
      • createSVGLength

        @DOMNameAttribute(name="createSVGLength")
        public SVGLength createSVGLength()

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

        Returns:
        An SVGLength object.
      • createSVGAngle

        @DOMNameAttribute(name="createSVGAngle")
        public SVGAngle createSVGAngle()

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

        Returns:
        An SVGAngle object.
      • createSVGPoint

        @DOMNameAttribute(name="createSVGPoint")
        public SVGPoint createSVGPoint()

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

        Returns:
        An SVGPoint object.
      • createSVGMatrix

        @DOMNameAttribute(name="createSVGMatrix")
        public SVGMatrix createSVGMatrix()

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

        Returns:
        An SVGMatrix object.
      • createSVGRect

        @DOMNameAttribute(name="createSVGRect")
        public SVGRect createSVGRect()

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

        Returns:
        An SVGRect object.
      • createSVGTransform

        @DOMNameAttribute(name="createSVGTransform")
        public SVGTransform createSVGTransform()

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

        Returns:
        An SVGTransform object.
      • createSVGTransformFromMatrix

        @DOMNameAttribute(name="createSVGTransformFromMatrix")
        public SVGTransform createSVGTransformFromMatrix(SVGMatrix matrix)

        Creates an SVGTransform object outside of any document trees. The object is initialized to the given matrix transform (i.e., SVG_TRANSFORM_MATRIX). The values from the parameter matrix are copied, the matrix parameter is not adopted as SVGTransform::matrix.

        Parameters:
        matrix - The transform matrix.
        Returns:
        An SVGTransform object.
      • getElementById

        @DOMNameAttribute(name="getElementById")
        public Element getElementById(String elementId)

        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. If an Element is found, that Element is returned. If no such element exists, returns null. Behavior is not defined if more than one element has this id.

        Parameters:
        elementId - The unique id value for an element.
        Returns:
        The matching element.
      • getViewBox

        public SVGAnimatedRect getViewBox()

        Corresponds to attribute ‘viewBox’ on the given element.

        Value: The ‘viewBox’ of the given element.
        Specified by:
        getViewBox in interface ISVGFitToViewBox
      • getZoomAndPan

        public int getZoomAndPan()

        Corresponds to attribute ‘zoomAndPan’ on the given element. The value must be one of the SVG_ZOOMANDPAN_* constants defined on this interface.

        Specified by:
        getZoomAndPan in interface ISVGZoomAndPan
        Throws:
        DOMException - Code DOMException.NO_MODIFICATION_ALLOWED_ERR. Raised on an attempt to change the value of a read only attribute. Value: The zoom and pan.
      • setZoomAndPan

        public void setZoomAndPan(int value)

        Corresponds to attribute ‘zoomAndPan’ on the given element. The value must be one of the SVG_ZOOMANDPAN_* constants defined on this interface.

        Specified by:
        setZoomAndPan in interface ISVGZoomAndPan
        Throws:
        DOMException - Code DOMException.NO_MODIFICATION_ALLOWED_ERR. Raised on an attempt to change the value of a read only attribute. Value: The zoom and pan.