{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

ImageVector

public final class ImageVector


Vector graphics object that is generated as a result of ImageVector.Builder It can be composed and rendered by passing it as an argument to rememberVectorPainter

Summary

Nested types

public final class ImageVector.Builder

Builder used to construct a Vector graphic tree.

public static class ImageVector.Companion

Provide an empty companion object to hang platform-specific companion extensions onto.

Public methods

boolean
equals(Object other)
final boolean

Determines if the vector asset should automatically be mirrored for right to left locales

final @NonNull Dp

Intrinsic height of the vector asset in Dp

final @NonNull Dp

Intrinsic width of the vector asset in Dp

final @NonNull String

Name of the Vector asset

final @NonNull VectorGroup

Root group of the vector asset that contains all the child groups and paths

final @NonNull BlendMode

Blend mode used to apply tintColor

final @NonNull Color

Optional tint color to be applied to the vector graphic

final float

Used to define the height of the viewport space.

final float

Used to define the width of the viewport space.

int

Public methods

equals

public boolean equals(Object other)

getAutoMirror

public final boolean getAutoMirror()

Determines if the vector asset should automatically be mirrored for right to left locales

getDefaultHeight

public final @NonNull Dp getDefaultHeight()

Intrinsic height of the vector asset in Dp

getDefaultWidth

public final @NonNull Dp getDefaultWidth()

Intrinsic width of the vector asset in Dp

getName

public final @NonNull String getName()

Name of the Vector asset

getRoot

public final @NonNull VectorGroup getRoot()

Root group of the vector asset that contains all the child groups and paths

getTintBlendMode

public final @NonNull BlendMode getTintBlendMode()

Blend mode used to apply tintColor

getTintColor

public final @NonNull Color getTintColor()

Optional tint color to be applied to the vector graphic

getViewportHeight

public final float getViewportHeight()

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

getViewportWidth

public final float getViewportWidth()

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

hashCode

public int hashCode()