VectorDrawable Class

Definition

[Android.Runtime.Register("android/graphics/drawable/VectorDrawable", DoNotGenerateAcw=true)]
public class VectorDrawable : Android.Graphics.Drawables.Drawable

[<Android.Runtime.Register("android/graphics/drawable/VectorDrawable", DoNotGenerateAcw=true)>]
type VectorDrawable = class
    inherit Drawable

Inheritance

Object

Object

Drawable

VectorDrawable

Attributes

RegisterAttribute

Remarks

This lets you create a drawable based on an XML vector graphic. <p/> <strong>Note:</strong> To optimize for the re-drawing performance, one bitmap cache is created for each VectorDrawable. Therefore, referring to the same VectorDrawable means sharing the same bitmap cache. If these references don't agree upon on the same size, the bitmap will be recreated and redrawn every time size is changed. In other words, if a VectorDrawable is used for different sizes, it is more efficient to create multiple VectorDrawables, one for each size. <p/> VectorDrawable can be defined in an XML file with the <vector> element. <p/> The vector drawable has the following elements: <p/> <dt><vector></dt> <dl> <dd>Used to define a vector drawable <dl> <dt>android:name</dt> <dd>Defines the name of this vector drawable.</dd> <dt>android:width</dt> <dd>Used to define the intrinsic width of the drawable. This supports all the dimension units, normally specified with dp.</dd> <dt>android:height</dt> <dd>Used to define the intrinsic height of the drawable. This supports all the dimension units, normally specified with dp.</dd> <dt>android:viewportWidth</dt> <dd>Used to define the width of the viewport space. Viewport is basically the virtual canvas where the paths are drawn on.</dd> <dt>android:viewportHeight</dt> <dd>Used to define the height of the viewport space. Viewport is basically the virtual canvas where the paths are drawn on.</dd> <dt>android:tint</dt> <dd>The color to apply to the drawable as a tint. By default, no tint is applied.</dd> <dt>android:tintMode</dt> <dd>The Porter-Duff blending mode for the tint color. Default is src_in.</dd> <dt>android:autoMirrored</dt> <dd>Indicates if the drawable needs to be mirrored when its layout direction is RTL (right-to-left). Default is false.</dd> <dt>android:alpha</dt> <dd>The opacity of this drawable. Default is 1.0.</dd> </dl></dd> </dl>

<dl> <dt><group></dt> <dd>Defines a group of paths or subgroups, plus transformation information. The transformations are defined in the same coordinates as the viewport. And the transformations are applied in the order of scale, rotate then translate. <dl> <dt>android:name</dt> <dd>Defines the name of the group.</dd> <dt>android:rotation</dt> <dd>The degrees of rotation of the group. Default is 0.</dd> <dt>android:pivotX</dt> <dd>The X coordinate of the pivot for the scale and rotation of the group. This is defined in the viewport space. Default is 0.</dd> <dt>android:pivotY</dt> <dd>The Y coordinate of the pivot for the scale and rotation of the group. This is defined in the viewport space. Default is 0.</dd> <dt>android:scaleX</dt> <dd>The amount of scale on the X Coordinate. Default is 1.</dd> <dt>android:scaleY</dt> <dd>The amount of scale on the Y coordinate. Default is 1.</dd> <dt>android:translateX</dt> <dd>The amount of translation on the X coordinate. This is defined in the viewport space. Default is 0.</dd> <dt>android:translateY</dt> <dd>The amount of translation on the Y coordinate. This is defined in the viewport space. Default is 0.</dd> </dl></dd> </dl>

<dl> <dt><path></dt> <dd>Defines paths to be drawn. <dl> <dt>android:name</dt> <dd>Defines the name of the path.</dd> <dt>android:pathData</dt> <dd>Defines path data using exactly same format as "d" attribute in the SVG's path data. This is defined in the viewport space.</dd> <dt>android:fillColor</dt> <dd>Specifies the color used to fill the path. May be a color or, for SDK 24+, a color state list or a gradient color (See android.R.styleable#GradientColor and android.R.styleable#GradientColorItem). If this property is animated, any value set by the animation will override the original value. No path fill is drawn if this property is not specified.</dd> <dt>android:strokeColor</dt> <dd>Specifies the color used to draw the path outline. May be a color or, for SDK 24+, a color state list or a gradient color (See android.R.styleable#GradientColor and android.R.styleable#GradientColorItem). If this property is animated, any value set by the animation will override the original value. No path outline is drawn if this property is not specified.</dd> <dt>android:strokeWidth</dt> <dd>The width a path stroke. Default is 0.</dd> <dt>android:strokeAlpha</dt> <dd>The opacity of a path stroke. Default is 1.</dd> <dt>android:fillAlpha</dt> <dd>The opacity to fill the path with. Default is 1.</dd> <dt>android:trimPathStart</dt> <dd>The fraction of the path to trim from the start, in the range from 0 to 1. Default is 0.</dd> <dt>android:trimPathEnd</dt> <dd>The fraction of the path to trim from the end, in the range from 0 to 1. Default is 1.</dd> <dt>android:trimPathOffset</dt> <dd>Shift trim region (allows showed region to include the start and end), in the range from 0 to 1. Default is 0.</dd> <dt>android:strokeLineCap</dt> <dd>Sets the linecap for a stroked path: butt, round, square. Default is butt.</dd> <dt>android:strokeLineJoin</dt> <dd>Sets the lineJoin for a stroked path: miter,round,bevel. Default is miter.</dd> <dt>android:strokeMiterLimit</dt> <dd>Sets the Miter limit for a stroked path. Default is 4.</dd> <dt>android:fillType</dt> <dd>For SDK 24+, sets the fillType for a path. The types can be either "evenOdd" or "nonZero". They behave the same as SVG's "fill-rule" properties. Default is nonZero. For more details, see FillRuleProperty</dd> </dl></dd>

