PlanetaryComputerModelFactory.RenderConfiguration Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Source:

PlanetaryComputerModelFactory.cs

Defines visualization parameters for rendering data on a map.

public static Azure.Analytics.PlanetaryComputer.RenderConfiguration RenderConfiguration(string id = default, string name = default, string description = default, Azure.Analytics.PlanetaryComputer.RenderOptionKind? kind = default, string options = default, Azure.Analytics.PlanetaryComputer.RenderOptionVectorOptions vectorOptions = default, int? minZoom = default, Azure.Analytics.PlanetaryComputer.RenderOptionLegend legend = default, System.Collections.Generic.IEnumerable<Azure.Analytics.PlanetaryComputer.RenderOptionCondition> conditions = default);

static member RenderConfiguration : string * string * string * Nullable<Azure.Analytics.PlanetaryComputer.RenderOptionKind> * string * Azure.Analytics.PlanetaryComputer.RenderOptionVectorOptions * Nullable<int> * Azure.Analytics.PlanetaryComputer.RenderOptionLegend * seq<Azure.Analytics.PlanetaryComputer.RenderOptionCondition> -> Azure.Analytics.PlanetaryComputer.RenderConfiguration

Public Shared Function RenderConfiguration (Optional id As String = Nothing, Optional name As String = Nothing, Optional description As String = Nothing, Optional kind As Nullable(Of RenderOptionKind) = Nothing, Optional options As String = Nothing, Optional vectorOptions As RenderOptionVectorOptions = Nothing, Optional minZoom As Nullable(Of Integer) = Nothing, Optional legend As RenderOptionLegend = Nothing, Optional conditions As IEnumerable(Of RenderOptionCondition) = Nothing) As RenderConfiguration

Parameters

id

String

Unique identifier for the render option.

name

String

Short descriptive name for the render option.

description

String

A longer description of the render option that can be used to explain its content.

kind

Nullable<RenderOptionKind>

The type of rendering to apply (raster or vector).

options

String

A URL query-string encoded string of TiTiler rendering options. Valid only for raster-tile types. See Query Parameters.

vectorOptions

RenderOptionVectorOptions

Options for rendering vector tiles. Valid only for vt-polygon and vt-line types.

minZoom

Nullable<Int32>

Minimum zoom level at which to display this layer.

legend

RenderOptionLegend

Legend configuration for this render option.

conditions

IEnumerable<RenderOptionCondition>

A list of property/value conditions that must be in the active mosaic CQL for this render option to be enabled

Returns

RenderConfiguration

A new RenderConfiguration instance for mocking.