PlanetaryComputerModelFactory.GetLegendOptions Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Source:

PlanetaryComputerModelFactory.cs

Options for the getLegend operation.

public static Azure.Analytics.PlanetaryComputer.GetLegendOptions GetLegendOptions(string colorMapName = default, float? height = default, float? width = default, int? trimStart = default, int? trimEnd = default);

static member GetLegendOptions : string * Nullable<single> * Nullable<single> * Nullable<int> * Nullable<int> -> Azure.Analytics.PlanetaryComputer.GetLegendOptions

Public Shared Function GetLegendOptions (Optional colorMapName As String = Nothing, Optional height As Nullable(Of Single) = Nothing, Optional width As Nullable(Of Single) = Nothing, Optional trimStart As Nullable(Of Integer) = Nothing, Optional trimEnd As Nullable(Of Integer) = Nothing) As GetLegendOptions

Parameters

colorMapName

String

The name of the registered colormap to generate a legend for.

height

Nullable<Single>

The output height of the legend image.

width

Nullable<Single>

The output width of the legend image.

trimStart

Nullable<Int32>

Number of items to trim from the start of the cmap.

trimEnd

Nullable<Int32>

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

Returns

GetLegendOptions

A new GetLegendOptions instance for mocking.