Class
ChartPannable

Configures chart panning functionality to enable interactive chart navigation. Allows users to pan (scroll) through chart data by dragging the chart plot area, providing smooth data exploration for large datasets. Supports keyboard modifiers and axis locking to control panning behavior and enhance user experience.

Definition

Constructors

ChartPannable()

Declaration

cs-api-definition
public ChartPannable()

Properties

ChildContent

Declaration

cs-api-definition
[Parameter]
public RenderFragment ChildContent { get; set; }

Property Value

RenderFragment

Enabled

Enables or disables chart panning functionality. When true, users can drag the chart plot area to navigate through data, providing smooth scrolling for large datasets. When false, panning is disabled and the chart remains static. Default behavior depends on chart configuration and data size.

Declaration

cs-api-definition
[Parameter]
public bool? Enabled { get; set; }

Property Value

bool?

Key

Specifies the keyboard modifier key that must be pressed to activate panning. Use ChartPannableKey values like Ctrl, Alt, or Shift to prevent accidental panning during other interactions. When set, users must hold the specified key while dragging to pan the chart.

Declaration

cs-api-definition
[Parameter]
public ChartPannableKey? Key { get; set; }

Property Value

ChartPannableKey?

Lock

Restricts panning to specific chart axes using ChartAxisLock values. Set to prevent panning along certain axes (X, Y, or both) to maintain data context or enforce specific navigation patterns. Useful for time-series charts where only horizontal scrolling is desired.

Declaration

cs-api-definition
[Parameter]
public ChartAxisLock? Lock { get; set; }

Property Value

ChartAxisLock?

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition
protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

OnAfterRender(bool)

Declaration

cs-api-definition
protected override void OnAfterRender(bool firstRender)

Parameters

firstRender

bool

Overrides ComponentBase.OnAfterRender(bool)

OnInitialized()

Declaration

cs-api-definition
protected override void OnInitialized()

Overrides DataVizChildComponent.OnInitialized()

OnParametersSet()

Declaration

cs-api-definition
protected override void OnParametersSet()

Overrides ComponentBase.OnParametersSet()

Serialize()

Declaration

cs-api-definition
public Dictionary<string, object> Serialize()

Returns

Dictionary<string, object>