# LayoutElementBuilders.SpanImage

# LayoutElementBuilders.SpanImage

Artifact:[androidx.wear.protolayout:protolayout](https://developer.android.com/jetpack/androidx/releases/wear-protolayout)  
[View Source](https://cs.android.com/search?q=file:androidx/wear/protolayout/LayoutElementBuilders.java+class:androidx.wear.protolayout.LayoutElementBuilders.SpanImage)  
Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.SpanImage "View this page in Java")

<br />

```
@RequiresSchemaVersion(major = 1, minor = 0)
class LayoutElementBuilders.SpanImage : LayoutElementBuilders.Span
```

<br />

*** ** * ** ***

An image which can be added to a[Span](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/LayoutElementBuilders.Span).

## Summary

|                                                                                                                                           ### Nested types                                                                                                                                            |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `class `[LayoutElementBuilders.SpanImage.Builder](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/LayoutElementBuilders.SpanImage.Builder) Builder for[SpanImage](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/LayoutElementBuilders.SpanImage). |

|                                                                              ### Public functions                                                                              |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [LayoutElementBuilders.SpanVerticalAlignmentProp](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/LayoutElementBuilders.SpanVerticalAlignmentProp)`?` | [getAlignment](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/LayoutElementBuilders.SpanImage#getAlignment())`()` Gets alignment of this image within the line height of the surrounding[Spannable](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/LayoutElementBuilders.Spannable). |
| [DimensionBuilders.DpProp](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/DimensionBuilders.DpProp)`?`                                               | [getHeight](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/LayoutElementBuilders.SpanImage#getHeight())`()` Gets the height of this image.                                                                                                                                                                     |
| [ModifiersBuilders.SpanModifiers](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/ModifiersBuilders.SpanModifiers)`?`                                 | [getModifiers](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/LayoutElementBuilders.SpanImage#getModifiers())`()` Gets[androidx.wear.protolayout.ModifiersBuilders.Modifiers](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/ModifiersBuilders.Modifiers)for this element.           |
| [TypeBuilders.StringProp](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/TypeBuilders.StringProp)`?`                                                 | [getResourceId](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/LayoutElementBuilders.SpanImage#getResourceId())`()` Gets the resource_id of the image to render.                                                                                                                                               |
| [DimensionBuilders.DpProp](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/DimensionBuilders.DpProp)`?`                                               | [getWidth](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/LayoutElementBuilders.SpanImage#getWidth())`()` Gets the width of this image.                                                                                                                                                                        |
| [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)                                                                                              | [toString](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/LayoutElementBuilders.SpanImage#toString())`()`                                                                                                                                                                                                      |

## Public functions

### getAlignment

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)  

```
fun getAlignment(): LayoutElementBuilders.SpanVerticalAlignmentProp?
```

Gets alignment of this image within the line height of the surrounding[Spannable](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/LayoutElementBuilders.Spannable). If undefined, defaults to SPAN_VERTICAL_ALIGN_BOTTOM.  

### getHeight

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)  

```
fun getHeight(): DimensionBuilders.DpProp?
```

Gets the height of this image. If not defined, the image will not be rendered.  

### getModifiers

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)  

```
fun getModifiers(): ModifiersBuilders.SpanModifiers?
```

Gets[androidx.wear.protolayout.ModifiersBuilders.Modifiers](https://developer.android.com/reference/kotlin/androidx/wear/protolayout/ModifiersBuilders.Modifiers)for this element.  

### getResourceId

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)  

```
fun getResourceId(): TypeBuilders.StringProp?
```

Gets the resource_id of the image to render. This must exist in the supplied resource bundle.  

### getWidth

Added in[1.0.0](https://developer.android.com/jetpack/androidx/releases/wear-protolayout#1.0.0)  

```
fun getWidth(): DimensionBuilders.DpProp?
```

Gets the width of this image. If not defined, the image will not be rendered.  

### toString

```
fun toString(): String
```