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

ImageVectorKt

public final class ImageVectorKt


Summary

Public methods

static final @NonNull ImageVector.Builder
group(
    @NonNull ImageVector.Builder receiver,
    @NonNull String name,
    float rotate,
    float pivotX,
    float pivotY,
    float scaleX,
    float scaleY,
    float translationX,
    float translationY,
    @NonNull List<@NonNull PathNode> clipPathData,
    @ExtensionFunctionType @NonNull Function1<@NonNull ImageVector.BuilderUnit> block
)

DSL extension for adding a VectorGroup to this.

static final @NonNull ImageVector.Builder
path(
    @NonNull ImageVector.Builder receiver,
    @NonNull String name,
    Brush fill,
    float fillAlpha,
    Brush stroke,
    float strokeAlpha,
    float strokeLineWidth,
    @NonNull StrokeCap strokeLineCap,
    @NonNull StrokeJoin strokeLineJoin,
    float strokeLineMiter,
    @NonNull PathFillType pathFillType,
    @ExtensionFunctionType @NonNull Function1<@NonNull PathBuilderUnit> pathBuilder
)

DSL extension for adding a VectorPath to this.

Public methods

group

public static final @NonNull ImageVector.Builder group(
    @NonNull ImageVector.Builder receiver,
    @NonNull String name,
    float rotate,
    float pivotX,
    float pivotY,
    float scaleX,
    float scaleY,
    float translationX,
    float translationY,
    @NonNull List<@NonNull PathNode> clipPathData,
    @ExtensionFunctionType @NonNull Function1<@NonNull ImageVector.BuilderUnit> block
)

DSL extension for adding a VectorGroup to this.

See ImageVector.Builder.pushGroup for the corresponding builder function.

Parameters
@NonNull String name

the name of the group

float rotate

the rotation of the group in degrees

float pivotX

the x coordinate of the pivot point to rotate or scale the group

float pivotY

the y coordinate of the pivot point to rotate or scale the group

float scaleX

the scale factor in the X-axis to apply to the group

float scaleY

the scale factor in the Y-axis to apply to the group

float translationX

the translation in virtual pixels to apply along the x-axis

float translationY

the translation in virtual pixels to apply along the y-axis

@NonNull List<@NonNull PathNode> clipPathData

the path information used to clip the content within the group

@ExtensionFunctionType @NonNull Function1<@NonNull ImageVector.BuilderUnit> block

builder lambda to add children to this group

path

public static final @NonNull ImageVector.Builder path(
    @NonNull ImageVector.Builder receiver,
    @NonNull String name,
    Brush fill,
    float fillAlpha,
    Brush stroke,
    float strokeAlpha,
    float strokeLineWidth,
    @NonNull StrokeCap strokeLineCap,
    @NonNull StrokeJoin strokeLineJoin,
    float strokeLineMiter,
    @NonNull PathFillType pathFillType,
    @ExtensionFunctionType @NonNull Function1<@NonNull PathBuilderUnit> pathBuilder
)

DSL extension for adding a VectorPath to this.

See ImageVector.Builder.addPath for the corresponding builder function.

Parameters
@NonNull String name

the name for this path

Brush fill

specifies the Brush used to fill the path

float fillAlpha

the alpha to fill the path

Brush stroke

specifies the Brush used to fill the stroke

float strokeAlpha

the alpha to stroke the path

float strokeLineWidth

the width of the line to stroke the path

@NonNull StrokeCap strokeLineCap

specifies the linecap for a stroked path

@NonNull StrokeJoin strokeLineJoin

specifies the linejoin for a stroked path

float strokeLineMiter

specifies the miter limit for a stroked path

@ExtensionFunctionType @NonNull Function1<@NonNull PathBuilderUnit> pathBuilder

PathBuilder lambda for adding PathNodes to this path.