RenderOptionLegend Class

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Source:

RenderOptionLegend.cs

Configuration for generating a data legend.

public class RenderOptionLegend : System.ClientModel.Primitives.IJsonModel<Azure.Analytics.PlanetaryComputer.RenderOptionLegend>, System.ClientModel.Primitives.IPersistableModel<Azure.Analytics.PlanetaryComputer.RenderOptionLegend>

type RenderOptionLegend = class
    interface IJsonModel<RenderOptionLegend>
    interface IPersistableModel<RenderOptionLegend>

Public Class RenderOptionLegend
Implements IJsonModel(Of RenderOptionLegend), IPersistableModel(Of RenderOptionLegend)

Inheritance

Object

RenderOptionLegend

Implements

IJsonModel<RenderOptionLegend> IPersistableModel<RenderOptionLegend> IPersistableModel<T>

Constructors

Name	Description
RenderOptionLegend()	Initializes a new instance of RenderOptionLegend.

Properties

Name	Description
Kind	Legend type to make, one of: continuous, classmap, interval or none (note, none is a string literal).
Labels	Text labels to display on the legend.
ScaleFactor	A factor to multiply interval legend labels by. Useful for scaled rasters whose colormap definitions map to unscaled values, effectively showing legend labels as scaled values.
TrimEnd	Number of items to trim from the end of the legend.
TrimStart	The number of items to trim from the start of the legend definition. Used if there are values important for rendering (e.g. nodata) that aren't desirable in the legend.

Methods

Name	Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name	Description
IJsonModel<RenderOptionLegend>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<RenderOptionLegend>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<RenderOptionLegend>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<RenderOptionLegend>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<RenderOptionLegend>.Write(ModelReaderWriterOptions)