VectorDrawable

Class Overview

This lets you create a drawable based on an XML vector graphic. It can be defined in an XML file with the <vector> element.

The vector drawable has the following elements:

Used to defined a vector drawable

android:name

Defines the name of this vector drawable.

android:width

Used to defined the intrinsic width of the drawable. This support all the dimension units, normally specified with dp.

android:height

Used to defined the intrinsic height the drawable. This support all the dimension units, normally specified with dp.

android:viewportWidth

Used to defined the width of the viewport space. Viewport is basically the virtual canvas where the paths are drawn on.

android:viewportHeight

Used to defined the height of the viewport space. Viewport is basically the virtual canvas where the paths are drawn on.

android:tint

The color to apply to the drawable as a tint. By default, no tint is applied.

android:tintMode

The Porter-Duff blending mode for the tint color. The default value is src_in.

android:autoMirrored

Indicates if the drawable needs to be mirrored when its layout direction is RTL (right-to-left).

android:alpha

The opacity of this drawable.

<group>

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.

android:name

Defines the name of the group.

android:rotation

The degrees of rotation of the group.

android:pivotX

The X coordinate of the pivot for the scale and rotation of the group. This is defined in the viewport space.

android:pivotY

The Y coordinate of the pivot for the scale and rotation of the group. This is defined in the viewport space.

android:scaleX

The amount of scale on the X Coordinate.

android:scaleY

The amount of scale on the Y coordinate.

android:translateX

The amount of translation on the X coordinate. This is defined in the viewport space.

android:translateY

The amount of translation on the Y coordinate. This is defined in the viewport space.

<path>

Defines paths to be drawn.

android:name

Defines the name of the path.

android:pathData

Defines path string. This is using exactly same format as "d" attribute in the SVG's path data. This is defined in the viewport space.

android:fillColor

Defines the color to fill the path (none if not present).

android:strokeColor

Defines the color to draw the path outline (none if not present).

android:strokeWidth

The width a path stroke.

android:strokeAlpha

The opacity of a path stroke.

android:fillAlpha

The opacity to fill the path with.

android:trimPathStart

The fraction of the path to trim from the start, in the range from 0 to 1.

android:trimPathEnd

The fraction of the path to trim from the end, in the range from 0 to 1.

android:trimPathOffset

Shift trim region (allows showed region to include the start and end), in the range from 0 to 1.

android:strokeLineCap

Sets the linecap for a stroked path: butt, round, square.

android:strokeLineJoin

Sets the lineJoin for a stroked path: miter,round,bevel.

android:strokeMiterLimit

Sets the Miter limit for a stroked path.

<clip-path>

Defines path to be the current clip.

android:name

Defines the name of the clip path.

android:pathData

Defines clip path string. This is using exactly same format as "d" attribute in the SVG's path data.

 <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>
 

Summary

