SVG (androidsvg 1.3 API)

java.lang.Object
- com.caverock.androidsvg.SVG

```
public class SVG
extends Object
```
AndroidSVG is a library for reading, parsing and rendering SVG documents on Android devices.
All interaction with AndroidSVG is via this class.
Typically, you will call one of the SVG loading and parsing classes then call the renderer, passing it a canvas to draw upon.
Usage summary
- Use one of the static getFromX() methods to read and parse the SVG file. They will return an instance of this class.
- Call one of the renderToX() methods to render the document.
Usage example
```
 
 SVG.registerExternalFileResolver(myResolver);

 SVG  svg = SVG.getFromAsset(getContext().getAssets(), svgPath);

 Bitmap  newBM = Bitmap.createBitmap(width, height, Bitmap.Config.ARGB_8888);
 Canvas  bmcanvas = new Canvas(newBM);
 bmcanvas.drawRGB(255, 255, 255);  // Clear background to white

 svg.renderToCanvas(bmcanvas);
 
 
```
For more detailed information on how to use this library, see the documentation at http://code.google.com/p/androidsvg/

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`deregisterExternalFileResolver()` De-register the current `SVGExternalFileResolver` instance.
`float`	`getDocumentAspectRatio()` Returns the aspect ratio of the document as a width/height fraction.
`String`	`getDocumentDescription()` Returns the contents of the `<desc>` element in the SVG document.
`float`	`getDocumentHeight()` Returns the height of the document as specified in the SVG file.
`PreserveAspectRatio`	`getDocumentPreserveAspectRatio()` Return the "preserveAspectRatio" attribute of the root `<svg>` element in the form of an `PreserveAspectRatio` object.
`String`	`getDocumentSVGVersion()` Returns the SVG version number as provided in the root `<svg>` tag of the document.
`String`	`getDocumentTitle()` Returns the contents of the `<title>` element in the SVG document.
`RectF`	`getDocumentViewBox()` Returns the viewBox attribute of the current SVG document.
`float`	`getDocumentWidth()` Returns the width of the document as specified in the SVG file.
`static SVG`	`getFromAsset(AssetManager assetManager, String filename)` Read and parse an SVG from the assets folder.
`static SVG`	`getFromInputStream(InputStream is)` Read and parse an SVG from the given `InputStream`.
`static SVG`	`getFromResource(Context context, int resourceId)` Read and parse an SVG from the given resource location.
`static SVG`	`getFromResource(Resources resources, int resourceId)` Read and parse an SVG from the given resource location.
`static SVG`	`getFromString(String svg)` Read and parse an SVG from the given `String`.
`float`	`getRenderDPI()` Get the current render DPI setting.
`static String`	`getVersion()` Returns the version number of this library.
`Set<String>`	`getViewList()` Returns a list of ids for all `<view>` elements in this SVG document.
`static boolean`	`isInternalEntitiesEnabled()`
`static void`	`registerExternalFileResolver(SVGExternalFileResolver fileResolver)` Register an `SVGExternalFileResolver` instance that the renderer should use when resolving external references such as images, fonts, and CSS stylesheets.
`void`	`renderToCanvas(Canvas canvas)` Renders this SVG document to a Canvas object.
`void`	`renderToCanvas(Canvas canvas, RectF viewPort)` Renders this SVG document to a Canvas object.
`void`	`renderToCanvas(Canvas canvas, RenderOptions renderOptions)` Renders this SVG document to a Canvas object.
`Picture`	`renderToPicture()` Renders this SVG document to a Picture object.
`Picture`	`renderToPicture(int widthInPixels, int heightInPixels)` Renders this SVG document to a `Picture`.
`Picture`	`renderToPicture(int widthInPixels, int heightInPixels, RenderOptions renderOptions)` Renders this SVG document to a `Picture`.
`Picture`	`renderToPicture(RenderOptions renderOptions)` Renders this SVG document to a `Picture`.
`void`	`renderViewToCanvas(String viewId, Canvas canvas)` Renders this SVG document to a Canvas using the specified view defined in the document.
`void`	`renderViewToCanvas(String viewId, Canvas canvas, RectF viewPort)` Renders this SVG document to a Canvas using the specified view defined in the document.
`Picture`	`renderViewToPicture(String viewId, int widthInPixels, int heightInPixels)` Renders this SVG document to a `Picture` using the specified view defined in the document.
`void`	`setDocumentHeight(float pixels)` Change the height of the document by altering the "height" attribute of the root `<svg>` element.
`void`	`setDocumentHeight(String value)` Change the height of the document by altering the "height" attribute of the root `<svg>` element.
`void`	`setDocumentPreserveAspectRatio(PreserveAspectRatio preserveAspectRatio)` Change the document positioning by altering the "preserveAspectRatio" attribute of the root `<svg>` element.
`void`	`setDocumentViewBox(float minX, float minY, float width, float height)` Change the document view box by altering the "viewBox" attribute of the root `<svg>` element.
`void`	`setDocumentWidth(float pixels)` Change the width of the document by altering the "width" attribute of the root `<svg>` element.
`void`	`setDocumentWidth(String value)` Change the width of the document by altering the "width" attribute of the root `<svg>` element.
`static void`	`setInternalEntitiesEnabled(boolean enable)` Tells the parser whether to allow the expansion of internal entities.
`void`	`setRenderDPI(float dpi)` Set the DPI (dots-per-inch) value to use when rendering.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getFromInputStream
```
public static SVG getFromInputStream(InputStream is)
                              throws SVGParseException
```
    Read and parse an SVG from the given InputStream.
    
    Parameters:
    
    is - the input stream from which to read the file.
    
    Returns:
    
    an SVG instance on which you can call one of the render methods.
    
    Throws:
    
    SVGParseException - if there is an error parsing the document.
  - getFromString
