DataClient.GetLegendAsync(GetLegendOptions, RequestContext) Method
Definition
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.
[Protocol Method] Generate a legend image for a given colormap. If the colormap has non-contiguous values at the beginning or end, which aren't desired in the output image, they can be trimmed by specifying the number of values to trim.
- 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> GetLegendAsync(Azure.Analytics.PlanetaryComputer.GetLegendOptions options, Azure.RequestContext context = default);abstract member GetLegendAsync : Azure.Analytics.PlanetaryComputer.GetLegendOptions * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetLegendAsync : Azure.Analytics.PlanetaryComputer.GetLegendOptions * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>Public Overridable Function GetLegendAsync (options As GetLegendOptions, Optional context As RequestContext = Nothing) As Task(Of Response)Parameters
- options
- GetLegendOptions
The options for the getLegend request.
- context
- RequestContext
The request options, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
options is null.
Service returned a non-success status code.
