Skip to content
ChartForgeX
Class

ChartDomRoles

ChartForgeX.Rendering

Namespace
ChartForgeX.Rendering
Assembly
ChartForgeX
Modifiers
static

Stable data-cfx-role values and data attributes that hosts may select in rendered SVG and HTML.

Inheritance

  • object
  • ChartDomRoles

Remarks

Only the names listed here are a supported contract; other roles are renderer details and can change. A renamed contract role is a breaking change and must be announced with a migration note. See docs/dom-contract.md.

Fields

public const string RoleAttribute #

The attribute that carries a role name on rendered elements.

Value: data-cfx-role
public const string LaneIdAttribute #

The attribute that carries a lane's series identifier on schedule rows, lane labels and their marks.

Value: data-cfx-lane-id
public const string LaneGroupAttribute #

The attribute that carries a group name on schedule group headers and on the rows inside that group.

Value: data-cfx-lane-group
public const string SeriesAttribute #

The series ordinal on series groups, marks and their focus targets.

Value: data-cfx-series
public const string PointAttribute #

The ordinal of a data mark within its series; elements carrying it and ChartDomRoles.SeriesAttribute are marks.

Value: data-cfx-point
public const string SeriesKeyAttribute #

The stable series identifier on series groups, marks and legend entries.

Value: data-cfx-series-key
public const string SeriesNameAttribute #

The series display name on a series group.

Value: data-cfx-series-name
public const string XAttribute #

A mark's raw category-axis coordinate (an OLE date on time axes).

Value: data-cfx-x
public const string XInstantAttribute #

A time-axis mark's coordinate as an ISO 8601 instant.

Value: data-cfx-x-instant
public const string FormattedValueAttribute #

A mark's value as the chart formats it, including its unit.

Value: data-cfx-formatted-value
public const string FormattedXAttribute #

A mark's category-axis coordinate as the axis formats it.

Value: data-cfx-formatted-x
public const string DisplayLabelAttribute #

The caption a reader sees for a mark's category: the authored label or the formatted coordinate.

Value: data-cfx-display-label
public const string RangeLabelAttribute #

A formatted interval such as "Jan 26 – May 26" on range, schedule and bucket marks.

Value: data-cfx-range-label
public const string KeysAttribute #

The record keys a mark represents, as a JSON array of strings.

Value: data-cfx-keys
public const string FieldsAttribute #

The field values that define a mark, as a JSON object of strings, numbers and booleans.

Value: data-cfx-fields
public const string EnhanceAttribute #

The root attribute written by VisualSvgOptions.WithEnhanceHooks; its value is the hook version.

Value: data-cfx-enhance
public const string ViewAttribute #

The root's view id for linked-view payloads: the export's ID namespace.

Value: data-cfx-view
public const string SizeAttribute #

The root's logical width and height, separated by a space.

Value: data-cfx-size
public const string PlotAttribute #

The root's logical plot rectangle: x, y, width and height.

Value: data-cfx-plot
public const string XDomainAttribute #

The root's category-axis domain: minimum and maximum raw coordinates.

Value: data-cfx-x-domain
public const string XKindAttribute #

The root's category-axis scale: linear, time, log or symlog.

Value: data-cfx-x-kind
public const string OrientationAttribute #

The root's orientation when categories run vertically: horizontal.

Value: data-cfx-orientation
public const string CrosshairAttribute #

Present on the root when a shared-X crosshair applies (line and area families).

Value: data-cfx-crosshair
public const string BrushAttribute #

Present on the root when dragging across a continuous X axis selects a range.

Value: data-cfx-brush
public const string MarkAttribute #

Written by enhance hooks on every interaction target in any chart family: the innermost series group that identifies one datum.

Value: data-cfx-mark
public const string BoundsAttribute #

A mark's logical semantic extent (x, y, width, height), written by enhance hooks so marks without painted geometry still have an anchor.

Value: data-cfx-bounds
public const string LegendForAttribute #

The series ordinal a legend entry controls.

Value: data-cfx-legend-for
public const string EnhanceDataAttribute #

Marks the optional <metadata> JSON data island.

Value: data-cfx-enhance-data
public const string StripAxis #

A shared-domain axis strip without plot marks or frame.

Value: strip-axis
public const string StripAxisLine #

The full-width horizontal line in an axis strip.

Value: strip-axis-line
public const string StripAxisTick #

A shared-domain tick line in an axis strip.

Value: strip-axis-tick
public const string StripAxisLabel #

A text group for an axis-strip caption.

Value: strip-axis-label
public const string ScheduleRow #

A group wrapping one schedule lane's label and summary text. It identifies the lane but is not an interaction target.

Value: schedule-row
public const string ScheduleRowLabel #

The label text of a state-timeline or Gantt-lane row.

Value: schedule-row-label
public const string LaneSummary #

The optional right-hand summary text of a schedule lane.

Value: lane-summary
public const string StateTimelineGroup #

A group header above the lanes of a state timeline.

Value: state-timeline-group
public const string GanttLaneGroup #

A group header above the lanes of a Gantt-lane chart.

Value: gantt-lane-group
public const string ScheduleGroup #

A group header in a mixed schedule that combines state lanes, Gantt lanes or ranges.

Value: schedule-group
public const string StateTimelineSegment #

A state-timeline segment target; carries the state, start, end and source metadata.

Value: state-timeline-segment
public const string StateTimelineSegmentShape #

The painted shape inside a state-timeline segment.

Value: state-timeline-segment-shape
public const string GanttLaneItem #

A Gantt-lane item target.

Value: gantt-lane-item
public const string Point #

A Cartesian data point target.

Value: point
public const string LegendEntry #

A chart legend entry; carries data-cfx-series-key and an accessible label.

Value: legend-entry
public const string AxisYLabel #

A value-axis tick label on the primary Y axis.

Value: axis-y-label
public const string TopologyNode #

A topology node.

Value: topology-node
public const string TopologyEdge #

A topology edge.

Value: topology-edge