PreserveAspectRatio (androidsvg 1.4 API)

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

```
public class PreserveAspectRatio
extends Object
```
The PreserveAspectRatio class tells the renderer how to scale and position the SVG document in the current viewport. It is roughly equivalent to the preserveAspectRatio attribute of an <svg> element.
In order for scaling to happen, the SVG document must have a viewBox attribute set. For example:
```
 
 <svg version="1.1" viewBox="0 0 200 100">
 
 
```
This class was previous named SVGPositioning. It was renamed in version 1.3 to reduce confusion when used as part of the RenderOptions class.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PreserveAspectRatio.Alignment` Determines how the document is to me positioned relative to the viewport (normally the canvas).
`static class`	`PreserveAspectRatio.Scale` Determine whether the scaled document fills the viewport entirely or is scaled to fill the viewport without overflowing.

Field Summary

Fields
Modifier and Type	Field and Description
`static PreserveAspectRatio`	`BOTTOM` Keep the document's aspect ratio, but scale it so that it fits neatly inside the viewport.
`static PreserveAspectRatio`	`END` Keep the document's aspect ratio, but scale it so that it fits neatly inside the viewport.
`static PreserveAspectRatio`	`FULLSCREEN` Keep the document's aspect ratio, but scale it so that it fills the entire viewport.
`static PreserveAspectRatio`	`FULLSCREEN_START` Keep the document's aspect ratio, but scale it so that it fills the entire viewport.
`static PreserveAspectRatio`	`LETTERBOX` Keep the document's aspect ratio, but scale it so that it fits neatly inside the viewport.
`static PreserveAspectRatio`	`START` Keep the document's aspect ratio, but scale it so that it fits neatly inside the viewport.
`static PreserveAspectRatio`	`STRETCH` Stretch horizontally and vertically to fill the viewport.
`static PreserveAspectRatio`	`TOP` Keep the document's aspect ratio, but scale it so that it fits neatly inside the viewport.
`static PreserveAspectRatio`	`UNSCALED` Draw document at its natural position and scale.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`PreserveAspectRatio.Alignment`	`getAlignment()` Returns the alignment value of this instance.
`PreserveAspectRatio.Scale`	`getScale()` Returns the scale value of this instance.
`static PreserveAspectRatio`	`of(String value)` Parse the given SVG `preserveAspectRation` attribute value and return an equivalent instance of this class.
`String`	`toString()`

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

- Field Detail
  - UNSCALED
```
public static final PreserveAspectRatio UNSCALED
```
    Draw document at its natural position and scale.
  - STRETCH
```
public static final PreserveAspectRatio STRETCH
```
    Stretch horizontally and vertically to fill the viewport.
    Equivalent to preserveAspectRatio="none" in an SVG.
  - LETTERBOX
```
public static final PreserveAspectRatio LETTERBOX
```
    Keep the document's aspect ratio, but scale it so that it fits neatly inside the viewport.
    The document will be centred in the viewport and may have blank strips at either the top and bottom of the viewport or at the sides.
    Equivalent to preserveAspectRatio="xMidYMid meet" in an SVG.
  - START
```
public static final PreserveAspectRatio START
```
    Keep the document's aspect ratio, but scale it so that it fits neatly inside the viewport.
    The document will be positioned at the top of tall and narrow viewports, and at the left of short and wide viewports.
    Equivalent to preserveAspectRatio="xMinYMin meet" in an SVG.
  - END
```
public static final PreserveAspectRatio END
```
    Keep the document's aspect ratio, but scale it so that it fits neatly inside the viewport.
    The document will be positioned at the bottom of tall and narrow viewports, and at the right of short and wide viewports.
    Equivalent to preserveAspectRatio="xMaxYMax meet" in an SVG.
  - TOP
```
public static final PreserveAspectRatio TOP
```
    Keep the document's aspect ratio, but scale it so that it fits neatly inside the viewport.
    The document will be positioned at the top of tall and narrow viewports, and at the centre of short and wide viewports.
    Equivalent to preserveAspectRatio="xMidYMin meet" in an SVG.
  - BOTTOM
```
public static final PreserveAspectRatio BOTTOM
```
    Keep the document's aspect ratio, but scale it so that it fits neatly inside the viewport.
    The document will be positioned at the bottom of tall and narrow viewports, and at the centre of short and wide viewports.
    Equivalent to preserveAspectRatio="xMidYMax meet" in an SVG.
  - FULLSCREEN
```
public static final PreserveAspectRatio FULLSCREEN
```
    Keep the document's aspect ratio, but scale it so that it fills the entire viewport. This may result in some of the document falling outside the viewport.
    The document will be positioned so that the centre of the document will always be visible, but the edges of the document may not.
    Equivalent to preserveAspectRatio="xMidYMid slice" in an SVG.
  - FULLSCREEN_START
```
public static final PreserveAspectRatio FULLSCREEN_START
```
    Keep the document's aspect ratio, but scale it so that it fills the entire viewport. This may result in some of the document falling outside the viewport.
    The document will be positioned so that the top left of the document will always be visible, but the right hand or bottom edge may not.
    Equivalent to preserveAspectRatio="xMinYMin slice" in an SVG.
- Method Detail
  - of
```
public static PreserveAspectRatio of(String value)
```
    Parse the given SVG preserveAspectRation attribute value and return an equivalent instance of this class.
    
    Parameters:
    
    value - a string in the same format as an SVG preserveAspectRatio attribute
    
    Returns:
    
    a instance of this class
  - getAlignment
```
public PreserveAspectRatio.Alignment getAlignment()
```
    Returns the alignment value of this instance.
    
    Returns:
    
    the alignment
  - getScale
```
public PreserveAspectRatio.Scale getScale()
```
    Returns the scale value of this instance.
    
    Returns:
    
    the scale
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PreserveAspectRatio

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UNSCALED

STRETCH

LETTERBOX

START

END

TOP

BOTTOM

FULLSCREEN

FULLSCREEN_START

Method Detail

of

getAlignment

getScale

equals

toString