Skip to content
ChartForgeX
Class

ChartMarkOptions

ChartForgeX.Core

Namespace
ChartForgeX.Core
Assembly
ChartForgeX
Modifiers
sealed

Immutable navigation, accessibility and host hooks for an authored mark, series or row.

Inheritance

  • object
  • ChartMarkOptions

Remarks

Class tokens and complete data-* names are validated and retained verbatim. Data-cfx-* is reserved. A series link is the default for its marks; an item's non-null options replace that default.

Usage

Explore 27 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters 14

Constructors

public ChartMarkOptions(string? href = null, VisualSvgLinkTarget linkTarget = SameContext, string? tooltip = null, string? accessibleLabel = null, string? cssClass = null, IReadOnlyDictionary<string, string>? dataAttributes = null, bool current = false, bool selected = false, IEnumerable<string>? keys = null, IReadOnlyDictionary<string, object>? fields = null) #

Creates detached mark metadata. Relative, fragment, HTTP, HTTPS and mailto links are accepted.

Parameters

href string? = null optional
Optional navigation address.
linkTarget ChartForgeX.Rendering.VisualSvgLinkTarget = SameContext optional
Per-link browsing context, overriding the export policy.
tooltip string? = null optional
Plain text emitted in an SVG title.
accessibleLabel string? = null optional
Explicit accessible name; otherwise a chart-generated name is used.
cssClass string? = null optional
Space-separated CSS identifier tokens, retained without rewriting.
dataAttributes System.Collections.Generic.IReadOnlyDictionary<string, string>? = null optional
Complete lowercase data-* attribute names and plain text values.
current bool = false optional
Whether this is the current item, shown with its current-state treatment.
selected bool = false optional
Whether this is the page's selected item, shown with a solid outline and aria-current. This static state does not turn navigation links into selection widgets.
keys System.Collections.Generic.IEnumerable<string>? = null optional
Record keys this mark represents, for linked views (for example grid row ids). Emitted as data-cfx-keys.
fields System.Collections.Generic.IReadOnlyDictionary<string, object>? = null optional
Field values that define this mark (for example day and kind), emitted as data-cfx-fields. Values are strings, booleans, finite numbers, UTC or local DateTime values, or DateTimeOffset values; dates become ISO 8601 instants. A series' fields are the base for its items' fields.

Properties

public IReadOnlyList<string> Keys { get; } #

Gets the detached record keys this mark represents, in authored order without duplicates.

public IReadOnlyDictionary<string, object> Fields { get; } #

Gets the detached, ordinally sorted field values; dates are normalized to ISO 8601 UTC strings.

public string? Href { get; } #

Gets the optional navigation address.

public VisualSvgLinkTarget LinkTarget { get; } #

Gets this link's browsing context.

public string? Tooltip { get; } #

Gets plain-text hover content.

public string? AccessibleLabel { get; } #

Gets the optional explicit accessible name.

public string? CssClass { get; } #

Gets validated caller class tokens without rewriting.

public IReadOnlyDictionary<string, string> DataAttributes { get; } #

Gets a detached, ordinally sorted, read-only set of complete host data-* attributes.

public bool Current { get; } #

Gets whether this is the current item.

public bool Selected { get; } #

Gets whether this is the page's selected item. Emits aria-current and a data-cfx-selected hook.