Module org.w3c.dom.svg
Package org.w3c.dom.svg

Interface SVGLength

All Known Implementing Classes:
AbstractSVGAnimatedLength.AnimSVGLength, AbstractSVGAnimatedLength.BaseSVGLength, AbstractSVGLength, AbstractSVGLengthList.SVGLengthItem, SVGOMLength
public interface SVGLength
Represents a value that can be a <length>, <percentage> or <number>.

  • Field Details

  • Method Details

    • getCSSUnitType

      default short getCSSUnitType()
      Get the unit type according to CSSUnit.

      Optional attribute.

      Returns:
      the CSS unit type.

    • getUnitType

      default short getUnitType()
      The type of the value as specified by one of the SVG_LENGTHTYPE_* constants defined on this interface.
      Returns:
      the SVG unit type.

    • getValue

      float getValue()
      Gets the SVGLength's value in user units.
      Returns:
      the value in user units.

    • setValue

      void setValue(float value) throws DOMException
      Sets the SVGLength's value in user units.
      Parameters:
      value - the value in user units.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR if the object is read-only.

    • getValueInSpecifiedUnits

      float getValueInSpecifiedUnits()
      Gets the numeric factor of the SVGLength's value.
      Returns:
      the numeric value in the current unit.

    • setValueInSpecifiedUnits

      void setValueInSpecifiedUnits(float valueInSpecifiedUnits) throws DOMException
      Sets the numeric factor of the SVGLength's value.
      Parameters:
      valueInSpecifiedUnits - the value in the current unit.
      Throws:
      DOMException - NO_MODIFICATION_ALLOWED_ERR if the object is read-only.

    • getValueAsString

      String getValueAsString()
      Gets the SVGLength's value as a string.
      Returns:
      the value as a string.

    • setValueAsString

      void setValueAsString(String valueAsString) throws DOMException
      Sets the SVGLength's value as a string.
      Parameters:
      valueAsString - the length value as a string.
      Throws:
      DOMException - SYNTAX_ERR if the value is not a valid length. NO_MODIFICATION_ALLOWED_ERR if the object is read-only.

    • newValueSpecifiedCSSUnits

      default void newValueSpecifiedCSSUnits(short cssUnitType, float valueInSpecifiedUnits) throws DOMException
      Sets the SVGLength's value in a typed manner.
      Parameters:
      cssUnitType - the unit type according to CSSUnit.
      valueInSpecifiedUnits - the value in the given unit.
      Throws:
      DOMException - NOT_SUPPORTED_ERR if the unit is not supported or invalid. NO_MODIFICATION_ALLOWED_ERR if the object is read-only.

    • newValueSpecifiedUnits

      void newValueSpecifiedUnits(short unitType, float valueInSpecifiedUnits) throws DOMException
      Sets the SVGLength's value in a typed manner.
      Parameters:
      unitType - the unit type according to the SVGLength constants.
      valueInSpecifiedUnits - the value in the given unit.
      Throws:
      DOMException - NOT_SUPPORTED_ERR if the unit is not supported or invalid. NO_MODIFICATION_ALLOWED_ERR if the object is read-only.

    • convertToSpecifiedUnits

      void convertToSpecifiedUnits(short unitType) throws DOMException
      Converts this SVGLength's value to a specific unit.
      Parameters:
      unitType - the unit type according to the SVGLength constants.
      Throws:
      DOMException - NOT_SUPPORTED_ERR if the unit is not supported or invalid. NO_MODIFICATION_ALLOWED_ERR if the object is read-only.