dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Model

ScreenshotOptions Class

Options for taking a screenshot

public class ScreenshotOptions :
System.IEquatable<dymaptic.GeoBlazor.Core.Model.ScreenshotOptions>

Inheritance System.Object 🡒 ScreenshotOptions

Implements System.IEquatable<ScreenshotOptions>

Constructors

ScreenshotOptions() Constructor

public ScreenshotOptions();

Properties

ScreenshotOptions.Area Property

The area of the view to take a screenshot of.

public dymaptic.GeoBlazor.Core.Model.ScreenshotArea? Area { get; set; }

Property Value

ScreenshotArea

ScreenshotOptions.Format Property

The format of the resulting encoded data url.

public System.Nullable<dymaptic.GeoBlazor.Core.Model.ScreenshotFormat> Format { get; set; }

Property Value

System.Nullable<ScreenshotFormat>

ScreenshotOptions.Height Property

The height of the screenshot (defaults to the area height). The width will be derived automatically if left unspecified, according to the aspect ratio of the screenshot area.

public System.Nullable<int> Height { get; set; }

Property Value

System.Nullable<System.Int32>

ScreenshotOptions.IgnoreBackground Property

Indicates whether to ignore the background color set in the initial view properties of the web map.

public System.Nullable<bool> IgnoreBackground { get; set; }

Property Value

System.Nullable<System.Boolean>

ScreenshotOptions.IgnorePadding Property

Indicates whether view padding should be ignored. Set this property to true to allow padded areas to be included in the screenshot.

public System.Nullable<bool> IgnorePadding { get; set; }

Property Value

System.Nullable<System.Boolean>

ScreenshotOptions.LayerIds Property

When used, only the visible layers with Ids in this list will be included in the output.

public System.Collections.Generic.IReadOnlyCollection<System.Guid>? LayerIds { get; set; }

Property Value

System.Collections.Generic.IReadOnlyCollection<System.Guid>

ScreenshotOptions.Quality Property

The quality (0 to 100) of the encoded image when encoding as jpg.

public System.Nullable<int> Quality { get; set; }

Property Value

System.Nullable<System.Int32>

ScreenshotOptions.Width Property

The width of the screenshot (defaults to the area width). The height will be derived automatically if left unspecified, according to the aspect ratio of the of the screenshot area.

public System.Nullable<int> Width { get; set; }

Property Value

System.Nullable<System.Int32>