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

object

ComponentBase

OwningComponentBase

SfOwningComponentBase

SfBaseComponent

SfDataBoundComponent

SfRangeNavigator

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

Inherited Members

ComponentBase.Assets

ComponentBase.AssignedRenderMode

ComponentBase.DispatchExceptionAsync(Exception)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.OnAfterRender(bool)

ComponentBase.OnInitialized()

ComponentBase.OnParametersSet()

ComponentBase.RendererInfo

ComponentBase.SetParametersAsync(ParameterView)

ComponentBase.ShouldRender()

ComponentBase.StateHasChanged()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

OwningComponentBase.IsDisposed

OwningComponentBase.ScopedServices

SfBaseComponent.Dispose()

SfBaseComponent.Dispose(bool)

SfBaseComponent.GetEffectivePlatform()

SfBaseComponent.GetMainComponentPlatform()

SfBaseComponent.IsMainLicenseComponent()

SfBaseComponent.LicenseContext

SfBaseComponent.OnObservableChange(string, object, bool, NotifyCollectionChangedEventArgs)

SfBaseComponent.ValidateLicense()

SfDataBoundComponent.DataManager

SfDataBoundComponent.MainParent

SfDataBoundComponent.OnAfterRenderAsync(bool)

SfDataBoundComponent.OnInitializedAsync()

SfDataBoundComponent.OnParametersSetAsync()

SfDataBoundComponent.SetDataManager<T>(object)

Namespace: Syncfusion.Blazor.Charts

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfRangeNavigator : SfDataBoundComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

SfRangeNavigator()

Declaration

public SfRangeNavigator()

Properties

AllowIntervalData

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

Declaration

[Parameter]
public bool AllowIntervalData { get; set; }

Property Value

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

AllowSnapping

Enable snapping for range navigator sliders.

Declaration

[Parameter]
public bool AllowSnapping { get; set; }

Property Value

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

AnimationDuration

It defines the duration for an animation.

Declaration

[Parameter]
public double AnimationDuration { get; set; }

Property Value

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

DataSource

It defines the data source for a range navigator.

Declaration

[Parameter]
public object DataSource { get; set; }

Property Value

Type
object

DisableRangeSelector

To render the period selector with out range navigator.

Declaration

[Parameter]
public bool DisableRangeSelector { get; set; }

Property Value

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

EnableGrouping

Enable grouping for the labels.

Declaration

[Parameter]
public bool EnableGrouping { get; set; }

Property Value

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

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

[Parameter]
public bool EnableRtl { get; set; }

Property Value

Type	Description
bool	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

[Parameter]
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

[Parameter]
public string Height { get; set; }

Property Value

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

Id

Set and gets the id for the chart component.

Declaration

[Parameter]
public string Id { get; set; }

Property Value

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

Interval

interval value for the axis.

Declaration

[Parameter]
public double Interval { get; set; }

Property Value

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

[Parameter]
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

[Parameter]
public string LabelFormat { get; set; }

Property Value

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

[Parameter]
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

[Parameter]
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

[Parameter]
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

[Parameter]
public double LogBase { get; set; }

Property Value

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

[Parameter]
public string Maximum { get; set; }

Property Value

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

Minimum

Get and sets minimum value for the axis.

Declaration

[Parameter]
public string Minimum { get; set; }

Property Value

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

Query

Get and sets the query for the data source.

Declaration

[Parameter]
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

[Parameter]
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

[Parameter]
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

[Parameter]
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

[Parameter]
public bool UseGroupingSeparator { get; set; }

Property Value

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

Value

Selected range for range navigator.

Declaration

[Parameter]
public object Value { get; set; }

Property Value

Type
object

ValueType

Get and sets the valueType for the axis.

Declaration

[Parameter]
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

[Parameter]
public string Width { get; set; }

Property Value

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

XName

It defines the xName for the range navigator.

Declaration

[Parameter]
public string XName { get; set; }

Property Value

Type	Description
string	Accepts the string value.

YName

It defines the yName for the range navigator.

Declaration

[Parameter]
public string YName { get; set; }

Property Value

Type	Description
string	Accepts the string value.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
RenderTreeBuilder	__builder

Overrides

ComponentBase.BuildRenderTree(RenderTreeBuilder)

ExportAsync(ExportType, string, PdfPageOrientation?, bool)

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

Declaration

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

Parameters

Type	Name	Description
ExportType	type	Specifies the export type for the rendered range navigator.
string	fileName	Specifies the filename.
PdfPageOrientation?	orientation	Specifies the portrait or landscape orientation of the page.
bool	allowDownload	Specifies whether to download or not.

Returns

Type
Task

PrintAsync(ElementReference)

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

Declaration

public Task PrintAsync(ElementReference elementRef = default)

Parameters

Type	Name	Description
ElementReference	elementRef

Returns

Type	Description
Task	A Task representing the asynchronous operation.

RefreshAsync()

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

Declaration

public Task RefreshAsync()

Returns

Type
Task

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable