# Path

Common/All

## Functions summary

|---|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable @https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/VectorComposable https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/Path.composable#Path(kotlin.collections.List,androidx.compose.ui.graphics.PathFillType,kotlin.String,androidx.compose.ui.graphics.Brush,kotlin.Float,androidx.compose.ui.graphics.Brush,kotlin.Float,kotlin.Float,androidx.compose.ui.graphics.StrokeCap,androidx.compose.ui.graphics.StrokeJoin,kotlin.Float,kotlin.Float,kotlin.Float,kotlin.Float)( pathData: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/PathNode>, pathFillType: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/PathFillType, name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, fill: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Brush?, fillAlpha: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, stroke: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Brush?, strokeAlpha: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, strokeLineWidth: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, strokeLineCap: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/StrokeCap, strokeLineJoin: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/StrokeJoin, strokeLineMiter: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, trimPathStart: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, trimPathEnd: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, trimPathOffset: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html )` Defines a path inside a `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/VectorPainter`. | Cmn |

## Functions

### Path

Cmn Artifact: [androidx.compose.ui:ui](https://developer.android.com/jetpack/androidx/releases/compose-ui) [View Source](https://cs.android.com/search?q=file:androidx/compose/ui/graphics/vector/VectorCompose.kt+function:Path) Added in [1.10.0](https://developer.android.com/jetpack/androidx/releases/compose-ui#1.10.0)

```
@Composable
@VectorComposable
fun Path(
    pathData: List<PathNode>,
    pathFillType: PathFillType = DefaultFillType,
    name: String = DefaultPathName,
    fill: Brush? = null,
    fillAlpha: Float = 1.0f,
    stroke: Brush? = null,
    strokeAlpha: Float = 1.0f,
    strokeLineWidth: Float = DefaultStrokeLineWidth,
    strokeLineCap: StrokeCap = DefaultStrokeLineCap,
    strokeLineJoin: StrokeJoin = DefaultStrokeLineJoin,
    strokeLineMiter: Float = DefaultStrokeLineMiter,
    trimPathStart: Float = DefaultTrimPathStart,
    trimPathEnd: Float = DefaultTrimPathEnd,
    trimPathOffset: Float = DefaultTrimPathOffset
): Unit
```

Defines a path inside a `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/VectorPainter`. This is not a regular UI composable, it can only be called inside composables called from the content parameter to `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/rememberVectorPainter.composable#rememberVectorPainter(androidx.compose.ui.unit.Dp,androidx.compose.ui.unit.Dp,kotlin.Float,kotlin.Float,kotlin.String,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.BlendMode,kotlin.Function2)`.

| Parameters |
|---|---|
| `pathData: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/PathNode>` | List of `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/PathNode`s that define the path. |
| `pathFillType: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/PathFillType = DefaultFillType` | The `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/PathFillType` that specifies how to fill the path. |
| `name: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html = DefaultPathName` | Optional name of the path used when describing the vector as a string. |
| `fill: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Brush? = null` | The `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Brush` used to fill the path. |
| `fillAlpha: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html = 1.0f` | The alpha value to use for `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/package-summary#Path(kotlin.collections.List,androidx.compose.ui.graphics.PathFillType,kotlin.String,androidx.compose.ui.graphics.Brush,kotlin.Float,androidx.compose.ui.graphics.Brush,kotlin.Float,kotlin.Float,androidx.compose.ui.graphics.StrokeCap,androidx.compose.ui.graphics.StrokeJoin,kotlin.Float,kotlin.Float,kotlin.Float,kotlin.Float)`. |
| `stroke: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Brush? = null` | The `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/Brush` used to stroke the path. |
| `strokeAlpha: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html = 1.0f` | The alpha value to use for `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/package-summary#Path(kotlin.collections.List,androidx.compose.ui.graphics.PathFillType,kotlin.String,androidx.compose.ui.graphics.Brush,kotlin.Float,androidx.compose.ui.graphics.Brush,kotlin.Float,kotlin.Float,androidx.compose.ui.graphics.StrokeCap,androidx.compose.ui.graphics.StrokeJoin,kotlin.Float,kotlin.Float,kotlin.Float,kotlin.Float)`. |
| `strokeLineWidth: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html = DefaultStrokeLineWidth` | The width of the `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/package-summary#Path(kotlin.collections.List,androidx.compose.ui.graphics.PathFillType,kotlin.String,androidx.compose.ui.graphics.Brush,kotlin.Float,androidx.compose.ui.graphics.Brush,kotlin.Float,kotlin.Float,androidx.compose.ui.graphics.StrokeCap,androidx.compose.ui.graphics.StrokeJoin,kotlin.Float,kotlin.Float,kotlin.Float,kotlin.Float)`. See `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/drawscope/Stroke#width()` for details. |
| `strokeLineCap: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/StrokeCap = DefaultStrokeLineCap` | The `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/StrokeCap` of `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/package-summary#Path(kotlin.collections.List,androidx.compose.ui.graphics.PathFillType,kotlin.String,androidx.compose.ui.graphics.Brush,kotlin.Float,androidx.compose.ui.graphics.Brush,kotlin.Float,kotlin.Float,androidx.compose.ui.graphics.StrokeCap,androidx.compose.ui.graphics.StrokeJoin,kotlin.Float,kotlin.Float,kotlin.Float,kotlin.Float)`. See `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/drawscope/Stroke#cap()` for details. |
| `strokeLineJoin: https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/StrokeJoin = DefaultStrokeLineJoin` | The `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/StrokeJoin` of `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/package-summary#Path(kotlin.collections.List,androidx.compose.ui.graphics.PathFillType,kotlin.String,androidx.compose.ui.graphics.Brush,kotlin.Float,androidx.compose.ui.graphics.Brush,kotlin.Float,kotlin.Float,androidx.compose.ui.graphics.StrokeCap,androidx.compose.ui.graphics.StrokeJoin,kotlin.Float,kotlin.Float,kotlin.Float,kotlin.Float)`. See `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/drawscope/Stroke#join()` for details. |
| `strokeLineMiter: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html = DefaultStrokeLineMiter` | The stroke miter value. See `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/drawscope/Stroke#miter()` for details. |
| `trimPathStart: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html = DefaultTrimPathStart` | The fraction of the path that specifies the start of the clipped region of the path. See `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/PathMeasure#getSegment(kotlin.Float,kotlin.Float,androidx.compose.ui.graphics.Path,kotlin.Boolean)`. |
| `trimPathEnd: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html = DefaultTrimPathEnd` | The fraction of the path that specifies the end of the clipped region of the path. See `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/PathMeasure#getSegment(kotlin.Float,kotlin.Float,androidx.compose.ui.graphics.Path,kotlin.Boolean)`. |
| `trimPathOffset: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html = DefaultTrimPathOffset` | The amount to offset both `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/package-summary#Path(kotlin.collections.List,androidx.compose.ui.graphics.PathFillType,kotlin.String,androidx.compose.ui.graphics.Brush,kotlin.Float,androidx.compose.ui.graphics.Brush,kotlin.Float,kotlin.Float,androidx.compose.ui.graphics.StrokeCap,androidx.compose.ui.graphics.StrokeJoin,kotlin.Float,kotlin.Float,kotlin.Float,kotlin.Float)` and `https://developer.android.com/reference/kotlin/androidx/compose/ui/graphics/vector/package-summary#Path(kotlin.collections.List,androidx.compose.ui.graphics.PathFillType,kotlin.String,androidx.compose.ui.graphics.Brush,kotlin.Float,androidx.compose.ui.graphics.Brush,kotlin.Float,kotlin.Float,androidx.compose.ui.graphics.StrokeCap,androidx.compose.ui.graphics.StrokeJoin,kotlin.Float,kotlin.Float,kotlin.Float,kotlin.Float)`. |