Class RangeNavigatorBuilder

Inheritance

System.Object

ControlBuilder

RangeNavigatorBuilder

Inherited Members

ControlBuilder.Context

Namespace: Syncfusion.EJ2.Charts

Assembly: Syncfusion.EJ2.dll

Syntax

public class RangeNavigatorBuilder : ControlBuilder

Constructors

RangeNavigatorBuilder()

Declaration

public RangeNavigatorBuilder()

RangeNavigatorBuilder(RangeNavigator)

Declaration

public RangeNavigatorBuilder(RangeNavigator model)

Parameters

Type	Name	Description
RangeNavigator	model

Fields

model

Declaration

public RangeNavigator model

Field Value

Type	Description
RangeNavigator

Properties

HtmlAttr

Declaration

public IDictionary<string, object> HtmlAttr { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>

ID

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

Output

Declaration

public override TextWriter Output { get; set; }

Property Value

Type	Description
System.IO.TextWriter

Overrides

ControlBuilder.Output

Methods

AllowIntervalData(Boolean)

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

Declaration

public RangeNavigatorBuilder AllowIntervalData(bool allowIntervalData = true)

Parameters

Type	Name	Description
System.Boolean	allowIntervalData

Returns

Type	Description
RangeNavigatorBuilder

AllowSnapping(Boolean)

Enable snapping for range navigator sliders.

Declaration

public RangeNavigatorBuilder AllowSnapping(bool allowSnapping = true)

Parameters

Type	Name	Description
System.Boolean	allowSnapping

Returns

Type	Description
RangeNavigatorBuilder

AnimationDuration(Double)

Duration of the animation.

Declaration

public RangeNavigatorBuilder AnimationDuration(double animationDuration)

Parameters

Type	Name	Description
System.Double	animationDuration

Returns

Type	Description
RangeNavigatorBuilder

Background(String)

The background color of the chart that accepts value in hex and rgba as a valid CSS color string.

Declaration

public RangeNavigatorBuilder Background(string background)

Parameters

Type	Name	Description
System.String	background

Returns

Type	Description
RangeNavigatorBuilder

BeforePrint(String)

Triggers before the prints gets started.

Declaration

public RangeNavigatorBuilder BeforePrint(string beforePrint)

Parameters

Type	Name	Description
System.String	beforePrint

Returns

Type	Description
RangeNavigatorBuilder

BeforeResize(String)

Triggers before window resize.

Declaration

public RangeNavigatorBuilder BeforeResize(string beforeResize)

Parameters

Type	Name	Description
System.String	beforeResize

Returns

Type	Description
RangeNavigatorBuilder

Changed(String)

Triggers after change the slider.

Declaration

public RangeNavigatorBuilder Changed(string changed)

Parameters

Type	Name	Description
System.String	changed

Returns

Type	Description
RangeNavigatorBuilder

DataSource(Action<DataManagerBuilder>)

Declaration

public RangeNavigatorBuilder DataSource(Action<DataManagerBuilder> dataSource)

Parameters

Type	Name	Description
System.Action<DataManagerBuilder>	dataSource

Returns

Type	Description
RangeNavigatorBuilder

DataSource(Object)

It defines the data source for a range navigator.

Declaration

public RangeNavigatorBuilder DataSource(object dataSource)

Parameters

Type	Name	Description
System.Object	dataSource

Returns

Type	Description
RangeNavigatorBuilder

DisableRangeSelector(Boolean)

To render the period selector with out range navigator.

Declaration

public RangeNavigatorBuilder DisableRangeSelector(bool disableRangeSelector = true)

Parameters

Type	Name	Description
System.Boolean	disableRangeSelector

Returns

Type	Description
RangeNavigatorBuilder

EnableDeferredUpdate(Boolean)

Enable deferred update for the range navigator.

Declaration

public RangeNavigatorBuilder EnableDeferredUpdate(bool enableDeferredUpdate = true)

Parameters

Type	Name	Description
System.Boolean	enableDeferredUpdate

Returns

Type	Description
RangeNavigatorBuilder

EnableGrouping(Boolean)

Enable grouping for the labels.

Declaration

public RangeNavigatorBuilder EnableGrouping(bool enableGrouping = true)

Parameters

Type	Name	Description
System.Boolean	enableGrouping

Returns

Type	Description
RangeNavigatorBuilder

EnablePersistence(Boolean)

Enable or disable persisting component's state between page reloads.

Declaration

public RangeNavigatorBuilder EnablePersistence(bool enablePersistence = true)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
RangeNavigatorBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration

public RangeNavigatorBuilder EnableRtl(bool enableRtl = true)

Parameters

Type	Name	Description
System.Boolean	enableRtl

Returns

Type	Description
RangeNavigatorBuilder

GroupBy(RangeIntervalType)

GroupBy property for the axis.

Declaration

public RangeNavigatorBuilder GroupBy(RangeIntervalType groupBy)

Parameters

Type	Name	Description
RangeIntervalType	groupBy

Returns

Type	Description
RangeNavigatorBuilder

Height(String)

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 RangeNavigatorBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height

Returns

Type	Description
RangeNavigatorBuilder

HtmlAttributes(Object)

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration

public RangeNavigatorBuilder HtmlAttributes(object htmlAttributes)

Parameters

Type	Name	Description
System.Object	htmlAttributes

Returns

Type	Description
RangeNavigatorBuilder

Interval(Double)

interval value for the axis.

Declaration

public RangeNavigatorBuilder Interval(double interval)

Parameters

Type	Name	Description
System.Double	interval

Returns

Type	Description
RangeNavigatorBuilder

IntervalType(RangeIntervalType)

IntervalType for the dateTime axis.

Declaration

public RangeNavigatorBuilder IntervalType(RangeIntervalType intervalType)

Parameters

Type	Name	Description
RangeIntervalType	intervalType

Returns

Type	Description
RangeNavigatorBuilder

LabelFormat(String)

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 RangeNavigatorBuilder LabelFormat(string labelFormat)

Parameters

Type	Name	Description
System.String	labelFormat

Returns

Type	Description
RangeNavigatorBuilder

LabelIntersectAction(RangeLabelIntersectAction)

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 RangeNavigatorBuilder LabelIntersectAction(RangeLabelIntersectAction labelIntersectAction)

Parameters

Type	Name	Description
RangeLabelIntersectAction	labelIntersectAction

Returns

Type	Description
RangeNavigatorBuilder

LabelPlacement(NavigatorPlacement)

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 RangeNavigatorBuilder LabelPlacement(NavigatorPlacement labelPlacement)

Parameters

Type	Name	Description
NavigatorPlacement	labelPlacement

Returns

Type	Description
RangeNavigatorBuilder

LabelPosition(AxisPosition)

Label positions for the axis.

Declaration

public RangeNavigatorBuilder LabelPosition(AxisPosition labelPosition)

Parameters

Type	Name	Description
AxisPosition	labelPosition

Returns

Type	Description
RangeNavigatorBuilder

LabelRender(String)

Triggers before the label rendering.

Declaration

public RangeNavigatorBuilder LabelRender(string labelRender)

Parameters

Type	Name	Description
System.String	labelRender

Returns

Type	Description
RangeNavigatorBuilder

LabelStyle(RangeNavigatorFont)

Label style for the labels.

Declaration

public RangeNavigatorBuilder LabelStyle(RangeNavigatorFont labelStyle)

Parameters

Type	Name	Description
RangeNavigatorFont	labelStyle

Returns

Type	Description
RangeNavigatorBuilder

LabelStyle(Action<RangeNavigatorFontBuilder>)

Declaration

public RangeNavigatorBuilder LabelStyle(Action<RangeNavigatorFontBuilder> labelStyle)

Parameters

Type	Name	Description
System.Action<RangeNavigatorFontBuilder>	labelStyle

Returns

Type	Description
RangeNavigatorBuilder

Load(String)

Triggers before the range navigator rendering.

Declaration

public RangeNavigatorBuilder Load(string load)

Parameters

Type	Name	Description
System.String	load

Returns

Type	Description
RangeNavigatorBuilder

Loaded(String)

Triggers after the range navigator rendering.

Declaration

public RangeNavigatorBuilder Loaded(string loaded)

Parameters

Type	Name	Description
System.String	loaded

Returns

Type	Description
RangeNavigatorBuilder

Locale(String)

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration

public RangeNavigatorBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale

Returns

Type	Description
RangeNavigatorBuilder

LogBase(Double)

base value for log axis.

Declaration

public RangeNavigatorBuilder LogBase(double logBase)

Parameters

Type	Name	Description
System.Double	logBase

Returns

Type	Description
RangeNavigatorBuilder

MajorGridLines(RangeNavigatorMajorGridLines)

MajorGridLines

Declaration

public RangeNavigatorBuilder MajorGridLines(RangeNavigatorMajorGridLines majorGridLines)

Parameters

Type	Name	Description
RangeNavigatorMajorGridLines	majorGridLines

Returns

Type	Description
RangeNavigatorBuilder

MajorGridLines(Action<RangeNavigatorMajorGridLinesBuilder>)

Declaration

public RangeNavigatorBuilder MajorGridLines(Action<RangeNavigatorMajorGridLinesBuilder> majorGridLines)

Parameters

Type	Name	Description
System.Action<RangeNavigatorMajorGridLinesBuilder>	majorGridLines

Returns

Type	Description
RangeNavigatorBuilder

MajorTickLines(RangeNavigatorMajorTickLines)

MajorTickLines

Declaration

public RangeNavigatorBuilder MajorTickLines(RangeNavigatorMajorTickLines majorTickLines)

Parameters

Type	Name	Description
RangeNavigatorMajorTickLines	majorTickLines

Returns

Type	Description
RangeNavigatorBuilder

MajorTickLines(Action<RangeNavigatorMajorTickLinesBuilder>)

Declaration

public RangeNavigatorBuilder MajorTickLines(Action<RangeNavigatorMajorTickLinesBuilder> majorTickLines)

Parameters

Type	Name	Description
System.Action<RangeNavigatorMajorTickLinesBuilder>	majorTickLines

Returns

Type	Description
RangeNavigatorBuilder

Margin(RangeNavigatorMargin)

Margin for the range navigator

Declaration

public RangeNavigatorBuilder Margin(RangeNavigatorMargin margin)

Parameters

Type	Name	Description
RangeNavigatorMargin	margin

Returns

Type	Description
RangeNavigatorBuilder

Margin(Action<RangeNavigatorMarginBuilder>)

Declaration

public RangeNavigatorBuilder Margin(Action<RangeNavigatorMarginBuilder> margin)

Parameters

Type	Name	Description
System.Action<RangeNavigatorMarginBuilder>	margin

Returns

Type	Description
RangeNavigatorBuilder

Maximum(Double)

Maximum value for the axis

Declaration

public RangeNavigatorBuilder Maximum(double maximum)

Parameters

Type	Name	Description
System.Double	maximum

Returns

Type	Description
RangeNavigatorBuilder

Maximum(String)

Maximum value for the axis

Declaration

public RangeNavigatorBuilder Maximum(string maximum)

Parameters

Type	Name	Description
System.String	maximum

Returns

Type	Description
RangeNavigatorBuilder

Minimum(Double)

Minimum value for the axis

Declaration

public RangeNavigatorBuilder Minimum(double minimum)

Parameters

Type	Name	Description
System.Double	minimum

Returns

Type	Description
RangeNavigatorBuilder

Minimum(String)

Minimum value for the axis

Declaration

public RangeNavigatorBuilder Minimum(string minimum)

Parameters

Type	Name	Description
System.String	minimum

Returns

Type	Description
RangeNavigatorBuilder

NavigatorBorder(RangeNavigatorBorder)

Options for customizing the color and width of the chart border.

Declaration

public RangeNavigatorBuilder NavigatorBorder(RangeNavigatorBorder navigatorBorder)

Parameters

Type	Name	Description
RangeNavigatorBorder	navigatorBorder

Returns

Type	Description
RangeNavigatorBuilder

NavigatorBorder(Action<RangeNavigatorBorderBuilder>)

Declaration

public RangeNavigatorBuilder NavigatorBorder(Action<RangeNavigatorBorderBuilder> navigatorBorder)

Parameters

Type	Name	Description
System.Action<RangeNavigatorBorderBuilder>	navigatorBorder

Returns

Type	Description
RangeNavigatorBuilder

NavigatorStyleSettings(RangeNavigatorStyleSettings)

Navigator style settings

Declaration

public RangeNavigatorBuilder NavigatorStyleSettings(RangeNavigatorStyleSettings navigatorStyleSettings)

Parameters

Type	Name	Description
RangeNavigatorStyleSettings	navigatorStyleSettings

Returns

Type	Description
RangeNavigatorBuilder

NavigatorStyleSettings(Action<RangeNavigatorStyleSettingsBuilder>)

Declaration

public RangeNavigatorBuilder NavigatorStyleSettings(Action<RangeNavigatorStyleSettingsBuilder> navigatorStyleSettings)

Parameters

Type	Name	Description
System.Action<RangeNavigatorStyleSettingsBuilder>	navigatorStyleSettings

Returns

Type	Description
RangeNavigatorBuilder

PeriodSelectorSettings(RangeNavigatorPeriodSelectorSettings)

Period selector settings

Declaration

public RangeNavigatorBuilder PeriodSelectorSettings(RangeNavigatorPeriodSelectorSettings periodSelectorSettings)

Parameters

Type	Name	Description
RangeNavigatorPeriodSelectorSettings	periodSelectorSettings

Returns

Type	Description
RangeNavigatorBuilder

PeriodSelectorSettings(Action<RangeNavigatorPeriodSelectorSettingsBuilder>)

Declaration

public RangeNavigatorBuilder PeriodSelectorSettings(Action<RangeNavigatorPeriodSelectorSettingsBuilder> periodSelectorSettings)

Parameters

Type	Name	Description
System.Action<RangeNavigatorPeriodSelectorSettingsBuilder>	periodSelectorSettings

Returns

Type	Description
RangeNavigatorBuilder

Query(String)

It defines the query for the data source.

Declaration

public RangeNavigatorBuilder Query(string query)

Parameters

Type	Name	Description
System.String	query

Returns

Type	Description
RangeNavigatorBuilder

Render()

Declaration

public HtmlString Render()

Returns

Type	Description
Microsoft.AspNetCore.Html.HtmlString

Resized(String)

Triggers after the range navigator resized

Declaration

public RangeNavigatorBuilder Resized(string resized)

Parameters

Type	Name	Description
System.String	resized

Returns

Type	Description
RangeNavigatorBuilder

SecondaryLabelAlignment(LabelAlignment)

It specifies the label alignment for secondary axis labels

Declaration

public RangeNavigatorBuilder SecondaryLabelAlignment(LabelAlignment secondaryLabelAlignment)

Parameters

Type	Name	Description
LabelAlignment	secondaryLabelAlignment

Returns

Type	Description
RangeNavigatorBuilder

SelectorRender(String)

Triggers before the range navigator selector rendering.

Declaration

public RangeNavigatorBuilder SelectorRender(string selectorRender)

Parameters

Type	Name	Description
System.String	selectorRender

Returns

Type	Description
RangeNavigatorBuilder

Series(Action<RangeNavigatorRangenavigatorSeriesBuilder>)

Declaration

public RangeNavigatorBuilder Series(Action<RangeNavigatorRangenavigatorSeriesBuilder> series)

Parameters

Type	Name	Description
System.Action<RangeNavigatorRangenavigatorSeriesBuilder>	series

Returns

Type	Description
RangeNavigatorBuilder

Series(List<RangeNavigatorRangenavigatorSeries>)

It defines the configuration of series in the range navigator

Declaration

public RangeNavigatorBuilder Series(List<RangeNavigatorRangenavigatorSeries> series)

Parameters

Type	Name	Description
System.Collections.Generic.List<RangeNavigatorRangenavigatorSeries>	series

Returns

Type	Description
RangeNavigatorBuilder

Skeleton(String)

Specifies the skeleton format in which the dateTime format will process.

Declaration

public RangeNavigatorBuilder Skeleton(string skeleton)

Parameters

Type	Name	Description
System.String	skeleton

Returns

Type	Description
RangeNavigatorBuilder

SkeletonType(SkeletonType)

It specifies the type of format to be used in dateTime format process.

Declaration

public RangeNavigatorBuilder SkeletonType(SkeletonType skeletonType)

Parameters

Type	Name	Description
SkeletonType	skeletonType

Returns

Type	Description
RangeNavigatorBuilder

Theme(ChartTheme)

Specifies the theme for the range navigator.

Declaration

public RangeNavigatorBuilder Theme(ChartTheme theme)

Parameters

Type	Name	Description
ChartTheme	theme

Returns

Type	Description
RangeNavigatorBuilder

TickPosition(AxisPosition)

Tick Position for the axis

Declaration

public RangeNavigatorBuilder TickPosition(AxisPosition tickPosition)

Parameters

Type	Name	Description
AxisPosition	tickPosition

Returns

Type	Description
RangeNavigatorBuilder

Tooltip(RangeNavigatorRangeTooltipSettings)

Options for customizing the tooltip of the chart.

Declaration

public RangeNavigatorBuilder Tooltip(RangeNavigatorRangeTooltipSettings tooltip)

Parameters

Type	Name	Description
RangeNavigatorRangeTooltipSettings	tooltip

Returns

Type	Description
RangeNavigatorBuilder

Tooltip(Action<RangeNavigatorRangeTooltipSettingsBuilder>)

Declaration

public RangeNavigatorBuilder Tooltip(Action<RangeNavigatorRangeTooltipSettingsBuilder> tooltip)

Parameters

Type	Name	Description
System.Action<RangeNavigatorRangeTooltipSettingsBuilder>	tooltip

Returns

Type	Description
RangeNavigatorBuilder

TooltipRender(String)

Triggers before the tooltip for series is rendered.

Declaration

public RangeNavigatorBuilder TooltipRender(string tooltipRender)

Parameters

Type	Name	Description
System.String	tooltipRender

Returns

Type	Description
RangeNavigatorBuilder

UseGroupingSeparator(Boolean)

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

Declaration

public RangeNavigatorBuilder UseGroupingSeparator(bool useGroupingSeparator = true)

Parameters

Type	Name	Description
System.Boolean	useGroupingSeparator

Returns

Type	Description
RangeNavigatorBuilder

Value(Double[])

Selected range for range navigator.

Declaration

public RangeNavigatorBuilder Value(double[] value)

Parameters

Type	Name	Description
System.Double[]	value

Returns

Type	Description
RangeNavigatorBuilder

Value(Object)

Selected range for range navigator.

Declaration

public RangeNavigatorBuilder Value(object value)

Parameters

Type	Name	Description
System.Object	value

Returns

Type	Description
RangeNavigatorBuilder

ValueType(RangeValueType)

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 RangeNavigatorBuilder ValueType(RangeValueType valueType)

Parameters

Type	Name	Description
RangeValueType	valueType

Returns

Type	Description
RangeNavigatorBuilder

Width(String)

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 RangeNavigatorBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width

Returns

Type	Description
RangeNavigatorBuilder

XName(String)

It defines the xName for the range navigator.

Declaration

public RangeNavigatorBuilder XName(string xName)

Parameters

Type	Name	Description
System.String	xName

Returns

Type	Description
RangeNavigatorBuilder

YName(String)

It defines the yName for the range navigator.

Declaration

public RangeNavigatorBuilder YName(string yName)

Parameters

Type	Name	Description
System.String	yName

Returns

Type	Description
RangeNavigatorBuilder