Project

ChartForgeX

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

View on GitHub Visit Website Releases Get package
Stars 45
Forks 2
NuGet downloads 48,107
Release ChartForgeX-v1.7.0
Language: HTML Updated: 2026-09-02

API Reference

Class

ChartInteractionScenarioExtensions

Namespace ChartForgeX.Interactivity

Provides fluent helpers for host-neutral interaction scenarios.

Inheritance

  • Object
  • ChartInteractionScenarioExtensions

Methods

AddAnnotationStep(ChartForgeX.Interactivity.ChartInteractionScenario scenario, System.String annotationId, System.String label, System.String description, System.Action{ChartForgeX.Interactivity.ChartInteractionScenarioStep} configure) #

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

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario required
The interaction scenario.
annotationId System.String required
The adapter-defined annotation id.
label System.String required
The optional step label.
description System.String required
The optional step description.
configure System.Action{ChartForgeX.Interactivity.ChartInteractionScenarioStep} required
Optional step configuration.

Returns

The current scenario.

AddElementStep(ChartForgeX.Interactivity.ChartInteractionScenario scenario, System.String elementId, System.String label, System.String description, System.Action{ChartForgeX.Interactivity.ChartInteractionScenarioStep} configure) #

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

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario required
The interaction scenario.
elementId System.String required
The rendered SVG id or adapter data id.
label System.String required
The optional step label.
description System.String required
The optional step description.
configure System.Action{ChartForgeX.Interactivity.ChartInteractionScenarioStep} required
Optional step configuration.

Returns

The current scenario.

AddLegendStep(ChartForgeX.Interactivity.ChartInteractionScenario arg1, System.String arg2, System.String arg3, System.String arg4, System.Action{ChartForgeX.Interactivity.ChartInteractionScenarioStep} arg5) #

Adds an ordered step that targets a rendered legend entry.

Parameters

arg1 ChartForgeX.Interactivity.ChartInteractionScenario required
arg2 System.String required
arg3 System.String required
arg4 System.String required
arg5 System.Action{ChartForgeX.Interactivity.ChartInteractionScenarioStep} required
AddLinkStep(ChartForgeX.Interactivity.ChartInteractionScenario arg1, System.String arg2, System.String arg3, System.String arg4, System.Action{ChartForgeX.Interactivity.ChartInteractionScenarioStep} arg5) #

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

Parameters

arg1 ChartForgeX.Interactivity.ChartInteractionScenario required
arg2 System.String required
arg3 System.String required
arg4 System.String required
arg5 System.Action{ChartForgeX.Interactivity.ChartInteractionScenarioStep} required
AddNodeStep(ChartForgeX.Interactivity.ChartInteractionScenario arg1, System.String arg2, System.String arg3, System.String arg4, System.Action{ChartForgeX.Interactivity.ChartInteractionScenarioStep} arg5) #

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

Parameters

arg1 ChartForgeX.Interactivity.ChartInteractionScenario required
arg2 System.String required
arg3 System.String required
arg4 System.String required
arg5 System.Action{ChartForgeX.Interactivity.ChartInteractionScenarioStep} required
AddPointStep(ChartForgeX.Interactivity.ChartInteractionScenario scenario, System.String pointId, System.String label, System.String description, System.Action{ChartForgeX.Interactivity.ChartInteractionScenarioStep} configure) #

Adds an ordered step that targets a rendered chart point.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario required
The interaction scenario.
pointId System.String required
The adapter-defined point id.
label System.String required
The optional step label.
description System.String required
The optional step description.
configure System.Action{ChartForgeX.Interactivity.ChartInteractionScenarioStep} required
Optional step configuration.

Returns

The current scenario.

AddRegionStep(ChartForgeX.Interactivity.ChartInteractionScenario arg1, System.String arg2, System.String arg3, System.String arg4, System.Action{ChartForgeX.Interactivity.ChartInteractionScenarioStep} arg5) #

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

Parameters

arg1 ChartForgeX.Interactivity.ChartInteractionScenario required
arg2 System.String required
arg3 System.String required
arg4 System.String required
arg5 System.Action{ChartForgeX.Interactivity.ChartInteractionScenarioStep} required
AddRoleStep(ChartForgeX.Interactivity.ChartInteractionScenario scenario, System.String role, System.String valueOrLabel, System.String label, System.String description, System.Action{ChartForgeX.Interactivity.ChartInteractionScenarioStep} configure) #

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

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario required
The interaction scenario.
role System.String required
The rendered element role.
valueOrLabel System.String required
The rendered element value or label.
label System.String required
The optional step label.
description System.String required
The optional step description.
configure System.Action{ChartForgeX.Interactivity.ChartInteractionScenarioStep} required
Optional step configuration.

Returns

The current scenario.