</dl>

<dl> <dt><clip-path></dt> <dd>Defines path to be the current clip. Note that the clip path only apply to the current group and its children. <dl> <dt>android:name</dt> <dd>Defines the name of the clip path.</dd> <dd>Animatable : No.</dd> <dt>android:pathData</dt> <dd>Defines clip path using the same format as "d" attribute in the SVG's path data.</dd> <dd>Animatable : Yes.</dd> </dl></dd> </dl> <li>Here is a simple VectorDrawable in this vectordrawable.xml file.

<vector xmlns:android="http://schemas.android.com/apk/res/android"
                android:height="64dp"
                android:width="64dp"
                android:viewportHeight="600"
                android:viewportWidth="600" >
                <group
                    android:name="rotationGroup"
                    android:pivotX="300.0"
                    android:pivotY="300.0"
                    android:rotation="45.0" >
                    <path
                        android:name="v"
                        android:fillColor="#000000"
                        android:pathData="M300,70 l 0,-70 70,70 0,0 -70,70z" />
                </group>
            </vector>

</li> <h4>Gradient support</h4> We support 3 types of gradients: android.graphics.LinearGradient, android.graphics.RadialGradient, or android.graphics.SweepGradient. <p/> And we support all of 3 types of tile modes android.graphics.Shader.TileMode: CLAMP, REPEAT, MIRROR. <p/> All of the attributes are listed in android.R.styleable#GradientColor. Note that different attributes are relevant for different types of gradient. <table border="2" align="center" cellpadding="5"> <thead> <tr> <th>LinearGradient</th> <th>RadialGradient</th> <th>SweepGradient</th> </tr> </thead> <tr> <td>startColor </td> <td>startColor</td> <td>startColor</td> </tr> <tr> <td>centerColor</td> <td>centerColor</td> <td>centerColor</td> </tr> <tr> <td>endColor</td> <td>endColor</td> <td>endColor</td> </tr> <tr> <td>type</td> <td>type</td> <td>type</td> </tr> <tr> <td>tileMode</td> <td>tileMode</td> <td>tileMode</td> </tr> <tr> <td>startX</td> <td>centerX</td> <td>centerX</td> </tr> <tr> <td>startY</td> <td>centerY</td> <td>centerY</td> </tr> <tr> <td>endX</td> <td>gradientRadius</td> <td></td> </tr> <tr> <td>endY</td> <td></td> <td></td> </tr> </table> <p/> Also note that if any color item android.R.styleable#GradientColorItem is defined, then startColor, centerColor and endColor will be ignored. <p/> See more details in android.R.styleable#GradientColor and android.R.styleable#GradientColorItem. <p/> Here is a simple example that defines a linear gradient.

<gradient xmlns:android="http://schemas.android.com/apk/res/android"
                android:startColor="?android:attr/colorPrimary"
                android:endColor="?android:attr/colorControlActivated"
                android:centerColor="#f00"
                android:startX="0"
                android:startY="0"
                android:endX="100"
                android:endY="100"
                android:type="linear">
            </gradient>

And here is a simple example that defines a radial gradient using color items.

<gradient xmlns:android="http://schemas.android.com/apk/res/android"
                android:centerX="300"
                android:centerY="300"
                android:gradientRadius="100"
                android:type="radial">
                <item android:offset="0.1" android:color="#0ff"/>
                <item android:offset="0.4" android:color="#fff"/>
                <item android:offset="0.9" android:color="#ff0"/>
            </gradient>

Java documentation for android.graphics.drawable.VectorDrawable.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

Properties

Methods

Explicit Interface Implementations

Extension Methods

Applies to