Class SfRangeNavigator

The range navigator component is quickly visualize high-level data and select a time period with a modern interface to filter data for in-depth analysis. The range navigator contains labels, ticks, and an axis line to customize its appearance.

Inheritance

System.Object

SfBaseComponent

SfDataBoundComponent

SfRangeNavigator

Inherited Members

SfBaseComponent.Dispose()

SfBaseComponent.Dispose(Boolean)

SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)

SfDataBoundComponent.DataManager

SfDataBoundComponent.MainParent

SfDataBoundComponent.SetDataManager<T>(Object)

Namespace: Syncfusion.Blazor.Charts

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfRangeNavigator : SfDataBoundComponent

Constructors

SfRangeNavigator()

Declaration

public SfRangeNavigator()

Properties

AllowIntervalData

Allow the data to be selected for that particular interval while clicking the particular label.

Declaration

public bool AllowIntervalData { get; set; }

Property Value

Type	Description
System.Boolean	true, if the interval selection between data can be enabled. Otherwise, false.

AllowSnapping

Enable snapping for range navigator sliders.

Declaration

public bool AllowSnapping { get; set; }

Property Value

Type	Description
System.Boolean	true, if the snap can be enabled. Otherwise, false. The default value is false.

AnimationDuration

It defines the duration for an animation.

Declaration

public double AnimationDuration { get; set; }

Property Value

Type	Description
System.Double	Accepts the double value that represents the duration of animation in milliseconds. The default value is 500.

ChildContent

Sets and gets the content of the UI element.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	Accepts a RenderFragment that defines the content of the UI element.

DataSource

It defines the data source for a range navigator.

Declaration

public object DataSource { get; set; }

Property Value

Type
System.Object

DisableRangeSelector

To render the period selector with out range navigator.

Declaration

public bool DisableRangeSelector { get; set; }

Property Value

Type	Description
System.Boolean	true, if the range selector can be disabled. Otherwise, false.

EnableGrouping

Enable grouping for the labels.

Declaration

public bool EnableGrouping { get; set; }

Property Value

Type	Description
System.Boolean	true, if the grouping can be enabled. Otherwise, false.

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean	true, if the right to left direction can be enabled for the component. The default value is false.

GroupBy

GroupBy property for the axis.

Declaration

public RangeIntervalType GroupBy { get; set; }

Property Value

Type	Description
RangeIntervalType	An enumeration value of type RangeIntervalType that specifies how the labels on the axis should be grouped.

Height

The height of the chart as a string accepts input both as '100px' or '100%'. If specified as '100%, range navigator renders to the full height of its parent element.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. The default value is 100%.

Id

Set and gets the id for the chart component.

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String	Accepts the string value that represents the id of the RangeNavigator component.

Interval

interval value for the axis.

Declaration

public double Interval { get; set; }

Property Value

Type	Description
System.Double	Accepts the double value that represents the interval between labels on the axis. The default value is None.

IntervalType

IntervalType for the dateTime axis.

Declaration

public RangeIntervalType IntervalType { get; set; }

Property Value

Type	Description
RangeIntervalType	One of the RangeIntervalType enumeration that specifies the type of range interval in component. The default value is Auto.

LabelFormat

Used to format the axis label that accepts any global string format like 'C', 'n1', 'P' etc. It also accepts placeholder like '{value}°C' in which value represent the axis label, e.g, 20°C.

Declaration

