Class RangeNavigator
Inheritance
Namespace: Syncfusion.EJ2.Charts
Assembly: Syncfusion.EJ2.dll
Syntax
public class RangeNavigator : EJTagHelper
Constructors
RangeNavigator()
Declaration
public RangeNavigator()
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 | The default value is null |
AllowSnapping
Enable snapping for range navigator sliders.
Declaration
public bool AllowSnapping { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AnimationDuration
Duration of the animation.
Declaration
public double AnimationDuration { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 500 |
Background
The background color of the chart that accepts value in hex and rgba as a valid CSS color string.
Declaration
public string Background { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforePrint
Triggers before the prints gets started.
Declaration
public string BeforePrint { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BeforeResize
Triggers before window resize.
Declaration
public string BeforeResize { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Changed
Triggers after change the slider.
Declaration
public string Changed { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
DataSource
It defines the data source for a range navigator.
Declaration
public object DataSource { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
DisableRangeSelector
To render the period selector with out range navigator.
Declaration
public bool DisableRangeSelector { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableDeferredUpdate
Enable deferred update for the range navigator.
Declaration
public bool EnableDeferredUpdate { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableGrouping
Enable grouping for the labels.
Declaration
public bool EnableGrouping { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnablePersistence
Enable or disable persisting component's state between page reloads.
Declaration
public bool EnablePersistence { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
public bool EnableRtl { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
GroupBy
GroupBy property for the axis.
Declaration
public RangeIntervalType GroupBy { get; set; }
Property Value
Type | Description |
---|---|
RangeIntervalType | The default value is RangeIntervalType.Auto |
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 | The default value is null |
HtmlAttributes
Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.
Declaration
public object HtmlAttributes { get; set; }
Property Value
Type |
---|
System.Object |
Interval
interval value for the axis.
Declaration
public double Interval { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is Double.NaN |
IntervalType
IntervalType for the dateTime axis.
Declaration
public RangeIntervalType IntervalType { get; set; }
Property Value
Type | Description |
---|---|
RangeIntervalType | The default value is RangeIntervalType.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 | The default value is "" |
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 | The default value is RangeLabelIntersectAction.Hide |
LabelPlacement
Specifies the placement of labels to the axis line. They are, betweenTicks - Render the label between the ticks. onTicks - Render the label on the ticks. auto - Render the label between or on the tick based on data.
Declaration
public NavigatorPlacement LabelPlacement { get; set; }
Property Value
Type | Description |
---|---|
NavigatorPlacement | The default value is NavigatorPlacement.Auto |
LabelPosition
Label positions for the axis.
Declaration
public AxisPosition LabelPosition { get; set; }
Property Value
Type | Description |
---|---|
AxisPosition | The default value is AxisPosition.Outside |
LabelRender
Triggers before the label rendering.
Declaration
public string LabelRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
LabelStyle
Label style for the labels.
Declaration
public RangeNavigatorFont LabelStyle { get; set; }
Property Value
Type | Description |
---|---|
RangeNavigatorFont | The default value is null |
Load
Triggers before the range navigator rendering.
Declaration
public string Load { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Loaded
Triggers after the range navigator rendering.
Declaration
public string Loaded { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Locale
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
public string Locale { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
LogBase
base value for log axis.
Declaration
public double LogBase { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 10 |
MajorGridLines
MajorGridLines
Declaration
public RangeNavigatorMajorGridLines MajorGridLines { get; set; }
Property Value
Type | Description |
---|---|
RangeNavigatorMajorGridLines | The default value is null |
MajorTickLines
MajorTickLines
Declaration
public RangeNavigatorMajorTickLines MajorTickLines { get; set; }
Property Value
Type | Description |
---|---|
RangeNavigatorMajorTickLines | The default value is null |
Margin
Margin for the range navigator
Declaration
public RangeNavigatorMargin Margin { get; set; }
Property Value
Type | Description |
---|---|
RangeNavigatorMargin | The default value is null |
Maximum
Maximum value for the axis
Declaration
public string Maximum { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Minimum
Minimum value for the axis
Declaration
public string Minimum { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
NavigatorBorder
Options for customizing the color and width of the chart border.
Declaration
public RangeNavigatorBorder NavigatorBorder { get; set; }
Property Value
Type | Description |
---|---|
RangeNavigatorBorder | The default value is null |
NavigatorStyleSettings
Navigator style settings
Declaration
public RangeNavigatorStyleSettings NavigatorStyleSettings { get; set; }
Property Value
Type | Description |
---|---|
RangeNavigatorStyleSettings | The default value is null |
PeriodSelectorSettings
Period selector settings
Declaration
public RangeNavigatorPeriodSelectorSettings PeriodSelectorSettings { get; set; }
Property Value
Type | Description |
---|---|
RangeNavigatorPeriodSelectorSettings | The default value is null |
Query
It defines the query for the data source.
Declaration
public string Query { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Resized
Triggers after the range navigator resized
Declaration
public string Resized { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
SecondaryLabelAlignment
It specifies the label alignment for secondary axis labels
Declaration
public LabelAlignment SecondaryLabelAlignment { get; set; }
Property Value
Type | Description |
---|---|
LabelAlignment | The default value is LabelAlignment.Middle |
SelectorRender
Triggers before the range navigator selector rendering.
Declaration
public string SelectorRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Series
It defines the configuration of series in the range navigator
Declaration
public List<RangeNavigatorRangenavigatorSeries> Series { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<RangeNavigatorRangenavigatorSeries> | The default value is null |
Skeleton
Specifies the skeleton format in which the dateTime format will process.
Declaration
public string Skeleton { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
SkeletonType
It specifies the type of format to be used in dateTime format process.
Declaration
public SkeletonType SkeletonType { get; set; }
Property Value
Type | Description |
---|---|
SkeletonType | The default value is SkeletonType.DateTime |
Theme
Specifies the theme for the range navigator.
Declaration
public ChartTheme Theme { get; set; }
Property Value
Type | Description |
---|---|
ChartTheme | The default value is ChartTheme.Material |
TickPosition
Tick Position for the axis
Declaration
public AxisPosition TickPosition { get; set; }
Property Value
Type | Description |
---|---|
AxisPosition | The default value is AxisPosition.Outside |
Tooltip
Options for customizing the tooltip of the chart.
Declaration
public RangeNavigatorRangeTooltipSettings Tooltip { get; set; }
Property Value
Type | Description |
---|---|
RangeNavigatorRangeTooltipSettings | The default value is null |
TooltipRender
Triggers before the tooltip for series is rendered.
Declaration
public string TooltipRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
UseGroupingSeparator
Specifies whether a grouping separator should be used for a number.
Declaration
public bool UseGroupingSeparator { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
Value
Selected range for range navigator.
Declaration
public object Value { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
ValueType
Specifies the data types that the axis can handle: Double: This type is used for rendering a numeric axis to accommodate numeric data. DateTime: This type is utilized for rendering a date-time axis to manage date-time data. Logarithmic: This type is applied for rendering a logarithmic axis to handle a wide range of values. DateTimeCategory: This type is used to render a date time category axis for managing business days.
Declaration
public RangeValueType ValueType { get; set; }
Property Value
Type | Description |
---|---|
RangeValueType | The default value is RangeValueType.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 | The default value is null |
XName
It defines the xName for the range navigator.
Declaration
public string XName { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
YName
It defines the yName for the range navigator.
Declaration
public string YName { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |