Skip to main content

RangeSlider

A slider that lets user control both min and max values.

Extends

Constructors

new RangeSlider()

new RangeSlider(dart): RangeSlider

Parameters

ParameterType
dartany

Returns

RangeSlider

Inherited from

DartWidget . constructor

Source

src/widgets.ts:457

Properties

PropertyModifierTypeDefault valueDescriptionInherited from
_propertiesprotectedProperty[]undefined-DartWidget._properties
_rootprotectedHTMLElementundefined-DartWidget._root
dartpublicanyundefined-DartWidget.dart
factorypublicnull | FuncnullConstructor function. No parameters, returns [Widget].DartWidget.factory
isDetachedpublicbooleanfalse-DartWidget.isDetached
propspublicanyundefined-DartWidget.props
subspublicSubscription[]undefined-DartWidget.subs
temppublicanyundefinedContains auxiliary informationDartWidget.temp

Accessors

max

get max(): number

Gets maximum value.

Returns

number

Source

src/widgets.ts:1878


maxRange

get maxRange(): number

Gets maximum range value.

Returns

number

Source

src/widgets.ts:1872


min

get min(): number

Gets minimum value.

Returns

number

Source

src/widgets.ts:1875


minRange

get minRange(): number

Minimum range value.

Returns

number

Source

src/widgets.ts:1869


onValuesChanged

get onValuesChanged(): Observable<any>

Returns

Observable<any>

Source

src/widgets.ts:1902


root

get root(): HTMLElement

Widget's visual root.

Returns

HTMLElement

Source

src/widgets.ts:467


type

get type(): string

Returns

string

Source

src/widgets.ts:463

Methods

addProperty()

private addProperty(propertyName, propertyType, defaultValue, options): any

Registers an property with the specified type, name, and defaultValue.

Parameters

ParameterTypeDefault valueDescription
propertyNamestringundefined
propertyType"string" | "bigint" | "object" | "map" | "file" | "view" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe" | "num" | "string_list" | "dataframe_list" | "cell" | "column" | "column_list" | "graphics" | "tablerowfiltercall" | "colfiltercall" | "bitset" | "dynamic" | "viewer" | "list" | "semantic_value" | "func" | "funccall" | "property" | "categorical" | "numerical" | "GridCellRenderArgs" | "element" | "TableView" | "User" | "Menu" | "Project" | "event_data" | "progressindicator" | "Credentials" | "ScriptEnvironment" | "Notebook"undefined
defaultValueanynull
optionsnull | object & PropertyOptionsnull

Returns

any

Inherited from

DartWidget . addProperty

See

Registered property gets added to properties. Returns default value, thus allowing to combine registering a property with the initialization

Source

src/widgets.ts:312


apply()

apply(properties): Widget<any>

Parameters

ParameterTypeDescription
propertiesobject

Returns

Widget<any>

Inherited from

DartWidget . apply

Source

src/widgets.ts:262


detach()

detach(): void

Gets called when a widget is detached and will no longer be used. Typically used for unsubscribing from events. Be sure to call super.detach() if this method is overridden.

Returns

void

Inherited from

DartWidget . detach

Source

src/widgets.ts:296


getDartProperties()

getDartProperties(): any[]

Returns

any[]

Inherited from

DartWidget . getDartProperties

Source

src/widgets.ts:278


getProperties()

getProperties(): Property[]

Returns

Property[]

Inherited from

DartWidget . getProperties

Source

src/widgets.ts:471


onFrameAttached()

onFrameAttached(dataFrame): void

Parameters

ParameterType
dataFrameDataFrame

Returns

void

Inherited from

DartWidget . onFrameAttached

Source

src/widgets.ts:284


onPropertyChanged()

onPropertyChanged(property): void

Gets called when viewer's property is changed.

Parameters

ParameterTypeDescription
propertynull | Propertyor null, if multiple properties were changed.

Returns

void

Inherited from

DartWidget . onPropertyChanged

Source

src/widgets.ts:276


scrollBy()

scrollBy(delta): void

Shifts min and max values by the specified delta.

Parameters

ParameterType
deltanumber

Returns

void

Source

src/widgets.ts:1899


scrollTo()

scrollTo(newMinValue): void

Sets the specified min value, preserving the range (scrolls).

Parameters

ParameterType
newMinValuenumber

Returns

void

Source

src/widgets.ts:1896


setShowHandles()

setShowHandles(value): void

Sets showHandles in range slider.

Parameters

ParameterTypeDescription
valueboolean

Returns

void

Source

src/widgets.ts:1891


setValues()

setValues(minRange, maxRange, min, max): void

Sets values to range slider.

Parameters

ParameterTypeDescription
minRangenumber
maxRangenumber
minnumber
maxnumber

Returns

void

Source

src/widgets.ts:1885


sourceRowsChanged()

sourceRowsChanged(): void

Returns

void

Inherited from

DartWidget . sourceRowsChanged

Source

src/widgets.ts:282


sub()

sub(subscription): void

Registers a subscription to an external event.

Parameters

ParameterTypeDescription
subscriptionSubscription

Returns

void

Inherited from

DartWidget . sub

Source

src/widgets.ts:255


toDart()

toDart(): any

Returns

any

Inherited from

DartWidget . toDart

Source

src/widgets.ts:247


create()

static create(vertical, optionsStyle): RangeSlider

Parameters

ParameterTypeDefault value
verticalbooleanfalse
optionsStyleRangeSliderStyle | SliderOptions'barbell'

Returns

RangeSlider

Source

src/widgets.ts:1858


find()

static find(root): null | Widget<any>

Finds existing widget from its visual root.

Parameters

ParameterType
rootElement

Returns

null | Widget<any>

Inherited from

DartWidget . find

Source

src/widgets.ts:243


fromRoot()

static fromRoot(root): Widget<any>

Creates a new widget from the root element.

Parameters

ParameterType
rootHTMLElement

Returns

Widget<any>

Inherited from

DartWidget . fromRoot

Source

src/widgets.ts:335


getAll()

static getAll(): Widget<any>[]

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

DartWidget . getAll

Source

src/widgets.ts:238