group

Function

Common
inline fun ImageVector.Builder.group(
    name: String = DefaultGroupName,
    rotate: Float = DefaultRotation,
    pivotX: Float = DefaultPivotX,
    pivotY: Float = DefaultPivotY,
    scaleX: Float = DefaultScaleX,
    scaleY: Float = DefaultScaleY,
    translationX: Float = DefaultTranslationX,
    translationY: Float = DefaultTranslationY,
    clipPathData: List<PathNode> = EmptyPath,
    block: ImageVector.Builder.() -> Unit,
) = apply {
    addGroup(name, rotate, pivotX, pivotY, scaleX, scaleY, translationX, translationY, clipPathData)
    block()
    clearGroup()
}

DSL extension for adding a VectorGroup to this.

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

Parameters

namethe name of the group
rotatethe rotation of the group in degrees
pivotXthe x coordinate of the pivot point to rotate or scale the group
pivotYthe y coordinate of the pivot point to rotate or scale the group
scaleXthe scale factor in the X-axis to apply to the group
scaleYthe scale factor in the Y-axis to apply to the group
translationXthe translation in virtual pixels to apply along the x-axis
translationYthe translation in virtual pixels to apply along the y-axis
clipPathDatathe path information used to clip the content within the group
blockbuilder lambda to add children to this group