public string LabelFormat { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. The default value is empty.

LabelIntersectAction

Specifies, when the axis labels intersect with each other.They are, None: Shows all the labels. Hide: Hides the label when it intersects.

Declaration

public RangeLabelIntersectAction LabelIntersectAction { get; set; }

Property Value

Type	Description
RangeLabelIntersectAction	One of the RangeLabelIntersectAction enumeration values that specifies the action to be taken when labels intersect. The default value is Hide.

LabelPlacement

Gets or sets a value that indicates whether the axis label should be rendered between the ticks or on the ticks.

Declaration

public RangeSelectorLabelPlacement LabelPlacement { get; set; }

Property Value

Type	Description
RangeSelectorLabelPlacement	One of the RangeSelectorLabelPlacement enumeration that specifies how the axis label is rendered. The default mode is RangeSelectorLabelPlacement.Auto.

LabelPosition

Label positions for the axis.

Declaration

public AxisPosition LabelPosition { get; set; }

Property Value

Type	Description
AxisPosition	One of the AxisPosition enumeration that specifies the position of label in component. The default value is Outside.

LogBase

Get and sets the base value for log axis.

Declaration

public double LogBase { get; set; }

Property Value

Type	Description
System.Double	Accepts the double value that represents the base value for log axis. The default value is 10.

Maximum

Get and sets maximum value for the axis.

Declaration

public string Maximum { get; set; }

Property Value

Type	Description
System.String	Accepts the string value that represents the maximum value for the axis.

Minimum

Get and sets minimum value for the axis.

Declaration

public string Minimum { get; set; }

Property Value

Type	Description
System.String	Accepts the string value that represents the minimum value for the axis.

Query

Get and sets the query for the data source.

Declaration

public Query Query { get; set; }

Property Value

Type	Description
Query	An object of type Query that represents the query to be executed on the data source.

SecondaryLabelAlignment

It specifies the label alignment for secondary axis labels.

Declaration

public LabelAlignment SecondaryLabelAlignment { get; set; }

Property Value

Type	Description
LabelAlignment	One of the LabelAlignment enumeration that specifies the alignment of secondary label in component. The default value is Middle.

Theme

Specifies the theme for the range navigator.

Declaration

public Theme Theme { get; set; }

Property Value

Type	Description
Theme	Accepts a value from the Theme enum. The default value is Bootstrap4.

TickPosition

Specifies the tick Position for axis.

Declaration

public AxisPosition TickPosition { get; set; }

Property Value

Type	Description
AxisPosition	One of the AxisPosition enumeration that specifies the position of tick in component. The default value is Outside.

UseGroupingSeparator

Specifies whether a grouping separator should be used for a number.

Declaration

public bool UseGroupingSeparator { get; set; }

Property Value

Type	Description
System.Boolean	true, if the grouping separator can be enabled. Otherwise, false.

Value

Selected range for range navigator.

Declaration

public object Value { get; set; }

Property Value

Type
System.Object

ValueType

Get and sets the valueType for the axis.

Declaration

public RangeValueType ValueType { get; set; }

Property Value

Type	Description
RangeValueType	One of the RangeValueType enumeration that specifies the value of range in component. The default value is Double.

Width

The width of the range navigator as a string accepts input as both like '100px' or '100%'. If specified as '100%, range navigator renders to the full width of its parent element.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	Accepts the string value. The default value is 100%.

XName

It defines the xName for the range navigator.

Declaration

public string XName { get; set; }

Property Value

Type	Description
System.String	Accepts the string value.

YName

It defines the yName for the range navigator.

Declaration

public string YName { get; set; }

Property Value

Type	Description
System.String	Accepts the string value.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

ExportAsync(ExportType, String, Nullable<PdfPageOrientation>, Boolean)

The method is used to perform the export functionality for the rendered range navigator.

Declaration

public Task ExportAsync(ExportType type, string fileName, Nullable<PdfPageOrientation> orientation = null, bool allowDownload = true)

Parameters

Type	Name	Description
ExportType	type	Specifies the export type for the rendered range navigator.
System.String	fileName	Specifies the filename.
System.Nullable<Syncfusion.PdfExport.PdfPageOrientation>	orientation	Specifies the portrait or landscape orientation of the page.
System.Boolean	allowDownload	Specifies whether to download or not.

Returns

Type
System.Threading.Tasks.Task

OnAfterRenderAsync(Boolean)

Method invoked after each time the component has been rendered.

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender	Specifies the first render of the component.

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.

Overrides

SfDataBoundComponent.OnAfterRenderAsync(Boolean)

OnInitializedAsync()

Method invoked when the component is ready to start.

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.

Overrides

SfDataBoundComponent.OnInitializedAsync()

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent in the render tree and the incoming values have been assigned to properties.

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.

Overrides

SfDataBoundComponent.OnParametersSetAsync()

PrintAsync(ElementReference)

The method is used to perform the print functionality in range navigator.

Declaration

public Task PrintAsync(ElementReference elementRef = null)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.ElementReference	elementRef

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing the asynchronous operation.

RefreshAsync()

The method is used to re-render the Range Navigator.

Declaration

public Task RefreshAsync()

Returns

Type
System.Threading.Tasks.Task

ShouldRender()

Declaration

protected override bool ShouldRender()

Returns

Type
System.Boolean