RenderOption interface

Package:

@azure/planetarycomputer

Defines visualization parameters for rendering data on a map.

Properties

conditions	A list of property/value conditions that must be in the active mosaic CQL for this render option to be enabled
description	A longer description of the render option that can be used to explain its content.
id	Unique identifier for the render option.
legend	Legend configuration for this render option.
minZoom	Minimum zoom level at which to display this layer.
name	Short descriptive name for the render option.
options	A URL query-string encoded string of TiTiler rendering options. Valid only for raster-tile types. See Query Parameters.
type	The type of rendering to apply (raster or vector).
vectorOptions	Options for rendering vector tiles. Valid only for vt-polygon and vt-line types.

Property Details

conditions

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

conditions?: RenderOptionCondition[]

Property Value

RenderOptionCondition[]

description

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

description?: string

Property Value

string

id

Unique identifier for the render option.

id: string

Property Value

string

legend

Legend configuration for this render option.

legend?: RenderOptionLegend

Property Value

RenderOptionLegend

minZoom

Minimum zoom level at which to display this layer.

minZoom?: number

Property Value

number

name

Short descriptive name for the render option.

name: string

Property Value

string

options

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

See Query Parameters.

options?: string

Property Value

string

type

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

type?: string

Property Value

string

vectorOptions

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

vectorOptions?: RenderOptionVectorOptions

Property Value

RenderOptionVectorOptions