RenderOptions (androidsvg 1.3 API)

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

public class RenderOptions
extends Object

A fluent builder class that creates a render configuration object for the SVG.renderToCanvas(Canvas,RenderOptions) and SVG.renderToPicture(int,int,RenderOptions) methods.

Example usage

 RenderOption renderOptions = RenderOptions.create();
 renderOptions.viewPort(100f, 100f, 400f, 300f)   // Set the area of the Canvas to render the SVG into
              .css("rect { fill: red; }")         // Add some CSS that makes all rectangles red
 svg.renderToCanvas(canvas, renderOptions);

Since:: 1.3

Constructor Summary

Constructors
Constructor and Description

RenderOptions()
Create a new RenderOptions instance.

RenderOptions(RenderOptions other)
Creates a copy of the given RenderOptions object.

Constructors
Constructor and Description
`RenderOptions()` Create a new `RenderOptions` instance.
`RenderOptions(RenderOptions other)` Creates a copy of the given `RenderOptions` object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RenderOptions`	`create()` Create a new `RenderOptions` instance.
`RenderOptions`	`css(String css)` Specifies some additional CSS rules that will be applied during render in addition to any specified in the file itself.
`boolean`	`hasCss()` Returns true if this RenderOptions instance has had CSS set with `css()`.
`boolean`	`hasPreserveAspectRatio()` Returns true if this RenderOptions instance has had a preserveAspectRatio value set with `preserveAspectRatio()`.
`boolean`	`hasTarget()` Returns true if this RenderOptions instance has had a target set with `target()`.
`boolean`	`hasView()` Returns true if this RenderOptions instance has had a view set with `view()`.
`boolean`	`hasViewBox()` Returns true if this RenderOptions instance has had a viewBox set with `viewBox()`.
`boolean`	`hasViewPort()` Returns true if this RenderOptions instance has had a viewPort set with `viewPort()`.
`RenderOptions`	`preserveAspectRatio(PreserveAspectRatio preserveAspectRatio)` Specifies how the renderer should handle aspect ratio when rendering the SVG.
`RenderOptions`	`target(String targetId)` Specifies the `id` of an element, in the SVG, to treat as the target element when using the `:target` CSS pseudo class.
`RenderOptions`	`view(String viewId)` Specifies the `id` of a `<view>` element in the SVG.
`RenderOptions`	`viewBox(float minX, float minY, float width, float height)` Specifies alternative values to use for the root element `viewBox`.
`RenderOptions`	`viewPort(float minX, float minY, float width, float height)` Describes the viewport into which the SVG should be rendered.

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

- Constructor Detail
  - RenderOptions
```
public RenderOptions()
```
    Create a new RenderOptions instance. You can choose to use either this constructor, or new RenderOptions.create(). Both are equivalent.
  - RenderOptions
```
public RenderOptions(RenderOptions other)
```
    Creates a copy of the given RenderOptions object.
    
    Parameters:
    
    other - the object to copy
- Method Detail
  - create
```
public static RenderOptions create()
```
    Create a new RenderOptions instance. This is just an alternative to new RenderOptions().
    
    Returns:
    
    new instance of this class.
  - css
```
public RenderOptions css(String css)
```
    Specifies some additional CSS rules that will be applied during render in addition to any specified in the file itself.
    
    Parameters:
    
    css - CSS rules to apply
    
    Returns:
    
    this same RenderOptions instance
  - hasCss
```
public boolean hasCss()
```
    Returns true if this RenderOptions instance has had CSS set with css().
    
    Returns:
    
    true if this RenderOptions instance has had CSS set
  - preserveAspectRatio
```
public RenderOptions preserveAspectRatio(PreserveAspectRatio preserveAspectRatio)
```
    Specifies how the renderer should handle aspect ratio when rendering the SVG. If not sepecified, the default will be PreserveAspectRatio.LETTERBOX. This is equivalent to the SVG default of xMidYMid meet.
    
    Parameters:
    
    preserveAspectRatio - the new aspect ration value
    
    Returns:
    
    this same RenderOptions instance
  - hasPreserveAspectRatio
```
public boolean hasPreserveAspectRatio()
```
    Returns true if this RenderOptions instance has had a preserveAspectRatio value set with preserveAspectRatio().
    
    Returns:
    
    true if this RenderOptions instance has had a preserveAspectRatio value set
  - view
```
public RenderOptions view(String viewId)
```
    Specifies the id of a <view> element in the SVG. A <view> element is a way to specify a predetermined view of the document, that differs from the default view. For example it can allow you to focus in on a small detail of the document. Note: setting this option will override any viewBox(float,float,float,float) or preserveAspectRatio(PreserveAspectRatio) settings.
    
    Parameters:
    
    viewId - the id attribute of the view that should be used for rendering
    
    Returns:
    
    this same RenderOptions instance
  - hasView
```
public boolean hasView()
```
    Returns true if this RenderOptions instance has had a view set with view().
    
    Returns:
    
    true if this RenderOptions instance has had a view set
  - viewBox
```
public RenderOptions viewBox(float minX,
                             float minY,
                             float width,
                             float height)
```
    Specifies alternative values to use for the root element viewBox. Any existing viewBox attribute value will be ignored. Note: will be overridden if a view(String) is set.
    
    Parameters:
    
    minX - The left X coordinate of the viewBox
    
    minY - The top Y coordinate of the viewBox
    
    width - The width of the viewBox
    
    height - The height of the viewBox
    
    Returns:
    
    this same RenderOptions instance
  - hasViewBox
```
public boolean hasViewBox()
```
    Returns true if this RenderOptions instance has had a viewBox set with viewBox().
    
    Returns:
    
    true if this RenderOptions instance has had a viewBox set
  - viewPort
```
public RenderOptions viewPort(float minX,
                              float minY,
                              float width,
                              float height)
```
    Describes the viewport into which the SVG should be rendered. If this is not specified, then the whole of the canvas will be used as the viewport. If rendering to a Picture then a default viewport width and height will be used.
    
    Parameters:
    
    minX - The left X coordinate of the viewport
    
    minY - The top Y coordinate of the viewport
    
    width - The width of the viewport
    
    height - The height of the viewport
    
    Returns:
    
    this same RenderOptions instance
  - hasViewPort
```
public boolean hasViewPort()
```
    Returns true if this RenderOptions instance has had a viewPort set with viewPort().
    
    Returns:
    
    true if this RenderOptions instance has had a viewPort set
  - target
```
public RenderOptions target(String targetId)
```
    Specifies the id of an element, in the SVG, to treat as the target element when using the :target CSS pseudo class.
    
    Parameters:
    
    targetId - the id attribute of an element
    
    Returns:
    
    this same RenderOptions instance
  - hasTarget
```
public boolean hasTarget()
```
    Returns true if this RenderOptions instance has had a target set with target().
    
    Returns:
    
    true if this RenderOptions instance has had a target set

Class RenderOptions

Example usage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RenderOptions

RenderOptions

Method Detail

create

css

hasCss

preserveAspectRatio

hasPreserveAspectRatio

view

hasView

viewBox

hasViewBox

viewPort

hasViewPort

target

hasTarget