Image
Last updated
Last updated
⚙️ Powered by Rock RMS
Inherits from Xamarin.Forms.ContentView
If you'd like to show an animated GIF, use the default Image control instead.
One of the most common controls you'll want to use is the Image control. Because of its importance, effort has been invested into ensuring that it has all the power you need. Let's start with the basics.
Is that it? No, we're just getting started. Below are all of the properties you can add to images.
Done now? Nope, still have much more to consider.
You can apply several different transformations to your images. Each is discussed below.
You can easily add a blur to your image with this simple transformation.
Blurring is a very CPU-intensive operation. The higher the radius value the more intensive this becomes. Use caution to not over blur something dynamically when you can instead replace it with a statically blurred image. Android devices have been known to crash with radius values over 15 or so.
The circle transformation masks your images into a circle shape. The syntax for this is below.
The filter adds a customizable drop shadow to your images.
When using the drop shadow transformation be sure you do not have a background color. Otherwise, the background color will cover the drop shadow.
This fills the image with the selected color. Not sure why you'd ever use this? Well, there's a great usage for this when used with Masks on layered images.
Flips the image either horizontally, vertically, or both.
Converts the image to grayscale.
Draws a reflection of the image as if the image were sitting on a glass surface.
Rounds the corners of the image and optionally adds a border.
Tints the image using the provided color.
Keep in mind you can use more than one transformation on a single image.
Now are we done? Not quite, what's the rush?
Want to go to the next level with your images? Layer them! Look at the sample below:
To make this, simply stack the original mountain under one of our built-in Masks. Note how the mask is just a PNG with an alpha channel. Notice how the mask is black. Applying a Fill Color transformation allows us to match the tint we added to the mountain photo producing a nice color vignette effect.
While HeightRequest can be used to size images, using Ratio is preferred.
| Property | Type | Description |
|---|---|---|
| Property | Type | Description |
|---|---|---|
| Property | Type | Description |
|---|---|---|
| Property | Type | Description |
|---|---|---|
| Property | Type | Description |
|---|---|---|
| Property | Type | Description |
|---|---|---|
| Property | Type | Description |
|---|---|---|
| Property | Type | Description |
|---|---|---|
| Property | Type | Description |
|---|---|---|
| Property | Type | Description |
|---|---|---|
Aspect
Aspect
Determines how the image will fill the space allotted. Valid values are:
AspectFill - Fill the space with the image, some parts of the image may be cropped.
AspectFit - Scale the image to fit the space, some parts of the space may be left empty.
Fill - Scale the image to exactly fill the space, this may warp the image.
BackgroudColor
Color
The color to use for the background. This is useful if you'd like to show a placeholder color while the image downloads.
Command
ICommand
The command to execute when the user taps on the image.
CommandParameter
object
The parameters to pass to the command when it's executed.
ErrorPlaceholder
string
The URL of the image to display if an error occurred trying to load the main image.
HeightRequest
int
The height you'd like your image to be.
WidthRequest
int
The width you'd like your image to be.
HorizontalOptions
This describes how the element is laid out horizontally within the parent , and how this element should consume leftover space on the X axis. Common values would be:
Center - centered and does not expand.
FillAndExpand - Fills the whole area.
LoadingPlaceholder
string
The URL of the image to use as a loading placeholder while the main image loads. This image will need to be loaded once and then due to caching it will be available to all Image tags.
Ratio
string
Determines the size of the image based on the width of the parent container. The format is height:width (e.g. '4:2').
Source
string
The URL of the image to be loaded and displayed.
VerticalOptions
This describes how the element is laid out vertically within the parent , and how this element should consume leftover space on the Y axis.
Margin
Thickness
Images, like most controls can have margins. This is typically note as Margin="Left,Top,Right,Bottom".
Radius
Float
The amount of blur to add.
BorderSize
int
The size of the optional border around the image.
BorderColor
Color
The color of the border around the image.
Distance
double
Determines how far the drop shadow should extend below the image.
Angle
double
Sets the direction the drop shadow should extend from.
Radius
double
Determines the level of blur the drop shadow should use.
Color
Color
The color of the drop shadow.
Opacity
double
The opacity of the shadow.
Color
Color
The color to fill the image with.
Direction
FlipDirection
Valid values include: Horizontal, Vertical or Both
Saturation
double
Determines this level of color saturation. A value of 1.0 will not change the original image. Using 0.0 will make the image fully gray scale. You can also provide -1.0 to invert the image.
Size
double
The size of the reflection.
CorderRadius
CornerRadius
You can provide a specific radius for each corner, or provide one value to be used for all of them.
BorderSize
float
The size of the border to optionally apply.
BorderColor
Color
The color of the border to apply.
Color
Color
The color to use to tint the mid-tones of the image.
