Project

ChartForgeX

Render deterministic charts, dashboards, topology, hierarchy, and report visuals directly from .NET.

View on GitHub Releases Get package
Stars 47
Forks 2
NuGet downloads 75,067
Release ChartForgeX-v2.0.0
Language: HTML Updated: 2026-10-12

API Reference

Class

ChartInteractionScenarioExtensions

Namespace ChartForgeX.Interactivity
Assembly ChartForgeX.Interactivity
Modifiers static

Provides fluent helpers for host-neutral interaction scenarios.

Inheritance

  • Object
  • ChartInteractionScenarioExtensions

Methods

public static ChartInteractionScenario AddAnnotationStep(ChartInteractionScenario scenario, String annotationId, String? label = null, String? description = null, Action<ChartInteractionScenarioStep>? configure = null) #
Returns: ChartInteractionScenario

Adds an ordered step that targets a rendered annotation or mark.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario requiredposition: 0
The interaction scenario.
annotationId System.String requiredposition: 1
The adapter-defined annotation id.
label System.String? = null optionalposition: 2
The optional step label.
description System.String? = null optionalposition: 3
The optional step description.
configure System.Action<ChartForgeX.Interactivity.ChartInteractionScenarioStep>? = null optionalposition: 4
Optional step configuration.

Returns

The current scenario.

public static ChartInteractionScenario AddElementStep(ChartInteractionScenario scenario, String elementId, String? label = null, String? description = null, Action<ChartInteractionScenarioStep>? configure = null) #
Returns: ChartInteractionScenario

Adds an ordered step that targets a rendered element by SVG id or adapter data id.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario requiredposition: 0
The interaction scenario.
elementId System.String requiredposition: 1
The rendered SVG id or adapter data id.
label System.String? = null optionalposition: 2
The optional step label.
description System.String? = null optionalposition: 3
The optional step description.
configure System.Action<ChartForgeX.Interactivity.ChartInteractionScenarioStep>? = null optionalposition: 4
Optional step configuration.

Returns

The current scenario.

public static ChartInteractionScenario AddLegendStep(ChartInteractionScenario scenario, String legendId, String? label = null, String? description = null, Action<ChartInteractionScenarioStep>? configure = null) #
Returns: ChartInteractionScenario

Adds an ordered step that targets a rendered legend entry.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario requiredposition: 0
legendId System.String requiredposition: 1
label System.String? = null optionalposition: 2
description System.String? = null optionalposition: 3
configure System.Action<ChartForgeX.Interactivity.ChartInteractionScenarioStep>? = null optionalposition: 4
public static ChartInteractionScenario AddLinkStep(ChartInteractionScenario scenario, String linkId, String? label = null, String? description = null, Action<ChartInteractionScenarioStep>? configure = null) #
Returns: ChartInteractionScenario

Adds an ordered step that targets a rendered hierarchy, flow, route, or relationship link.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario requiredposition: 0
linkId System.String requiredposition: 1
label System.String? = null optionalposition: 2
description System.String? = null optionalposition: 3
configure System.Action<ChartForgeX.Interactivity.ChartInteractionScenarioStep>? = null optionalposition: 4
public static ChartInteractionScenario AddNodeStep(ChartInteractionScenario scenario, String nodeId, String? label = null, String? description = null, Action<ChartInteractionScenarioStep>? configure = null) #
Returns: ChartInteractionScenario

Adds an ordered step that targets a rendered hierarchy, flow, or relationship node.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario requiredposition: 0
nodeId System.String requiredposition: 1
label System.String? = null optionalposition: 2
description System.String? = null optionalposition: 3
configure System.Action<ChartForgeX.Interactivity.ChartInteractionScenarioStep>? = null optionalposition: 4
public static ChartInteractionScenario AddPointStep(ChartInteractionScenario scenario, String pointId, String? label = null, String? description = null, Action<ChartInteractionScenarioStep>? configure = null) #
Returns: ChartInteractionScenario