AddScenario(ChartForgeX.Interactivity.ChartInteractionOptions options, System.String id, System.String label, System.Action{ChartForgeX.Interactivity.ChartInteractionScenario} configure) #

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

Parameters

options ChartForgeX.Interactivity.ChartInteractionOptions required
The interaction options.
id System.String required
The scenario id.
label System.String required
The scenario label.
configure System.Action{ChartForgeX.Interactivity.ChartInteractionScenario} required
Optional scenario configuration.

Returns

The current interaction options.

AddSeriesStep(ChartForgeX.Interactivity.ChartInteractionScenario scenario, System.String seriesId, System.String label, System.String description, System.Action{ChartForgeX.Interactivity.ChartInteractionScenarioStep} configure) #

Adds an ordered step that targets a rendered chart series.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario required
The interaction scenario.
seriesId System.String required
The adapter-defined series id or zero-based series index.
label System.String required
The optional step label.
description System.String required
The optional step description.
configure System.Action{ChartForgeX.Interactivity.ChartInteractionScenarioStep} required
Optional step configuration.

Returns

The current scenario.

AddStep(ChartForgeX.Interactivity.ChartInteractionScenario scenario, System.String targetKind, System.String targetId, System.String label, System.String description, System.Action{ChartForgeX.Interactivity.ChartInteractionScenarioStep} configure) #

Adds an ordered target reference to an interaction scenario.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario required
The interaction scenario.
targetKind System.String required
The adapter-defined target kind.
targetId System.String required
The adapter-defined target id.
label System.String required
The optional step label.
description System.String required
The optional step description.
configure System.Action{ChartForgeX.Interactivity.ChartInteractionScenarioStep} required
Optional step configuration.

Returns

The current scenario.

WithActiveScenario(ChartForgeX.Interactivity.ChartInteractionOptions options, System.String scenarioId) #

Sets the active scenario id and enables scenario interactivity.

Parameters

options ChartForgeX.Interactivity.ChartInteractionOptions required
The interaction options.
scenarioId System.String required
The active scenario id.

Returns

The current interaction options.

WithColor(ChartForgeX.Interactivity.ChartInteractionScenario scenario, System.String color) #

Sets an optional scenario accent color.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario required
The interaction scenario.
color System.String required
The scenario color.

Returns

The current scenario.

WithDeepLinkState(ChartForgeX.Interactivity.ChartInteractionOptions options, System.Boolean enabled) #

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

Parameters

options ChartForgeX.Interactivity.ChartInteractionOptions required
The interaction options.
enabled System.Boolean required
Whether deep-link state is enabled.

Returns

The current interaction options.

WithDescription(ChartForgeX.Interactivity.ChartInteractionScenario scenario, System.String description) #

Sets an optional scenario description.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario required
The interaction scenario.
description System.String required
The scenario description.

Returns

The current scenario.

WithDuration(ChartForgeX.Interactivity.ChartInteractionScenarioStep arg1, System.Int32 arg2) #

Overrides how long this step remains visible during timeline playback.

Parameters

arg1 ChartForgeX.Interactivity.ChartInteractionScenarioStep required
arg2 System.Int32 required
WithFocusMode(ChartForgeX.Interactivity.ChartInteractionScenario arg1, ChartForgeX.Interactivity.ChartInteractionScenarioFocusMode arg2) #

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

Parameters

arg1 ChartForgeX.Interactivity.ChartInteractionScenario required
arg2 ChartForgeX.Interactivity.ChartInteractionScenarioFocusMode required
WithMetadata 2 overloads
WithMetadata(ChartForgeX.Interactivity.ChartInteractionScenario scenario, System.String key, System.String value) #

Adds host-readable metadata to an interaction scenario.

Parameters

scenario ChartForgeX.Interactivity.ChartInteractionScenario required
The interaction scenario.
key System.String required
The metadata key.
value System.String required
The metadata value.

Returns

The current scenario.

WithMetadata(ChartForgeX.Interactivity.ChartInteractionScenarioStep step, System.String key, System.String value) #

Adds host-readable metadata to an interaction scenario step.

Parameters

step ChartForgeX.Interactivity.ChartInteractionScenarioStep required
The interaction scenario step.
key System.String required
The metadata key.
value System.String required
The metadata value.

Returns

The current scenario step.

WithoutActiveScenario(ChartForgeX.Interactivity.ChartInteractionOptions options) #

Clears the active scenario id.

Parameters

options ChartForgeX.Interactivity.ChartInteractionOptions required
The interaction options.

Returns

The current interaction options.

WithPlayback(ChartForgeX.Interactivity.ChartInteractionScenario arg1, System.Int32 arg2, System.Boolean arg3, System.Boolean arg4) #

Configures scenario timeline playback without enabling automatic playback by default.

Parameters

arg1 ChartForgeX.Interactivity.ChartInteractionScenario required
arg2 System.Int32 required
arg3 System.Boolean required
arg4 System.Boolean required