```
public static SVG getFromString(String svg)
                         throws SVGParseException
```
    Read and parse an SVG from the given String.
    
    Parameters:
    
    svg - the String instance containing the SVG document.
    
    Returns:
    
    an SVG instance on which you can call one of the render methods.
    
    Throws:
    
    SVGParseException - if there is an error parsing the document.
  - getFromResource
```
public static SVG getFromResource(Context context,
                                  int resourceId)
                           throws SVGParseException
```
    Read and parse an SVG from the given resource location.
    
    Parameters:
    
    context - the Android context of the resource.
    
    resourceId - the resource identifier of the SVG document.
    
    Returns:
    
    an SVG instance on which you can call one of the render methods.
    
    Throws:
    
    SVGParseException - if there is an error parsing the document.
  - getFromResource
```
public static SVG getFromResource(Resources resources,
                                  int resourceId)
                           throws SVGParseException
```
    Read and parse an SVG from the given resource location.
    
    Parameters:
    
    resources - the set of Resources in which to locate the file.
    
    resourceId - the resource identifier of the SVG document.
    
    Returns:
    
    an SVG instance on which you can call one of the render methods.
    
    Throws:
    
    SVGParseException - if there is an error parsing the document.
    
    Since:
    
    1.2.1
  - getFromAsset
```
public static SVG getFromAsset(AssetManager assetManager,
                               String filename)
                        throws SVGParseException,
                               IOException
```
    Read and parse an SVG from the assets folder.
    
    Parameters:
    
    assetManager - the AssetManager instance to use when reading the file.
    
    filename - the filename of the SVG document within assets.
    
    Returns:
    
    an SVG instance on which you can call one of the render methods.
    
    Throws:
    
    SVGParseException - if there is an error parsing the document.
    
    IOException - if there is some IO error while reading the file.
  - setInternalEntitiesEnabled
```
public static void setInternalEntitiesEnabled(boolean enable)
```
    Tells the parser whether to allow the expansion of internal entities. An example of document containing an internal entities is: <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd" [ <!ENTITY hello "Hello World!"> ]> <svg> <text>&hello;</text> </svg> Entities are useful in some circumstances, but SVG files that use them are quite rare. Note also that enabling entity expansion makes you vulnerable to the Billion Laughs Attack Entity expansion is enabled by default.
    
    Parameters:
    
    enable - Set true if you want to enable entity expansion by the parser.
    
    Since:
    
    1.3
  - isInternalEntitiesEnabled
```
public static boolean isInternalEntitiesEnabled()
```
    Returns:
    
    true if internal entity expansion is enabled in the parser
    
    Since:
    
    1.3
  - registerExternalFileResolver
