LayoutElementBuilders.Image
@RequiresSchemaVersion(major = 1, minor = 0)
class LayoutElementBuilders.Image : LayoutElementBuilders.LayoutElement
An image.
Images used in this element must exist in the resource bundle that corresponds to this layout. Images must have their dimension specified, and will be rendered at this width and height, regardless of their native dimension.
Summary
Nested types |
|---|
|
Builder for |
Public functions |
|
|---|---|
LayoutElementBuilders.ColorFilter? |
Gets filtering parameters for this image. |
LayoutElementBuilders.ContentScaleModeProp? |
Gets how to scale the image resource inside the bounds specified by width/height if its size does not match those bounds. |
DimensionBuilders.ImageDimension? |
Gets the height of this image. |
ModifiersBuilders.Modifiers? |
Gets |
TypeBuilders.StringProp? |
Gets the resource_id of the image to render. |
DimensionBuilders.ImageDimension? |
getWidth()Gets the width of this image. |
String |
toString() |
Public functions
getColorFilter
fun getColorFilter(): LayoutElementBuilders.ColorFilter?
Gets filtering parameters for this image. If not specified, defaults to no filtering.
getContentScaleMode
fun getContentScaleMode(): LayoutElementBuilders.ContentScaleModeProp?
Gets how to scale the image resource inside the bounds specified by width/height if its size does not match those bounds. Defaults to CONTENT_SCALE_MODE_FIT.
getHeight
fun getHeight(): DimensionBuilders.ImageDimension?
Gets the height of this image. If not defined, the image will not be rendered.
getModifiers
fun getModifiers(): ModifiersBuilders.Modifiers?
Gets androidx.wear.protolayout.ModifiersBuilders.Modifiers for this element.
getResourceId
fun getResourceId(): TypeBuilders.StringProp?
Gets the resource_id of the image to render. This must exist in the supplied resource bundle.
getWidth
fun getWidth(): DimensionBuilders.ImageDimension?
Gets the width of this image. If not defined, the image will not be rendered.