PlanetaryComputerModelFactory.RenderOptionLegend Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Source:

PlanetaryComputerModelFactory.cs

Configuration for generating a data legend.

public static Azure.Analytics.PlanetaryComputer.RenderOptionLegend RenderOptionLegend(Azure.Analytics.PlanetaryComputer.LegendConfigKind? kind = default, System.Collections.Generic.IEnumerable<string> labels = default, int? trimStart = default, int? trimEnd = default, float? scaleFactor = default);

static member RenderOptionLegend : Nullable<Azure.Analytics.PlanetaryComputer.LegendConfigKind> * seq<string> * Nullable<int> * Nullable<int> * Nullable<single> -> Azure.Analytics.PlanetaryComputer.RenderOptionLegend

Public Shared Function RenderOptionLegend (Optional kind As Nullable(Of LegendConfigKind) = Nothing, Optional labels As IEnumerable(Of String) = Nothing, Optional trimStart As Nullable(Of Integer) = Nothing, Optional trimEnd As Nullable(Of Integer) = Nothing, Optional scaleFactor As Nullable(Of Single) = Nothing) As RenderOptionLegend

Parameters

kind

Nullable<LegendConfigKind>

Legend type to make, one of: continuous, classmap, interval or none (note, none is a string literal).

labels

IEnumerable<String>

Text labels to display on the legend.

trimStart

Nullable<Int32>

The number of items to trim from the start of the legend definition. Used if there are values important for rendering (e.g. nodata) that aren't desirable in the legend.

trimEnd

Nullable<Int32>

Number of items to trim from the end of the legend.

scaleFactor

Nullable<Single>

A factor to multiply interval legend labels by. Useful for scaled rasters whose colormap definitions map to unscaled values, effectively showing legend labels as scaled values.

Returns

RenderOptionLegend

A new RenderOptionLegend instance for mocking.