# 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)

*** ** * ** ***


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

<br />

*** ** * ** ***

An image which can be added to a `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Span`.

## Summary

| ### Nested types |
|---|
| `public final class https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.SpanImage.Builder` Builder for `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.SpanImage`. |

| ### Public methods |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.SpanVerticalAlignmentProp` | `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.SpanImage#getAlignment()()` Gets alignment of this image within the line height of the surrounding `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.Spannable`. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/wear/protolayout/DimensionBuilders.DpProp` | `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.SpanImage#getHeight()()` Gets the height of this image. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/wear/protolayout/ModifiersBuilders.SpanModifiers` | `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.SpanImage#getModifiers()()` Gets `https://developer.android.com/reference/androidx/wear/protolayout/ModifiersBuilders.Modifiers` for this element. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/wear/protolayout/TypeBuilders.StringProp` | `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.SpanImage#getResourceId()()` Gets the resource_id of the image to render. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/wear/protolayout/DimensionBuilders.DpProp` | `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.SpanImage#getWidth()()` Gets the width of this image. |
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/wear/protolayout/LayoutElementBuilders.SpanImage#toString()()` |

## Public methods

### getAlignment

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

```
public @Nullable LayoutElementBuilders.SpanVerticalAlignmentProp getAlignment()
```

Gets alignment of this image within the line height of the surrounding `https://developer.android.com/reference/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)

```
public @Nullable DimensionBuilders.DpProp getHeight()
```

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)

```
public @Nullable ModifiersBuilders.SpanModifiers getModifiers()
```

Gets `https://developer.android.com/reference/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)

```
public @Nullable TypeBuilders.StringProp getResourceId()
```

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)

```
public @Nullable DimensionBuilders.DpProp getWidth()
```

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

### toString

```
public @NonNull String toString()
```