Class S100RendererOptions

Namespace

EncDotNet.S100

Assembly

EncDotNet.S100.dll

Format-agnostic options controlling how a dataset is rendered (output size, colour palette, symbol/text scaling, time step, background, and instruction suppression). Format-specific options (e.g. JPEG quality) belong on the concrete renderer that produces that format.

public sealed class S100RendererOptions

Inheritance

object

S100RendererOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Background

Background fill colour. When null, an opaque white background is used.

public RgbaColor? Background { get; init; }

Property Value

RgbaColor?

Basemap

Basemap drawn beneath the chart data (issue #411). When Offline, the bundled Natural Earth 1:10m land layer is composited under the dataset, projected with the dataset's own auto-fitted viewport. Default None (no basemap; output unchanged).

public BasemapKind Basemap { get; init; }

Property Value

BasemapKind

DisplayModeId

Optional spec-native portrayal display-mode id (S-100 Part 9 §11.7) selecting among a catalogue's declared display modes; e.g. S-411 sea-ice offers concentration, stage-of-development and navigational modes over a single dataset (issue #416). null keeps each catalogue's default mode. Ignored by catalogues that do not declare the given mode.

public string? DisplayModeId { get; init; }

Property Value

string

EcdisDisplay

Cross-spec ECDIS display settings — the display category (DisplayBase / Standard / OtherInformation / All), per-spec hidden viewing groups, and hidden display planes (S-100 Part 9 §11.6-11.7). When null the dataset renders unfiltered (equivalent to All with nothing hidden). A per-spec entry in ActiveDisplayModes wins over DisplayModeId.

public EcdisDisplaySettings? EcdisDisplay { get; init; }

Property Value

EcdisDisplaySettings

Height

Output image height in pixels. Default 768.

public int Height { get; init; }

Property Value

int

HiddenCategories

Drawing-instruction categories (areas, lines, points, text) to suppress from the output. Default None.

public DrawingInstructionCategory HiddenCategories { get; init; }

Property Value

DrawingInstructionCategory

Palette

Colour palette (Day/Dusk/Night). Default Day.

public PaletteType Palette { get; init; }

Property Value

PaletteType

SymbolScale

Global symbol scale factor. Default 1.0.

public double SymbolScale { get; init; }

Property Value

double

TextScale

Global text scale factor. Default 1.0.

public double TextScale { get; init; }

Property Value

double

TimeStep

Zero-based time-step index for time-aware products (S-104, S-111); clamped to the available range and ignored by static products. Default 0.

public int TimeStep { get; init; }

Property Value

int

Width

Output image width in pixels. Default 1024.

public int Width { get; init; }

Property Value

int