Adds an ordered step that targets a rendered chart point.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario requiredposition: 0
The interaction scenario.
pointId System.String requiredposition: 1
The adapter-defined point id.
label System.String? = null optionalposition: 2
The optional step label.
description System.String? = null optionalposition: 3
The optional step description.
configure System.Action<ChartForgeX.Interactivity.ChartInteractionScenarioStep>? = null optionalposition: 4
Optional step configuration.

Returns

The current scenario.

public static ChartInteractionScenario AddRegionStep(ChartInteractionScenario scenario, String regionId, String? label = null, String? description = null, Action<ChartInteractionScenarioStep>? configure = null) #
Returns: ChartInteractionScenario

Adds an ordered step that targets a rendered map, matrix, or categorical region.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario requiredposition: 0
regionId System.String requiredposition: 1
label System.String? = null optionalposition: 2
description System.String? = null optionalposition: 3
configure System.Action<ChartForgeX.Interactivity.ChartInteractionScenarioStep>? = null optionalposition: 4
public static ChartInteractionScenario AddRoleStep(ChartInteractionScenario scenario, String role, String valueOrLabel, String? label = null, String? description = null, Action<ChartInteractionScenarioStep>? configure = null) #
Returns: ChartInteractionScenario

Adds an ordered step that targets a rendered element by role plus value or label.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario requiredposition: 0
The interaction scenario.
role System.String requiredposition: 1
The rendered element role.
valueOrLabel System.String requiredposition: 2
The rendered element value or label.
label System.String? = null optionalposition: 3
The optional step label.
description System.String? = null optionalposition: 4
The optional step description.
configure System.Action<ChartForgeX.Interactivity.ChartInteractionScenarioStep>? = null optionalposition: 5
Optional step configuration.

Returns

The current scenario.

public static ChartInteractionOptions AddScenario(ChartInteractionOptions options, String id, String label, Action<ChartInteractionScenario>? configure = null) #
Returns: ChartInteractionOptions

Adds a named scenario to the interaction options and enables scenario interactivity.

Parameters

options ChartForgeX.Interactivity.ChartInteractionOptions requiredposition: 0
The interaction options.
id System.String requiredposition: 1
The scenario id.
label System.String requiredposition: 2
The scenario label.
configure System.Action<ChartForgeX.Interactivity.ChartInteractionScenario>? = null optionalposition: 3
Optional scenario configuration.

Returns

The current interaction options.

public static ChartInteractionScenario AddSeriesStep(ChartInteractionScenario scenario, String seriesId, String? label = null, String? description = null, Action<ChartInteractionScenarioStep>? configure = null) #
Returns: ChartInteractionScenario

Adds an ordered step that targets a rendered chart series.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario requiredposition: 0
The interaction scenario.
seriesId System.String requiredposition: 1
The adapter-defined series id or zero-based series index.
label System.String? = null optionalposition: 2
The optional step label.
description System.String? = null optionalposition: 3
The optional step description.
configure System.Action<ChartForgeX.Interactivity.ChartInteractionScenarioStep>? = null optionalposition: 4
Optional step configuration.

Returns

The current scenario.

public static ChartInteractionScenario AddStep(ChartInteractionScenario scenario, String targetKind, String targetId, String? label = null, String? description = null, Action<ChartInteractionScenarioStep>? configure = null) #
Returns: ChartInteractionScenario

Adds an ordered target reference to an interaction scenario.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario requiredposition: 0
The interaction scenario.
targetKind System.String requiredposition: 1
The adapter-defined target kind.
targetId System.String requiredposition: 2
The adapter-defined target id.
label System.String? = null optionalposition: 3
The optional step label.
description System.String? = null optionalposition: 4
The optional step description.
configure System.Action<ChartForgeX.Interactivity.ChartInteractionScenarioStep>? = null optionalposition: 5
Optional step configuration.

Returns

