API Reference

Class

ChartInteractionScenario

Namespace ChartForgeX.Interactivity

Assembly ChartForgeX.Interactivity

Modifiers sealed

Describes a named interactive path, flow, or alternate analytical state for a chart adapter.

Inheritance

Object
ChartInteractionScenario

Usage

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

Returned or exposed by 31

Property ChartInteractionOptions.Scenarios
Extension method ChartInteractionScenario.AddAnnotationStep
Extension method ChartInteractionScenario.AddElementStep
Extension method ChartInteractionScenario.AddLegendStep
Extension method ChartInteractionScenario.AddLinkStep
Extension method ChartInteractionScenario.AddNodeStep
Extension method ChartInteractionScenario.AddPointStep
Extension method ChartInteractionScenario.AddRegionStep
Extension method ChartInteractionScenario.AddRoleStep
Extension method ChartInteractionScenario.AddSeriesStep
Extension method ChartInteractionScenario.AddStep
Extension method ChartInteractionScenario.WithColor
Extension method ChartInteractionScenario.WithDescription
Extension method ChartInteractionScenario.WithFocusMode
Extension method ChartInteractionScenario.WithMetadata
Extension method ChartInteractionScenario.WithPlayback
Method ChartInteractionScenarioExtensions.AddAnnotationStep
Method ChartInteractionScenarioExtensions.AddElementStep
Method ChartInteractionScenarioExtensions.AddLegendStep
Method ChartInteractionScenarioExtensions.AddLinkStep
Method ChartInteractionScenarioExtensions.AddNodeStep
Method ChartInteractionScenarioExtensions.AddPointStep
Method ChartInteractionScenarioExtensions.AddRegionStep
Method ChartInteractionScenarioExtensions.AddRoleStep
Method ChartInteractionScenarioExtensions.AddSeriesStep
Method ChartInteractionScenarioExtensions.AddStep
Method ChartInteractionScenarioExtensions.WithColor
Method ChartInteractionScenarioExtensions.WithDescription
Method ChartInteractionScenarioExtensions.WithFocusMode
Method ChartInteractionScenarioExtensions.WithMetadata
Method ChartInteractionScenarioExtensions.WithPlayback

Accepted by parameters 32

Extension method ChartInteractionOptions.AddScenario parameter configure
Extension method ChartInteractionScenario.AddAnnotationStep parameter scenario
Extension method ChartInteractionScenario.AddElementStep parameter scenario
Extension method ChartInteractionScenario.AddLegendStep parameter scenario
Extension method ChartInteractionScenario.AddLinkStep parameter scenario
Extension method ChartInteractionScenario.AddNodeStep parameter scenario
Extension method ChartInteractionScenario.AddPointStep parameter scenario
Extension method ChartInteractionScenario.AddRegionStep parameter scenario
Extension method ChartInteractionScenario.AddRoleStep parameter scenario
Extension method ChartInteractionScenario.AddSeriesStep parameter scenario
Extension method ChartInteractionScenario.AddStep parameter scenario
Extension method ChartInteractionScenario.WithColor parameter scenario
Extension method ChartInteractionScenario.WithDescription parameter scenario
Extension method ChartInteractionScenario.WithFocusMode parameter scenario
Extension method ChartInteractionScenario.WithMetadata parameter scenario
Extension method ChartInteractionScenario.WithPlayback parameter scenario
Method ChartInteractionScenarioExtensions.AddAnnotationStep parameter scenario
Method ChartInteractionScenarioExtensions.AddElementStep parameter scenario
Method ChartInteractionScenarioExtensions.AddLegendStep parameter scenario
Method ChartInteractionScenarioExtensions.AddLinkStep parameter scenario
Method ChartInteractionScenarioExtensions.AddNodeStep parameter scenario
Method ChartInteractionScenarioExtensions.AddPointStep parameter scenario
Method ChartInteractionScenarioExtensions.AddRegionStep parameter scenario
Method ChartInteractionScenarioExtensions.AddRoleStep parameter scenario
Method ChartInteractionScenarioExtensions.AddScenario parameter configure
Method ChartInteractionScenarioExtensions.AddSeriesStep parameter scenario
Method ChartInteractionScenarioExtensions.AddStep parameter scenario
Method ChartInteractionScenarioExtensions.WithColor parameter scenario
Method ChartInteractionScenarioExtensions.WithDescription parameter scenario
Method ChartInteractionScenarioExtensions.WithFocusMode parameter scenario
Method ChartInteractionScenarioExtensions.WithMetadata parameter scenario
Method ChartInteractionScenarioExtensions.WithPlayback parameter scenario

Constructors

public ChartInteractionScenario() #

Inherited Methods

Properties

public String Id { get; set; } #

Gets or sets the stable scenario identifier.

public String Label { get; set; } #

Gets or sets the scenario label shown by host controls.

public String? Description { get; set; } #

Gets or sets an optional scenario description.

public String? Color { get; set; } #

Gets or sets an optional scenario accent color.

public Int32 PlaybackDelayMilliseconds { get; set; } #

Gets or sets the default time each step remains visible during playback.

public Boolean LoopPlayback { get; set; } #

Gets or sets whether playback returns to the first step after the last step.

public Boolean AutoPlay { get; set; } #

Gets or sets whether a browser adapter may start playback automatically when motion is allowed.

public ChartInteractionScenarioFocusMode FocusMode { get; set; } #

Gets or sets how strongly non-target context is visually de-emphasized.

public List<ChartInteractionScenarioStep> Steps { get; } #

Gets ordered target references that participate in the scenario.

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

Gets arbitrary scenario metadata for host adapters.

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

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