DataClient.GetIntervalLegendAsync Method

Definition

Namespace:: Azure.Analytics.PlanetaryComputer

Assembly:: Azure.Analytics.PlanetaryComputer.dll

Package:: Azure.Analytics.PlanetaryComputer v1.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

Name	Description
GetIntervalLegendAsync(String, Nullable<Int32>, Nullable<Int32>, RequestContext)	[Protocol Method] Generate values and color swatches mapping for a given interval classmap. Returns a color map for intervals, where each interval is defined by a numeric range [min, max] representing the interval boundaries and an RGBA color [red, green, blue, alpha] associated with the interval. The response is a 2D array of interval definitions, where each element is a pair: the first element is an array of two numbers [min, max] defining the interval, and the second element is an array of four numbers [red, green, blue, alpha] defining the RGBA color. Example: [[ [-2, 0], [0, 0, 0, 0] ], [ [1, 32], [255, 255, 178, 255] ]]. This defines two intervals: [-2, 0] mapped to transparent black and [1, 32] mapped to opaque yellow. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetIntervalLegendAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)	Generate values and color swatches mapping for a given interval classmap. Returns a color map for intervals, where each interval is defined by a numeric range [min, max] representing the interval boundaries and an RGBA color [red, green, blue, alpha] associated with the interval. The response is a 2D array of interval definitions, where each element is a pair: the first element is an array of two numbers [min, max] defining the interval, and the second element is an array of four numbers [red, green, blue, alpha] defining the RGBA color. Example: [[ [-2, 0], [0, 0, 0, 0] ], [ [1, 32], [255, 255, 178, 255] ]]. This defines two intervals: [-2, 0] mapped to transparent black and [1, 32] mapped to opaque yellow.

Name

Description

GetIntervalLegendAsync(String, Nullable<Int32>, Nullable<Int32>, RequestContext)

[Protocol Method] Generate values and color swatches mapping for a given interval classmap. Returns a color map for intervals, where each interval is defined by a numeric range [min, max] representing the interval boundaries and an RGBA color [red, green, blue, alpha] associated with the interval. The response is a 2D array of interval definitions, where each element is a pair: the first element is an array of two numbers [min, max] defining the interval, and the second element is an array of four numbers [red, green, blue, alpha] defining the RGBA color. Example: [[ [-2, 0], [0, 0, 0, 0] ], [ [1, 32], [255, 255, 178, 255] ]]. This defines two intervals: [-2, 0] mapped to transparent black and [1, 32] mapped to opaque yellow.

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

GetIntervalLegendAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Generate values and color swatches mapping for a given interval classmap. Returns a color map for intervals, where each interval is defined by a numeric range [min, max] representing the interval boundaries and an RGBA color [red, green, blue, alpha] associated with the interval. The response is a 2D array of interval definitions, where each element is a pair: the first element is an array of two numbers [min, max] defining the interval, and the second element is an array of four numbers [red, green, blue, alpha] defining the RGBA color. Example: [[ [-2, 0], [0, 0, 0, 0] ], [ [1, 32], [255, 255, 178, 255] ]]. This defines two intervals: [-2, 0] mapped to transparent black and [1, 32] mapped to opaque yellow.

GetIntervalLegendAsync(String, Nullable<Int32>, Nullable<Int32>, RequestContext)

Source:: DataClient.cs

This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual System.Threading.Tasks.Task<Azure.Response> GetIntervalLegendAsync(string classmapName, int? trimStart, int? trimEnd, Azure.RequestContext context);

abstract member GetIntervalLegendAsync : string * Nullable<int> * Nullable<int> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetIntervalLegendAsync : string * Nullable<int> * Nullable<int> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetIntervalLegendAsync (classmapName As String, trimStart As Nullable(Of Integer), trimEnd As Nullable(Of Integer), context As RequestContext) As Task(Of Response)

Parameters

classmapName: String

classmap name.

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.

context: RequestContext

The request options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

classmapName is null.

ArgumentException

classmapName is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Applies to

GetIntervalLegendAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Source:: DataClient.cs

public virtual System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<System.Collections.Generic.IList<System.Collections.Generic.IList<long>>>>> GetIntervalLegendAsync(string classmapName, int? trimStart = default, int? trimEnd = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetIntervalLegendAsync : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<System.Collections.Generic.IList<System.Collections.Generic.IList<int64>>>>>
override this.GetIntervalLegendAsync : string * Nullable<int> * Nullable<int> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<System.Collections.Generic.IList<System.Collections.Generic.IList<int64>>>>>

Public Overridable Function GetIntervalLegendAsync (classmapName As String, Optional trimStart As Nullable(Of Integer) = Nothing, Optional trimEnd As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IReadOnlyList(Of IList(Of IList(Of Long)))))