```
public static void registerExternalFileResolver(SVGExternalFileResolver fileResolver)
```
    Register an SVGExternalFileResolver instance that the renderer should use when resolving external references such as images, fonts, and CSS stylesheets.
    Note: prior to release 1.3, this was an instance method of (@code SVG}. In 1.3, it was changed to a static method so that users can resolve external references to CSSS files while the SVG is being parsed.
    
    Parameters:
    
    fileResolver - the resolver to use.
    
    Since:
    
    1.3
  - deregisterExternalFileResolver
```
public static void deregisterExternalFileResolver()
```
    De-register the current SVGExternalFileResolver instance.
  - setRenderDPI
```
public void setRenderDPI(float dpi)
```
    Set the DPI (dots-per-inch) value to use when rendering. The DPI setting is used in the conversion of "physical" units - such an "pt" or "cm" - to pixel values. The default DPI is 96.
    You should not normally need to alter the DPI from the default of 96 as recommended by the SVG and CSS specifications.
    
    Parameters:
    
    dpi - the DPI value that the renderer should use.
  - getRenderDPI
```
public float getRenderDPI()
```
    Get the current render DPI setting.
    
    Returns:
    
    the DPI value
  - renderToPicture
```
public Picture renderToPicture()
```
    Renders this SVG document to a Picture object.
    An attempt will be made to determine a suitable initial viewport from the contents of the SVG file. If an appropriate viewport can't be determined, a default viewport of 512x512 will be used.
    
    Returns:
    
    a Picture object suitable for later rendering using Canvas.drawPicture()
  - renderToPicture
```
public Picture renderToPicture(int widthInPixels,
                               int heightInPixels)
```
    Renders this SVG document to a Picture.
    
    Parameters:
    
    widthInPixels - the width of the initial viewport
    
    heightInPixels - the height of the initial viewport
    
    Returns:
    
    a Picture object suitable for later rendering using Canvas.drawPicture(Picture)
  - renderToPicture
```
public Picture renderToPicture(RenderOptions renderOptions)
```
    Renders this SVG document to a Picture.
    
    Parameters:
    
    renderOptions - options that describe how to render this SVG on the Canvas.
    
    Returns:
    
    a Picture object suitable for later rendering using Canvas.drawPicture(Picture)
    
    Since:
    
    1.3
  - renderToPicture
```
public Picture renderToPicture(int widthInPixels,
                               int heightInPixels,
                               RenderOptions renderOptions)
```
    Renders this SVG document to a Picture.
    
    Parameters:
    
    widthInPixels - the width of the Picture
    
    heightInPixels - the height of the Picture
    
    renderOptions - options that describe how to render this SVG on the Canvas.
    
    Returns:
    
    a Picture object suitable for later rendering using Canvas.drawPicture(Picture)
    
    Since:
    
    1.3
  - renderViewToPicture
```
public Picture renderViewToPicture(String viewId,
                                   int widthInPixels,
                                   int heightInPixels)
```
    Renders this SVG document to a Picture using the specified view defined in the document.
    A View is an special element in a SVG document that describes a rectangular area in the document. Calling this method with a viewId will result in the specified view being positioned and scaled to the viewport. In other words, use renderToPicture() to render the whole document, or use this method instead to render just a part of it.
    
    Parameters:
    
    viewId - the id of a view element in the document that defines which section of the document is to be visible.
    
    widthInPixels - the width of the initial viewport
    
    heightInPixels - the height of the initial viewport
    
    Returns:
    
    a Picture object suitable for later rendering using Canvas.drawPicture(), or null if the viewId was not found.
  - renderToCanvas
```
public void renderToCanvas(Canvas canvas)
```
    Renders this SVG document to a Canvas object. The full width and height of the canvas will be used as the viewport into which the document will be rendered.
    
    Parameters:
    
    canvas - the canvas to which the document should be rendered.
    
    Since:
    
    1.3
  - renderToCanvas
```
public void renderToCanvas(Canvas canvas,
                           RectF viewPort)
```
    Renders this SVG document to a Canvas object.
    
    Parameters:
    
    canvas - the canvas to which the document should be rendered.
    
    viewPort - the bounds of the area on the canvas you want the SVG rendered, or null for the whole canvas.
  - renderToCanvas
```
public void renderToCanvas(Canvas canvas,
                           RenderOptions renderOptions)
```
    Renders this SVG document to a Canvas object.
    
    Parameters:
    
    canvas - the canvas to which the document should be rendered.
    
    renderOptions - options that describe how to render this SVG on the Canvas.
    
    Since:
    
    1.3
  - renderViewToCanvas
