RangeNavigatorModel

23 Sep 20254 minutes to read

Interface for a class RangeNavigator

Properties

beforePrint EmitType<IPrintEventArgs>

Triggers before the prints gets started.

beforeResize EmitType<IRangeBeforeResizeEventArgs>

Triggers before window resize.

changed EmitType<IChangedEventArgs>

Triggers after change the slider.

labelRender EmitType<ILabelRenderEventsArgs>

Triggers before the label rendering.

load EmitType<IRangeLoadedEventArgs>

Triggers before the range navigator rendering.

loaded EmitType<IRangeLoadedEventArgs>

Triggers after the range navigator rendering.

resized EmitType<IResizeRangeNavigatorEventArgs>

Triggers after the range navigator resized

selectorRender EmitType<IRangeSelectorRenderEventArgs>

Triggers before the range navigator selector rendering.

tooltipRender EmitType<IRangeTooltipRenderEventArgs>

Triggers before the tooltip for series is rendered.

allowIntervalData boolean

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

allowSnapping boolean

Enable snapping for range navigator sliders.

animationDuration number

Duration of the animation.

background string

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

dataSource Object|DataManager

It defines the data source for a range navigator.

disableRangeSelector boolean

To render the period selector with out range navigator.

enableDeferredUpdate boolean

Enable deferred update for the range navigator.

enableGrouping boolean

Enable grouping for the labels.

enablePersistence boolean

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

enableRtl boolean

Enable or disable rendering component in right to left direction.

groupBy RangeIntervalType

GroupBy property for the axis.

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.

interval number

interval value for the axis.

intervalType RangeIntervalType

IntervalType for the dateTime axis.

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.

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.

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.

labelPosition AxisPosition

Label positions for the axis.

labelStyle FontModel

Label style for the labels.

locale string

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

logBase number

base value for log axis.

majorGridLines MajorGridLinesModel

MajorGridLines

majorTickLines MajorTickLinesModel

MajorTickLines

margin MarginModel

Margin for the range navigator

maximum number|Date

Maximum value for the axis

minimum number|Date

Minimum value for the axis

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

Navigator style settings

periodSelectorSettings PeriodSelectorSettingsModel

Period selector settings

query Query

It defines the query for the data source.

secondaryLabelAlignment LabelAlignment

It specifies the label alignment for secondary axis labels

series RangeNavigatorSeriesModel[]

It defines the configuration of series in the range navigator

skeleton string

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

skeletonType SkeletonType

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

theme ChartTheme

Specifies the theme for the range navigator.

tickPosition AxisPosition

Tick Position for the axis

tooltip RangeTooltipSettingsModel

Options for customizing the tooltip of the chart.

useGroupingSeparator boolean

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

value number[]|Date[]

Selected range for range navigator.

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.

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.

xName string

It defines the xName for the range navigator.

yName string

It defines the yName for the range navigator.