API Reference

Class

ChartInteractionOptions

Namespace ChartForgeX.Interactivity

Assembly ChartForgeX.Interactivity

Modifiers sealed

Holds host-neutral interaction settings that can be consumed by HTML, desktop, or future interactive adapters.

Inheritance

Object
ChartInteractionOptions

Usage

Explore 21 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 13

Extension method ChartInteractionOptions.AddScenario
Extension method ChartInteractionOptions.WithActiveScenario
Extension method ChartInteractionOptions.WithDeepLinkState
Extension method ChartInteractionOptions.WithoutActiveScenario
Method ChartInteractionOptions.Disable
Method ChartInteractionOptions.Enable
Method ChartInteractionOptions.ReportReview
Method ChartInteractionScenarioExtensions.AddScenario
Method ChartInteractionScenarioExtensions.WithActiveScenario
Method ChartInteractionScenarioExtensions.WithDeepLinkState
Method ChartInteractionScenarioExtensions.WithoutActiveScenario
Property HtmlChartInteractionOptions.Interaction
Property HtmlInteractiveDashboardOptions.Interaction

Accepted by parameters 8

Extension method ChartInteractionOptions.AddScenario parameter options
Extension method ChartInteractionOptions.WithActiveScenario parameter options
Extension method ChartInteractionOptions.WithDeepLinkState parameter options
Extension method ChartInteractionOptions.WithoutActiveScenario parameter options
Method ChartInteractionScenarioExtensions.AddScenario parameter options
Method ChartInteractionScenarioExtensions.WithActiveScenario parameter options
Method ChartInteractionScenarioExtensions.WithDeepLinkState parameter options
Method ChartInteractionScenarioExtensions.WithoutActiveScenario parameter options

Constructors

public ChartInteractionOptions() #

Initializes a new instance of the ChartInteractionOptions class.

Methods

public ChartInteractionOptions Disable(ChartInteractionFeatures features) #

Returns: ChartInteractionOptions

Disables one or more interaction features.

Parameters

features ChartForgeX.Interactivity.ChartInteractionFeatures requiredposition: 0: The features to disable.

Returns

The current options instance.

public ChartInteractionOptions Enable(ChartInteractionFeatures features) #

Returns: ChartInteractionOptions

Enables one or more interaction features.

Parameters

features ChartForgeX.Interactivity.ChartInteractionFeatures requiredposition: 0: The features to enable.

Returns

The current options instance.

public Boolean HasFeature(ChartInteractionFeatures feature) #

Returns: Boolean

Determines whether the specified interaction feature is enabled.

Parameters

feature ChartForgeX.Interactivity.ChartInteractionFeatures requiredposition: 0: The interaction feature to check.

Returns

true when the feature is enabled; otherwise, false.

public static ChartInteractionOptions ReportReview() #

Returns: ChartInteractionOptions

Returns a configured copy of the default report-review interaction profile.

Returns

A new default interaction options instance.

Inherited Methods

Properties

public String? ChartId { get; set; } #

Gets or sets a stable chart identifier used by host adapters for DOM IDs, chart registries, or event routing.

public String? GroupName { get; set; } #

Gets or sets the optional synchronized-chart group name.

public List<ChartInteractionScenario> Scenarios { get; } #

Gets interaction scenarios that host adapters may expose as alternate chart paths, flows, or analytical states.

public String? ActiveScenarioId { get; set; } #

Gets or sets the initial active scenario id.

public Boolean EnableDeepLinkState { get; set; } #

Gets or sets a value indicating whether adapters may synchronize interaction state with URL or host deep links.

public ChartInteractionFeatures Features { get; set; } #

Gets or sets the enabled interaction feature flags.

Extension Methods

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