```
public void renderViewToCanvas(String viewId,
                               Canvas canvas)
```
    Renders this SVG document to a Canvas using the specified view defined in the document.
    A View is an special element in a SVG documents that describes a rectangular area in the document. Calling this method with a viewId will result in the specified view being positioned and scaled to the viewport. In other words, use renderToPicture() to render the whole document, or use this method instead to render just a part of it.
    If the <view> could not be found, nothing will be drawn.
    
    Parameters:
    
    viewId - the id of a view element in the document that defines which section of the document is to be visible.
    
    canvas - the canvas to which the document should be rendered.
  - renderViewToCanvas
```
public void renderViewToCanvas(String viewId,
                               Canvas canvas,
                               RectF viewPort)
```
    Renders this SVG document to a Canvas using the specified view defined in the document.
    A View is an special element in a SVG documents that describes a rectangular area in the document. Calling this method with a viewId will result in the specified view being positioned and scaled to the viewport. In other words, use renderToPicture() to render the whole document, or use this method instead to render just a part of it.
    If the <view> could not be found, nothing will be drawn.
    
    Parameters:
    
    viewId - the id of a view element in the document that defines which section of the document is to be visible.
    
    canvas - the canvas to which the document should be rendered.
    
    viewPort - the bounds of the area on the canvas you want the SVG rendered, or null for the whole canvas.
  - getVersion
```
public static String getVersion()
```
    Returns the version number of this library.
    
    Returns:
    
    the version number in string format
  - getDocumentTitle
```
public String getDocumentTitle()
```
    Returns the contents of the <title> element in the SVG document.
    
    Returns:
    
    title contents if available, otherwise an empty string.
    
    Throws:
    
    IllegalArgumentException - if there is no current SVG document loaded.
  - getDocumentDescription
```
public String getDocumentDescription()
```
    Returns the contents of the <desc> element in the SVG document.
    
    Returns:
    
    desc contents if available, otherwise an empty string.
    
    Throws:
    
    IllegalArgumentException - if there is no current SVG document loaded.
  - getDocumentSVGVersion
```
public String getDocumentSVGVersion()
```
    Returns the SVG version number as provided in the root <svg> tag of the document.
    
    Returns:
    
    the version string if declared, otherwise an empty string.
    
    Throws:
    
    IllegalArgumentException - if there is no current SVG document loaded.
  - getViewList
```
public Set<String> getViewList()
```
    Returns a list of ids for all <view> elements in this SVG document.
    The returned view ids could be used when calling and of the renderViewToX() methods.
    
    Returns:
    
    the list of id strings.
    
    Throws:
    
    IllegalArgumentException - if there is no current SVG document loaded.
  - getDocumentWidth
```
public float getDocumentWidth()
```
    Returns the width of the document as specified in the SVG file.
    If the width in the document is specified in pixels, that value will be returned. If the value is listed with a physical unit such as "cm", then the current RenderDPI value will be used to convert that value to pixels. If the width is missing, or in a form which can't be converted to pixels, such as "100%" for example, -1 will be returned.
    
    Returns:
    
    the width in pixels, or -1 if there is no width available.
    
    Throws:
    
    IllegalArgumentException - if there is no current SVG document loaded.
  - setDocumentWidth
```
public void setDocumentWidth(float pixels)
```
    Change the width of the document by altering the "width" attribute of the root <svg> element.
    
    Parameters:
    
    pixels - The new value of width in pixels.
    
    Throws:
    
    IllegalArgumentException - if there is no current SVG document loaded.
  - setDocumentWidth
```
public void setDocumentWidth(String value)
                      throws SVGParseException
```
    Change the width of the document by altering the "width" attribute of the root <svg> element.
    
    Parameters:
    
    value - A valid SVG 'length' attribute, such as "100px" or "10cm".
    
    Throws:
    
    SVGParseException - if value cannot be parsed successfully.
    
    IllegalArgumentException - if there is no current SVG document loaded.
  - getDocumentHeight
```
public float getDocumentHeight()
```
    Returns the height of the document as specified in the SVG file.
    If the height in the document is specified in pixels, that value will be returned. If the value is listed with a physical unit such as "cm", then the current RenderDPI value will be used to convert that value to pixels. If the height is missing, or in a form which can't be converted to pixels, such as "100%" for example, -1 will be returned.
    
    Returns:
    
    the height in pixels, or -1 if there is no height available.
    
    Throws:
    
    IllegalArgumentException - if there is no current SVG document loaded.
  - setDocumentHeight
