/** * DevExtreme (viz/range_selector.d.ts) * Version: 21.2.4 * Build date: Mon Dec 06 2021 * * Copyright (c) 2012 - 2021 Developer Express Inc. ALL RIGHTS RESERVED * Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/ */ import DataSource, { DataSourceLike } from '../data/data_source'; import { PaletteType, PaletteExtensionModeType, } from './palette'; import { EventInfo, NativeEventInfo, InitializedEventInfo, ChangedOptionInfo, } from '../events/index'; import { Format, } from '../localization'; import { dxChartCommonSeriesSettings, } from './chart'; import { ChartSeries, ScaleBreak, VizRange, VizTimeInterval, } from './common'; import BaseWidget, { BaseWidgetOptions, BaseWidgetTooltip, Font, FileSavingEventInfo, ExportInfo, IncidentInfo, } from './core/base_widget'; export type DisposingEvent = EventInfo; export type DrawnEvent = EventInfo; export type ExportedEvent = EventInfo; export type ExportingEvent = EventInfo & ExportInfo; export type FileSavingEvent = FileSavingEventInfo; export type IncidentOccurredEvent = EventInfo & IncidentInfo; export type InitializedEvent = InitializedEventInfo; export type OptionChangedEvent = EventInfo & ChangedOptionInfo; export type ValueChangedEvent = NativeEventInfo & { readonly value: Array; readonly previousValue: Array; }; /** * @deprecated use Properties instead * @deprecated Attention! This type is for internal purposes only. If you used it previously, please describe your scenario in the following GitHub Issue, and we will suggest a public alternative: {@link https://github.com/DevExpress/DevExtreme/issues/17885|Internal Types}. */ export interface dxRangeSelectorOptions extends BaseWidgetOptions { /** * Specifies the properties for the range selector's background. */ background?: { /** * Specifies the background color for the RangeSelector. */ color?: string; /** * Specifies image properties. */ image?: { /** * Specifies a location for the image in the background of a range selector. */ location?: 'center' | 'centerBottom' | 'centerTop' | 'full' | 'leftBottom' | 'leftCenter' | 'leftTop' | 'rightBottom' | 'rightCenter' | 'rightTop'; /** * Specifies the image's URL. */ url?: string; }; /** * Indicates whether or not the background (background color and/or image) is visible. */ visible?: boolean; }; /** * Specifies the RangeSelector's behavior properties. */ behavior?: { /** * Indicates whether or not you can swap sliders. */ allowSlidersSwap?: boolean; /** * Indicates whether or not animation is enabled. */ animationEnabled?: boolean; /** * Specifies when to call the onValueChanged function. */ callValueChanged?: 'onMoving' | 'onMovingComplete'; /** * Indicates whether or not an end user can specify the range using a mouse, without the use of sliders. */ manualRangeSelectionEnabled?: boolean; /** * Indicates whether or not an end user can shift the selected range to the required location on a scale by clicking. */ moveSelectedRangeByClick?: boolean; /** * Indicates whether to snap a slider to ticks. */ snapToTicks?: boolean; }; /** * Specifies the properties required to display a chart as the range selector's background. */ chart?: { /** * Controls the padding and consequently the width of a group of bars with the same argument using relative units. Ignored if the barGroupWidth property is set. */ barGroupPadding?: number; /** * Specifies a fixed width for groups of bars with the same argument, measured in pixels. Takes precedence over the barGroupPadding property. */ barGroupWidth?: number; /** * Specifies an indent from the background's bottom to the lowest chart point. Accepts values from 0 to 1. */ bottomIndent?: number; /** * An object defining the common configuration properties for the chart's series. */ commonSeriesSettings?: dxChartCommonSeriesSettings; /** * An object providing properties for managing data from a data source. */ dataPrepareSettings?: { /** * Specifies whether or not to validate values from a data source. */ checkTypeForAllData?: boolean; /** * Specifies whether or not to convert the values from a data source into the data type of an axis. */ convertToAxisDataType?: boolean; /** * Specifies how to sort series points. */ sortingMethod?: boolean | ((a: { arg?: Date | number | string; val?: Date | number | string }, b: { arg?: Date | number | string; val?: Date | number | string }) => number); }; /** * Specifies a coefficient that determines the diameter of the largest bubble. */ maxBubbleSize?: number; /** * Specifies the diameter of the smallest bubble measured in pixels. */ minBubbleSize?: number; /** * Forces the UI component to treat negative values as zeroes. Applies to stacked-like series only. */ negativesAsZeroes?: boolean; /** * Sets the palette to be used to colorize series in the chart. */ palette?: Array | PaletteType; /** * Specifies what to do with colors in the palette when their number is less than the number of series in the chart. */ paletteExtensionMode?: PaletteExtensionModeType; /** * An object defining the chart's series. */ series?: ChartSeries | Array; /** * Defines properties for the series template. */ seriesTemplate?: { /** * Specifies a callback function that returns a series object with individual series settings. */ customizeSeries?: ((seriesName: any) => ChartSeries); /** * Specifies a data source field that represents the series name. */ nameField?: string; }; /** * Specifies an indent from the background's top to the topmost chart point. Accepts values from 0 to 1. */ topIndent?: number; /** * Configures the chart value axis. */ valueAxis?: { /** * Indicates whether or not the chart's value axis must be inverted. */ inverted?: boolean; /** * Specifies the value to be raised to a power when generating ticks for a logarithmic value axis. */ logarithmBase?: number; /** * Specifies the maximum value of the chart's value axis. */ max?: number; /** * Specifies the minimum value of the chart's value axis. */ min?: number; /** * Specifies the type of the value axis. */ type?: 'continuous' | 'logarithmic'; /** * Specifies the desired type of axis values. */ valueType?: 'datetime' | 'numeric' | 'string'; }; }; /** * Specifies the color of the parent page element. */ containerBackgroundColor?: string; /** * Specifies a data source for the scale values and for the chart at the background. */ dataSource?: DataSourceLike; /** * Specifies the data source field that provides data for the scale. */ dataSourceField?: string; /** * Range selector's indent properties. */ indent?: { /** * Specifies range selector's left indent. */ left?: number; /** * Specifies range selector's right indent. */ right?: number; }; /** * A function that is executed after the UI component's value is changed. */ onValueChanged?: ((e: ValueChangedEvent) => void); /** * Specifies properties of the range selector's scale. */ scale?: { /** * Aggregates series points that fall into the same category. */ aggregateByCategory?: boolean; /** * Specifies the length of aggregation intervals in pixels. Does not apply if aggregateByCategory is true. May be ignored in favor of the aggregationInterval property. */ aggregationGroupWidth?: number; /** * Specifies the length of aggregation intervals in scale units. Applies only to the scale of the continuous or logarithmic type. */ aggregationInterval?: VizTimeInterval; /** * Specifies whether to allow decimal values on the scale. When false, the scale contains integer values only. */ allowDecimals?: boolean; /** * Configures the scale breaks' appearance. */ breakStyle?: { /** * Specifies the scale breaks' color. */ color?: string; /** * Specifies the scale breaks' line style. */ line?: 'straight' | 'waved'; /** * Specifies the scale breaks' width in pixels. */ width?: number; }; /** * Declares a scale break collection. Applies only if the scale's type is 'continuous' or 'logarithmic'. */ breaks?: Array; /** * Specifies the order of arguments on a discrete scale. */ categories?: Array; /** * Specifies whether to force the scale to start and end on ticks. */ endOnTick?: boolean; /** * Specifies the scale's end value. */ endValue?: number | Date | string; /** * Days to be excluded from the scale when workdaysOnly is true. */ holidays?: Array | Array; /** * Specifies common properties for scale labels. */ label?: { /** * Specifies a callback function that returns the text to be displayed in scale labels. */ customizeText?: ((scaleValue: { value?: Date | number | string; valueText?: string }) => string); /** * Specifies font properties for the text displayed in the range selector's scale labels. */ font?: Font; /** * Formats a value before it is displayed in a scale label. */ format?: Format; /** * Decides how to arrange scale labels when there is not enough space to keep all of them. */ overlappingBehavior?: 'hide' | 'none'; /** * Specifies a spacing between scale labels and the background bottom edge. */ topIndent?: number; /** * Specifies whether or not the scale's labels are visible. */ visible?: boolean; }; /** * Specifies a value used to calculate the range on a logarithmic scale within which the scale should be linear. Applies only if the data source contains negative values or zeroes. */ linearThreshold?: number; /** * Specifies the value to be raised to a power when generating ticks for a logarithmic scale. */ logarithmBase?: number; /** * Specifies properties for the date-time scale's markers. */ marker?: { /** * Defines the properties that can be set for the text that is displayed by the scale markers. */ label?: { /** * Specifies a callback function that returns the text to be displayed in scale markers. */ customizeText?: ((markerValue: { value?: Date | number; valueText?: string }) => string); /** * Formats a value before it is displayed in a scale marker. */ format?: Format; }; /** * Specifies the height of the marker's separator. */ separatorHeight?: number; /** * Specifies the space between the marker label and the marker separator. */ textLeftIndent?: number; /** * Specifies the space between the marker's label and the top edge of the marker's separator. */ textTopIndent?: number; /** * Specified the indent between the marker and the scale labels. */ topIndent?: number; /** * Indicates whether scale markers are visible. */ visible?: boolean; }; /** * Specifies the maximum range that can be selected. */ maxRange?: VizTimeInterval; /** * Specifies the minimum range that can be selected. */ minRange?: VizTimeInterval; /** * Specifies properties of the range selector's minor ticks. */ minorTick?: { /** * Specifies the color of the scale's minor ticks. */ color?: string; /** * Specifies the opacity of the scale's minor ticks. */ opacity?: number; /** * Indicates whether scale minor ticks are visible or not. */ visible?: boolean; /** * Specifies the width of the scale's minor ticks. */ width?: number; }; /** * Specifies the number of minor ticks between neighboring major ticks. */ minorTickCount?: number; /** * Specifies an interval between minor ticks. */ minorTickInterval?: VizTimeInterval; /** * Specifies the height of the space reserved for the scale in pixels. */ placeholderHeight?: number; /** * Specifies whether or not to show ticks for the boundary scale values, when neither major ticks nor minor ticks are created for these values. */ showCustomBoundaryTicks?: boolean; /** * Days to be included in the scale when workdaysOnly is true. */ singleWorkdays?: Array | Array; /** * Specifies the scale's start value. */ startValue?: number | Date | string; /** * Specifies properties defining the appearance of scale ticks. */ tick?: { /** * Specifies the color of scale ticks (both major and minor ticks). */ color?: string; /** * Specifies the opacity of scale ticks (both major and minor ticks). */ opacity?: number; /** * Specifies the width of the scale's ticks (both major and minor ticks). */ width?: number; }; /** * Specifies an interval between axis ticks. */ tickInterval?: VizTimeInterval; /** * Specifies the type of the scale. */ type?: 'continuous' | 'discrete' | 'logarithmic' | 'semidiscrete'; /** * Specifies the type of values on the scale. */ valueType?: 'datetime' | 'numeric' | 'string'; /** * Specifies which days are workdays. The array can contain values from 0 (Sunday) to 6 (Saturday). Applies only if workdaysOnly is true. */ workWeek?: Array; /** * Leaves only workdays on the scale: the work week days plus single workdays minus holidays. Applies only if the scale's valueType is 'datetime'. */ workdaysOnly?: boolean; }; /** * Specifies the color of the selected range. */ selectedRangeColor?: string; /** * Specifies how the selected range should behave when data is updated. Applies only when the RangeSelector is bound to a data source. */ selectedRangeUpdateMode?: 'auto' | 'keep' | 'reset' | 'shift'; /** * Specifies range selector shutter properties. */ shutter?: { /** * Specifies shutter color. */ color?: string; /** * Specifies the opacity of the color of shutters. */ opacity?: number; }; /** * Specifies the appearance of the range selector's slider handles. */ sliderHandle?: { /** * Specifies the color of the slider handles. */ color?: string; /** * Specifies the opacity of the slider handles. */ opacity?: number; /** * Specifies the width of the slider handles. */ width?: number; }; /** * Defines the properties of the range selector slider markers. */ sliderMarker?: { /** * Specifies the color of the slider markers. */ color?: string; /** * Specifies a callback function that returns the text to be displayed by slider markers. */ customizeText?: ((scaleValue: { value?: Date | number | string; valueText?: string }) => string); /** * Specifies font properties for the text displayed by the range selector slider markers. */ font?: Font; /** * Formats a value before it is displayed in a slider marker. */ format?: Format; /** * Specifies the color used for the slider marker text when the currently selected range does not match the minRange and maxRange values. */ invalidRangeColor?: string; /** * Specifies the empty space between the marker's left and right borders and the marker's text. */ paddingLeftRight?: number; /** * Specifies the empty space between the marker's top and bottom borders and the marker's text. */ paddingTopBottom?: number; /** * Specifies the placeholder height of the slider marker. */ placeholderHeight?: number; /** * Indicates whether or not the slider markers are visible. */ visible?: boolean; }; /** * Configures tooltips - small pop-up rectangles that display information about a data-visualizing UI component element being pressed or hovered over with the mouse pointer. */ tooltip?: BaseWidgetTooltip; /** * The selected range (initial or current). Equals the entire scale when not set. */ value?: Array | VizRange; } /** * The RangeSelector is a UI component that allows a user to select a range of values on a scale. */ export default class dxRangeSelector extends BaseWidget { getDataSource(): DataSource; /** * Gets the currently selected range. */ getValue(): Array; render(): void; /** * Redraws the UI component. */ render(skipChartAnimation: boolean): void; /** * Sets the selected range. */ setValue(value: Array | VizRange): void; } export type Properties = dxRangeSelectorOptions; /** * @deprecated use Properties instead * @deprecated Attention! This type is for internal purposes only. If you used it previously, please describe your scenario in the following GitHub Issue, and we will suggest a public alternative: {@link https://github.com/DevExpress/DevExtreme/issues/17885|Internal Types}. */ export type Options = dxRangeSelectorOptions;