LayoutElementBuilders.Image
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. |
Public functions
fun getColorFilter(): LayoutElementBuilders.ColorFilter?
Gets filtering parameters for this image. If not specified, defaults to no filtering.
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. Intended for testing purposes only.
fun getHeight(): DimensionBuilders.ImageDimension?
Gets the height of this image. If not defined, the image will not be rendered. Intended for testing purposes only.
fun getModifiers(): ModifiersBuilders.Modifiers?
Gets androidx.wear.tiles.ModifiersBuilders.Modifiers for this element. Intended for testing purposes only.
fun getResourceId(): TypeBuilders.StringProp?
Gets the resource_id of the image to render. This must exist in the supplied resource bundle. Intended for testing purposes only.
fun getWidth(): DimensionBuilders.ImageDimension?
Gets the width of this image. If not defined, the image will not be rendered. Intended for testing purposes only.