```
public void setDocumentHeight(float pixels)
```
    Change the height of the document by altering the "height" attribute of the root <svg> element.
    
    Parameters:
    
    pixels - The new value of height in pixels.
    
    Throws:
    
    IllegalArgumentException - if there is no current SVG document loaded.
  - setDocumentHeight
```
public void setDocumentHeight(String value)
                       throws SVGParseException
```
    Change the height of the document by altering the "height" attribute of the root <svg> element.
    
    Parameters:
    
    value - A valid SVG 'length' attribute, such as "100px" or "10cm".
    
    Throws:
    
    SVGParseException - if value cannot be parsed successfully.
    
    IllegalArgumentException - if there is no current SVG document loaded.
  - setDocumentViewBox
```
public void setDocumentViewBox(float minX,
                               float minY,
                               float width,
                               float height)
```
    Change the document view box by altering the "viewBox" attribute of the root <svg> element.
    The viewBox generally describes the bounding box dimensions of the document contents. A valid viewBox is necessary if you want the document scaled to fit the canvas or viewport the document is to be rendered into.
    By setting a viewBox that describes only a portion of the document, you can reproduce the effect of image sprites.
    
    Parameters:
    
    minX - the left coordinate of the viewBox in pixels
    
    minY - the top coordinate of the viewBox in pixels.
    
    width - the width of the viewBox in pixels
    
    height - the height of the viewBox in pixels
    
    Throws:
    
    IllegalArgumentException - if there is no current SVG document loaded.
  - getDocumentViewBox
```
public RectF getDocumentViewBox()
```
    Returns the viewBox attribute of the current SVG document.
    
    Returns:
    
    the document's viewBox attribute as a android.graphics.RectF object, or null if not set.
    
    Throws:
    
    IllegalArgumentException - if there is no current SVG document loaded.
  - setDocumentPreserveAspectRatio
```
public void setDocumentPreserveAspectRatio(PreserveAspectRatio preserveAspectRatio)
```
    Change the document positioning by altering the "preserveAspectRatio" attribute of the root <svg> element. See the documentation for PreserveAspectRatio for more information on how positioning works.
    
    Parameters:
    
    preserveAspectRatio - the new preserveAspectRatio setting for the root <svg> element.
    
    Throws:
    
    IllegalArgumentException - if there is no current SVG document loaded.
  - getDocumentPreserveAspectRatio
```
public PreserveAspectRatio getDocumentPreserveAspectRatio()
```
    Return the "preserveAspectRatio" attribute of the root <svg> element in the form of an PreserveAspectRatio object.
    
    Returns:
    
    the preserveAspectRatio setting of the document's root <svg> element.
    
    Throws:
    
    IllegalArgumentException - if there is no current SVG document loaded.
  - getDocumentAspectRatio
```
public float getDocumentAspectRatio()
```
    Returns the aspect ratio of the document as a width/height fraction.
    If the width or height of the document are listed with a physical unit such as "cm", then the current renderDPI setting will be used to convert that value to pixels.
    If the width or height cannot be determined, -1 will be returned.
    
    Returns:
    
    the aspect ratio as a width/height fraction, or -1 if the ratio cannot be determined.
    
    Throws:
    
    IllegalArgumentException - if there is no current SVG document loaded.

Class SVG

Usage summary

Usage example

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getFromInputStream

getFromString

getFromResource

getFromResource

getFromAsset

setInternalEntitiesEnabled

isInternalEntitiesEnabled

registerExternalFileResolver

deregisterExternalFileResolver

setRenderDPI

getRenderDPI

renderToPicture

renderToPicture

renderToPicture

renderToPicture

renderViewToPicture

renderToCanvas

renderToCanvas

renderToCanvas

renderViewToCanvas

renderViewToCanvas

getVersion

getDocumentTitle

getDocumentDescription

getDocumentSVGVersion

getViewList

getDocumentWidth

setDocumentWidth

setDocumentWidth

getDocumentHeight

setDocumentHeight

setDocumentHeight

setDocumentViewBox

getDocumentViewBox

setDocumentPreserveAspectRatio

getDocumentPreserveAspectRatio

getDocumentAspectRatio