The current scenario.

public static ChartInteractionOptions WithActiveScenario(ChartInteractionOptions options, String scenarioId) #
Returns: ChartInteractionOptions

Sets the active scenario id and enables scenario interactivity.

Parameters

options ChartForgeX.Interactivity.ChartInteractionOptions requiredposition: 0
The interaction options.
scenarioId System.String requiredposition: 1
The active scenario id.

Returns

The current interaction options.

public static ChartInteractionScenario WithColor(ChartInteractionScenario scenario, String? color) #
Returns: ChartInteractionScenario

Sets an optional scenario accent color.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario requiredposition: 0
The interaction scenario.
color System.String? requiredposition: 1
The scenario color.

Returns

The current scenario.

public static ChartInteractionOptions WithDeepLinkState(ChartInteractionOptions options, Boolean enabled = true) #
Returns: ChartInteractionOptions

Controls whether adapter state may be synchronized with a deep link.

Parameters

options ChartForgeX.Interactivity.ChartInteractionOptions requiredposition: 0
The interaction options.
enabled System.Boolean = true optionalposition: 1
Whether deep-link state is enabled.

Returns

The current interaction options.

public static ChartInteractionScenario WithDescription(ChartInteractionScenario scenario, String? description) #
Returns: ChartInteractionScenario

Sets an optional scenario description.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario requiredposition: 0
The interaction scenario.
description System.String? requiredposition: 1
The scenario description.

Returns

The current scenario.

public static ChartInteractionScenarioStep WithDuration(ChartInteractionScenarioStep step, Int32 durationMilliseconds) #
Returns: ChartInteractionScenarioStep

Overrides how long this step remains visible during timeline playback.

Parameters

step ChartForgeX.Interactivity.ChartInteractionScenarioStep requiredposition: 0
durationMilliseconds System.Int32 requiredposition: 1
public static ChartInteractionScenario WithFocusMode(ChartInteractionScenario scenario, ChartInteractionScenarioFocusMode focusMode) #
Returns: ChartInteractionScenario

Controls whether the route highlights targets or spotlights them by dimming other data marks.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario requiredposition: 0
focusMode ChartForgeX.Interactivity.ChartInteractionScenarioFocusMode requiredposition: 1
WithMetadata 2 overloads
public static ChartInteractionScenario WithMetadata(ChartInteractionScenario scenario, String key, String? value) #
Returns: ChartInteractionScenario

Adds host-readable metadata to an interaction scenario.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario requiredposition: 0
The interaction scenario.
key System.String requiredposition: 1
The metadata key.
value System.String? requiredposition: 2
The metadata value.

Returns

The current scenario.

public static ChartInteractionScenarioStep WithMetadata(ChartInteractionScenarioStep step, String key, String? value) #
Returns: ChartInteractionScenarioStep

Adds host-readable metadata to an interaction scenario step.

Parameters

step ChartForgeX.Interactivity.ChartInteractionScenarioStep requiredposition: 0
The interaction scenario step.
key System.String requiredposition: 1
The metadata key.
value System.String? requiredposition: 2
The metadata value.

Returns

The current scenario step.

public static ChartInteractionOptions WithoutActiveScenario(ChartInteractionOptions options) #
Returns: ChartInteractionOptions

Clears the active scenario id.

Parameters

options ChartForgeX.Interactivity.ChartInteractionOptions requiredposition: 0
The interaction options.

Returns

The current interaction options.

public static ChartInteractionScenario WithPlayback(ChartInteractionScenario scenario, Int32 stepDurationMilliseconds = 900, Boolean loop = false, Boolean autoPlay = false) #
Returns: ChartInteractionScenario

Configures scenario timeline playback without enabling automatic playback by default.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario requiredposition: 0
stepDurationMilliseconds System.Int32 = 900 optionalposition: 1
loop System.Boolean = false optionalposition: 2
autoPlay System.Boolean = false optionalposition: 3