ImageBlock
class ImageBlock
A block of image sequence by certain size and aspect ratio preferences and display priority relative to other blocks such as a TextBlock. Priority is the same as defined in TextBlock.
Summary
Public constructors |
|---|
ImageBlock( |
Public properties |
|
|---|---|
AspectRatio |
The preferred aspect ratio of the images. |
List<TemplateImageWithDescription> |
The sequence of images or just one image for display. |
Int |
The display priority number relative to other blocks such as a |
ImageSize |
The preferred size type of the images. |
Public constructors
ImageBlock
ImageBlock(
images: List<TemplateImageWithDescription> = listOf(),
aspectRatio: AspectRatio = AspectRatio.Ratio1x1,
size: ImageSize = ImageSize.Undefined,
priority: @IntRange(from = 0) Int = 0
)
| Parameters | |
|---|---|
images: List<TemplateImageWithDescription> = listOf() |
The sequence of images or just one image for display. Default to empty list. |
aspectRatio: AspectRatio = AspectRatio.Ratio1x1 |
The preferred aspect ratio of the images. Default to |
size: ImageSize = ImageSize.Undefined |
The preferred size type of the images. |
priority: @IntRange(from = 0) Int = 0 |
The display priority number relative to other blocks such as a |
Public functions
Public properties
aspectRatio
val aspectRatio: AspectRatio
The preferred aspect ratio of the images. Default to AspectRatio.Ratio1x1.
images
val images: List<TemplateImageWithDescription>
The sequence of images or just one image for display. Default to empty list.
priority
val priority: Int
The display priority number relative to other blocks such as a TextBlock.