DimensionBuilders.ProportionalDimensionProp

Artifact: androidx.wear.protolayout:protolayout

View Source

Added in 1.0.0

---

Kotlin |Java

@RequiresSchemaVersion(major = 1, minor = 0)
class DimensionBuilders.ProportionalDimensionProp : DimensionBuilders.ImageDimension

---

A type for a dimension that scales itself proportionally to another dimension such that the aspect ratio defined by the given width and height values is preserved.

Note that the width and height are unitless; only their ratio is relevant. This allows for specifying an element's size using common ratios (e.g. width=4, height=3), or to allow an element to be resized proportionally based on the size of an underlying asset (e.g. an 800x600 image being added to a smaller container and resized accordingly).

Summary

Nested types
class DimensionBuilders.ProportionalDimensionProp.Builder Builder for ProportionalDimensionProp.

Public functions
@IntRange(from = 0) Int	getAspectRatioHeight() Gets the height to be used when calculating the aspect ratio ratio to preserve.
@IntRange(from = 0) Int	getAspectRatioWidth() Gets the width to be used when calculating the aspect ratio to preserve.
String	toString()

Public functions

getAspectRatioHeight

Added in 1.0.0

fun getAspectRatioHeight(): @IntRange(from = 0) Int

Gets the height to be used when calculating the aspect ratio ratio to preserve.

getAspectRatioWidth

Added in 1.0.0

fun getAspectRatioWidth(): @IntRange(from = 0) Int

Gets the width to be used when calculating the aspect ratio to preserve.

toString

fun toString(): String