[Expand] Inherited Methods
From class android.graphics.drawable.Drawable void applyTheme(Resources.Theme t) Applies the specified theme to this Drawable and its children. boolean canApplyTheme() void clearColorFilter() Removes the color filter for this drawable. final Rect copyBounds() Return a copy of the drawable's bounds in a new Rect. final void copyBounds(Rect bounds) Return a copy of the drawable's bounds in the specified Rect (allocated by the caller). static Drawable createFromPath(String pathName) Create a drawable from file path name. static Drawable createFromResourceStream(Resources res, TypedValue value, InputStream is, String srcName, BitmapFactory.Options opts) Create a drawable from an inputstream, using the given resources and value to determine density information. static Drawable createFromResourceStream(Resources res, TypedValue value, InputStream is, String srcName) Create a drawable from an inputstream, using the given resources and value to determine density information. static Drawable createFromStream(InputStream is, String srcName) Create a drawable from an inputstream static Drawable createFromXml(Resources r, XmlPullParser parser, Resources.Theme theme) Create a drawable from an XML document using an optional Resources.Theme. static Drawable createFromXml(Resources r, XmlPullParser parser) Create a drawable from an XML document. static Drawable createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs) Create from inside an XML document. static Drawable createFromXmlInner(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme) Create a drawable from inside an XML document using an optional Resources.Theme. abstract void draw(Canvas canvas) Draw in its bounds (set via setBounds) respecting optional effects such as alpha (set via setAlpha) and color filter (set via setColorFilter). int getAlpha() Gets the current alpha value for the drawable. final Rect getBounds() Return the drawable's bounds Rect. Drawable.Callback getCallback() Return the current Drawable.Callback implementation attached to this Drawable. int getChangingConfigurations() Return a mask of the configuration parameters for which this drawable may change, requiring that it be re-created. ColorFilter getColorFilter() Returns the current color filter, or null if none set. Drawable.ConstantState getConstantState() Return a Drawable.ConstantState instance that holds the shared state of this Drawable. Drawable getCurrent() Rect getDirtyBounds() Return the drawable's dirty bounds Rect. int getIntrinsicHeight() Return the intrinsic height of the underlying drawable object. int getIntrinsicWidth() Return the intrinsic width of the underlying drawable object. final int getLevel() Retrieve the current level. int getMinimumHeight() Returns the minimum height suggested by this Drawable. int getMinimumWidth() Returns the minimum width suggested by this Drawable. abstract int getOpacity() Return the opacity/transparency of this Drawable. void getOutline(Outline outline) Called to get the drawable to populate the Outline that defines its drawing area. boolean getPadding(Rect padding) Return in padding the insets suggested by this Drawable for placing content inside the drawable's bounds. int[] getState() Describes the current state, as a union of primitve states, such as state_focused, state_selected, etc. Region getTransparentRegion() Returns a Region representing the part of the Drawable that is completely transparent. void inflate(Resources r, XmlPullParser parser, AttributeSet attrs, Resources.Theme theme) Inflate this Drawable from an XML resource optionally styled by a theme. void inflate(Resources r, XmlPullParser parser, AttributeSet attrs) Inflate this Drawable from an XML resource. void invalidateSelf() Use the current Drawable.Callback implementation to have this Drawable redrawn. boolean isAutoMirrored() Tells if this Drawable will be automatically mirrored when its layout direction is RTL right-to-left. boolean isStateful() Indicates whether this drawable will change its appearance based on state. final boolean isVisible() void jumpToCurrentState() If this Drawable does transition animations between states, ask that it immediately jump to the current state and skip any active animations. Drawable mutate() Make this drawable mutable. void onBoundsChange(Rect bounds) Override this in your subclass to change appearance if you vary based on the bounds. boolean onLevelChange(int level) Override this in your subclass to change appearance if you vary based on level. boolean onStateChange(int[] state) Override this in your subclass to change appearance if you recognize the specified state. static int resolveOpacity(int op1, int op2) Return the appropriate opacity value for two source opacities. void scheduleSelf(Runnable what, long when) Use the current Drawable.Callback implementation to have this Drawable scheduled. abstract void setAlpha(int alpha) Specify an alpha value for the drawable. void setAutoMirrored(boolean mirrored) Set whether this Drawable is automatically mirrored when its layout direction is RTL (right-to left). void setBounds(Rect bounds) Specify a bounding rectangle for the Drawable. void setBounds(int left, int top, int right, int bottom) Specify a bounding rectangle for the Drawable. final void setCallback(Drawable.Callback cb) Bind a Drawable.Callback object to this Drawable. void setChangingConfigurations(int configs) Set a mask of the configuration parameters for which this drawable may change, requiring that it be re-created. abstract void setColorFilter(ColorFilter cf) Specify an optional color filter for the drawable. void setColorFilter(int color, PorterDuff.Mode mode) Specify a color and Porter-Duff mode to be the color filter for this drawable. void setDither(boolean dither) Set to true to have the drawable dither its colors when drawn to a device with fewer than 8-bits per color component. void setFilterBitmap(boolean filter) Set to true to have the drawable filter its bitmap when scaled or rotated (for drawables that use bitmaps). void setHotspot(float x, float y) Specifies the hotspot's location within the drawable. void setHotspotBounds(int left, int top, int right, int bottom) Sets the bounds to which the hotspot is constrained, if they should be different from the drawable bounds. final boolean setLevel(int level) Specify the level for the drawable. boolean setState(int[] stateSet) Specify a set of states for the drawable. void setTint(int tint) Specifies a tint for this drawable. void setTintList(ColorStateList tint) Specifies a tint for this drawable as a color state list. void setTintMode(PorterDuff.Mode tintMode) Specifies a tint blending mode for this drawable. boolean setVisible(boolean visible, boolean restart) Set whether this Drawable is visible. void unscheduleSelf(Runnable what) Use the current Drawable.Callback implementation to have this Drawable unscheduled.
From class java.lang.Object Object clone() Creates and returns a copy of this Object. boolean equals(Object o) Compares this instance with the specified object and indicates if they are equal. void finalize() Invoked when the garbage collector has detected that this instance is no longer reachable. final Class<?> getClass() Returns the unique instance of Class that represents this object's class. int hashCode() Returns an integer hash code for this object. final void notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up. final void notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up. String toString() Returns a string containing a concise, human-readable description of this object. final void wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object. final void wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires. final void wait(long millis) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.