Skip to content
ChartForgeX

API Reference

Class

ChartInteractionScenarioStep

Namespace ChartForgeX.Interactivity
Assembly ChartForgeX.Interactivity
Modifiers sealed

Describes one target reference inside a host-neutral interaction scenario.

Inheritance

  • Object
  • ChartInteractionScenarioStep

Usage

Explore 30 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 25

Constructors

public ChartInteractionScenarioStep() #

Properties

public String TargetKind { get; set; } #

Gets or sets the adapter-defined target kind, such as series, point, node, edge, or annotation.

public String TargetId { get; set; } #

Gets or sets the adapter-defined target identifier.

public String? Label { get; set; } #

Gets or sets an optional step label.

public String? Description { get; set; } #

Gets or sets an optional step description.

public Int32? DurationMilliseconds { get; set; } #

Gets or sets an optional playback duration that overrides the scenario default.

public Dictionary<String, String> Metadata { get; } #

Gets arbitrary step metadata for route inspectors and host adapters.

Extension Methods

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 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.