LegendItem.GetImage Methods
Saves the image to a memory buffer in PNG format.
Overload List
| Name | Description | |
|---|---|---|
| Public method | GetImage(System.Int32 desiredWidth, System.Int32 desiredHeight) | Saves the image to a memory buffer in PNG format. |
| Public method | GetImage(System.Int32 desiredWidth, System.Int32 desiredHeight, System.Double pixelSize, PixelSizeAdjustments pixelSizeAdjustments) | Saves the image to a memory buffer in PNG format, using the specified pixel size and rendering scale factors. |
GetImage(System.Int32 desiredWidth, System.Int32 desiredHeight)
Saves the image to a memory buffer in PNG format.Syntax
public System.IO.Stream GetImage (
System.Int32 desiredWidth,
System.Int32 desiredHeight
)Parameters
A default image width, used if the width of this item is zero.
A default image height, used if the height of this item is zero.
Return Value
The image of the legend item, in the PNG format.
Remarks
If you have a Legend object, and your application calls GetImage for each of its items, then the desiredWidth and desiredHeight should be equal to the Legend.ItemWidth and the Legend.ItemHeight of the Legend. This will cause the generated images to appear the same as if the Legend was used as a ScreenLayer element.
GetImage(System.Int32 desiredWidth, System.Int32 desiredHeight, System.Double pixelSize, PixelSizeAdjustments pixelSizeAdjustments)
Saves the image to a memory buffer in PNG format, using the specified pixel size and rendering scale factors.Syntax
public System.IO.Stream GetImage (
System.Int32 desiredWidth,
System.Int32 desiredHeight,
System.Double pixelSize,
PixelSizeAdjustments pixelSizeAdjustments
)Parameters
A default image width, used if the width of this item is zero.
A default image height, used if the height of this item is zero.
The pixel size the image should be displayed in.
Scale factors applied when rendering the image.
Return Value
The image of the legend item, in the PNG format.
Remarks
This overload can be used to generate an image from the legend item suitable for display on a device with a different DPI than the screen where the application is running. The pixelSize and pixelSizeAdjustments parameters are passed to the drawable used for rendering the image, see Drawable.PixelSize and Drawable.PixelSizeAdjustments for more information.
The desiredWidth and desiredHeight parameters are used only if the Width and Height properties are zero. Either way, the size of the generated image is determined by multiplying the width and height values with PixelSizeAdjustments.SymbolScaleFactor.
Platforms
Windows, Linux, Android