Class CoverageLegendEntry

Namespace

EncDotNet.S100.Datasets.Pipelines.Portrayal

Assembly

EncDotNet.S100.Core.dll

One row of a colour fill's legend: a band colour and its label, e.g. #BDB2E3 and "2–2.5 m". A viewer shows a Legend next to the fill's layer stack entry; the headless renderer doesn't draw legends.

public sealed record CoverageLegendEntry : IEquatable<CoverageLegendEntry>

Inheritance

object

CoverageLegendEntry

Implements

IEquatable<CoverageLegendEntry>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CoverageLegendEntry(string, string)

One row of a colour fill's legend: a band colour and its label, e.g. #BDB2E3 and "2–2.5 m". A viewer shows a Legend next to the fill's layer stack entry; the headless renderer doesn't draw legends.

public CoverageLegendEntry(string Color, string Label)

Parameters

Color string

The band colour as a hex string, resolved against the palette the fill was drawn in.

Label string

The band label, e.g. "Force 3, 7–10 kn".

Properties

Color

The band colour as a hex string, resolved against the palette the fill was drawn in.

public string Color { get; init; }

Property Value

string

Label

The band label, e.g. "Force 3, 7–10 kn".

public string Label { get; init; }

Property Value

string

Methods

FromScheme(CoverageColorScheme)

The legend of a colour scheme: one entry per band, lowest first, or empty when any band has no Label (a legend with gaps would mislead).

public static IReadOnlyList<CoverageLegendEntry> FromScheme(CoverageColorScheme scheme)

Parameters

scheme CoverageColorScheme

The colour scheme, with colours already resolved.

Returns

IReadOnlyList<CoverageLegendEntry>