UI Slider element

Hierarchy

Constructors

Properties

__preDataSource __preSource __preSourceFiltered _assignClasses _canBeLongTouch _captureListeners _cleanFuncs _cleanUpCalled _contextMenu _contextMenuAddons _contextMenuHandler _controlTitle _dataSource _dataSourceListenFuncts _dataSourceOrig _dataSourcePromises _disabled _dockMenuItems _dockable _frameIDs _frameMMIDs _fromZero _generateTicks _hasSplitters _idleCallIDs _ignoreDefaultLookup _invert _isDock _isFiltered _isLongTouch _isresizable _lastEventTime _lastKey? _lastMousePos _layoutChangeHandler? _listeners _localPromises _max _menuArray _min _minTimeBetweenTicks _mouseMoveHandler _mouseOutHandler _needsFullRecalculation? _orientation _originalHeight _originalWidth _parentView _pointerAtPos _resizeStartX _resizeStartY _resizing _roundToStep _searchable _seekBar _seekBarBefore _seekBarOuter _seekBarSize _seekBarSizes _seekBarThumb _seekBarThumbSizes _setFilteredSourceTm _speechDecimals _speechName _speechUnit _statusBarPromises _statusBarSources _statusParams _step _tabIndex _tabbable _tickInterval _tickPlacement _ticks _ticksOuter _timeoutIDs _touchDownTime _updateInvert _updatePos _value _wheelStep activateImmediateTooltipHandling activatedHandler addArtworkRules canBeUsedAsSource canvas? closediv? container contextMenuPromise currentMode debugMenuItemsCreated defaultBtn disableStateStoring disabledCounter dndEventsRegistered dragEnterHandler dragFinishedHandler dragLeaveHandler dragOverHandler dragStartHandler dragging dropHandler editSupported excludeFromGlobalContextualSearch findDNDHandler focusEventsRegistered? forceDisabled? getCloseButtonAction initialized itemCount? mergeParentContextMenu mouseWheelHandler noFocusOnClick resizediv sbOuterPos setCloseButtonAction setTabbable startEdit? statusInfo touchEnd touchEventsRegistered? touchMove touchStart uniqueID

Accessors

Methods

Constructors

Properties

__preDataSource: any

Undocumented

__preSource: any

Undocumented

__preSourceFiltered: any

Undocumented

_assignClasses: any

Undocumented

_canBeLongTouch: any

Undocumented

_captureListeners: any

Undocumented

_cleanFuncs: any

Undocumented

_cleanUpCalled: boolean

Undocumented

_contextMenu: any

Undocumented

_contextMenuAddons: any

Undocumented

_contextMenuHandler: any

Undocumented

_controlTitle: string

Undocumented

_dataSource: any

Undocumented

_dataSourceListenFuncts: (() => void)[]

Undocumented

_dataSourceOrig: any

Undocumented

_dataSourcePromises: any

Undocumented

_disabled: boolean

Undocumented

_dockMenuItems: any

Undocumented

_dockable: boolean

Undocumented

_frameIDs: any

Undocumented

_frameMMIDs: any

Undocumented

_fromZero: boolean

Undocumented

_generateTicks: procedure

Undocumented

_hasSplitters: boolean

Undocumented

_idleCallIDs: any

Undocumented

_ignoreDefaultLookup: any

Undocumented

_invert: boolean

Undocumented

_isDock: boolean

Undocumented

_isFiltered: boolean

Undocumented

_isLongTouch: any

Undocumented

_isresizable: boolean

Undocumented

_lastEventTime: number

Undocumented

_lastKey?: string

Undocumented

_lastMousePos: {
    x: any;
    y: any;
}

Undocumented

Type declaration

  • x: any

    Undocumented

  • y: any

    Undocumented

_layoutChangeHandler?: ((evt) => void)

Type declaration

    • (evt): void
    • Undocumented

      Parameters

      Returns void

_listeners: any

Undocumented

_localPromises: Promise<any>[]

Undocumented

_max: number

Undocumented

_menuArray: Action[]

Undocumented

_min: number

Undocumented

_minTimeBetweenTicks: number

Undocumented

_mouseMoveHandler: ((evt) => void)

Type declaration

    • (evt): void
    • Undocumented

      Parameters

      Returns void

_mouseOutHandler: ((evt) => void)

Type declaration

    • (evt): void
    • Undocumented

      Parameters

      Returns void

_needsFullRecalculation?: boolean

Undocumented

_orientation: string

Undocumented

_originalHeight: number

Undocumented

_originalWidth: number

Undocumented

_parentView: ViewData

Undocumented

_pointerAtPos: any

Undocumented

_resizeStartX: number

Undocumented

_resizeStartY: number

Undocumented

_resizing: boolean

Undocumented

_roundToStep: any

Undocumented

_searchable: boolean

Undocumented

_seekBar: HTMLDivElement

Undocumented

_seekBarBefore: HTMLDivElement

Undocumented

_seekBarOuter: HTMLDivElement

Undocumented

_seekBarSize: number

Undocumented

_seekBarSizes: {
    offsetHeight: number;
    offsetWidth: number;
}

Undocumented

Type declaration

  • offsetHeight: number

    Undocumented

  • offsetWidth: number

    Undocumented

_seekBarThumb: HTMLDivElement

Undocumented

_seekBarThumbSizes: {
    offsetHeight: number;
    offsetWidth: number;
}

Undocumented

Type declaration

  • offsetHeight: number

    Undocumented

  • offsetWidth: number

    Undocumented

_setFilteredSourceTm: any

Undocumented

_speechDecimals: number

Undocumented

_speechName: string

Undocumented

_speechUnit: string

Undocumented

_statusBarPromises: any

Undocumented

_statusBarSources: any

Undocumented

_statusParams: AnyDict

Undocumented

_step: number

Undocumented

_tabIndex: number

Undocumented

_tabbable: boolean

Undocumented

_tickInterval: number

Undocumented

_tickPlacement: string

Undocumented

_ticks: number[]

Undocumented

_ticksOuter: HTMLDivElement

Undocumented

_timeoutIDs: any

Undocumented

_touchDownTime: any

Undocumented

_updateInvert: (() => void)

Type declaration

    • (): void
    • Undocumented

      Returns void

_updatePos: procedure

Undocumented

_value: number

Undocumented

_wheelStep: number

Undocumented

activateImmediateTooltipHandling: boolean

Undocumented

activatedHandler: ((active) => void)

Type declaration

    • (active): void
    • Undocumented

      Parameters

      • active: boolean

      Returns void

addArtworkRules: any

Undocumented

canBeUsedAsSource: boolean

Undocumented

canvas?: any

Undocumented

closediv?: HTMLDivElement

Undocumented

container: HTMLElement

Undocumented

contextMenuPromise: any

Undocumented

currentMode: any

Undocumented

debugMenuItemsCreated: any

Undocumented

defaultBtn: HTMLElement

Undocumented

disableStateStoring: boolean

Undocumented

disabledCounter: number

Undocumented

dndEventsRegistered: boolean

Undocumented

dragEnterHandler: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

dragFinishedHandler: ((e?) => void)

Type declaration

    • (e?): void
    • Undocumented

      Parameters

      Returns void

dragLeaveHandler: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

dragOverHandler: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

dragStartHandler: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

dragging: boolean

Undocumented

dropHandler: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      • e: any

      Returns void

editSupported: boolean

Undocumented

excludeFromGlobalContextualSearch: boolean

Undocumented

findDNDHandler: ((e) => any)

Type declaration

    • (e): any
    • Undocumented

      Parameters

      Returns any

focusEventsRegistered?: boolean

Undocumented

forceDisabled?: boolean

Undocumented

getCloseButtonAction: (() => any)

Type declaration

    • (): any
    • Undocumented

      Returns any

initialized: boolean

Undocumented

itemCount?: number

Undocumented

mergeParentContextMenu: any

Undocumented

mouseWheelHandler: any

Undocumented

noFocusOnClick: any

Undocumented

resizediv: HTMLDivElement

Undocumented

sbOuterPos: number

Undocumented

setCloseButtonAction: ((action) => void)

Type declaration

    • (action): void
    • Undocumented

      Parameters

      Returns void

setTabbable: any

Undocumented

startEdit?: procedure

Undocumented

statusInfo: any

Undocumented

touchEnd: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

touchEventsRegistered?: boolean

Undocumented

touchMove: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

touchStart: ((e) => void)

Type declaration

    • (e): void
    • Undocumented

      Parameters

      Returns void

uniqueID: string

Undocumented

Accessors

  • get contextMenu(): any
  • Gets/sets context menu of the control. It could be also a function returning Menu object.

    Returns any

  • set contextMenu(value): void
  • Parameters

    • value: any

    Returns void

  • get dataSource(): any
  • Returns any

  • set dataSource(value): void
  • Parameters

    • value: any

    Returns void

  • get disabled(): boolean
  • Gets/sets data-disabled attribute of the control and his childs

    Returns boolean

  • set disabled(value): void
  • Parameters

    • value: boolean

    Returns void

  • get dockMenuItems(): any
  • Gets/sets dock menu of the control. It could be also a function returning Menu object.

    Returns any

  • set dockMenuItems(value): void
  • Parameters

    • value: any

    Returns void

  • get dockTitle(): string
  • Gets/sets dock title.

    Returns string

  • set dockTitle(value): void
  • Parameters

    • value: string

    Returns void

  • get dockable(): boolean
  • Gets/sets dockable status of the control.

    Returns boolean

  • set dockable(value): void
  • Parameters

    • value: boolean

    Returns void

  • get fromZero(): boolean
  • If true, show slider value with beginning in zero

    Default

    false
    

    Returns boolean

  • set fromZero(val): void
  • Parameters

    • val: boolean

    Returns void

  • get hasSplitters(): boolean
  • Returns boolean

  • set hasSplitters(value): void
  • Parameters

    • value: boolean

    Returns void

  • get helpContext(): string
  • Returns string

  • set helpContext(value): void
  • Parameters

    • value: string

    Returns void

  • get invert(): boolean
  • If true, reverse direction of the slider.

    Default

    false
    

    Returns boolean

  • set invert(val): void
  • Parameters

    • val: boolean

    Returns void

  • get isDock(): boolean
  • Gets/sets isDock status of the control.

    Returns boolean

  • set isDock(value): void
  • Parameters

    • value: boolean

    Returns void

  • get isSearchable(): boolean
  • Get/set whether this control is searchable (e.g. via search bar)

    Returns boolean

  • set isSearchable(value): void
  • Parameters

    • value: boolean

    Returns void

  • get max(): number
  • Get/set maximal value of the slider.

    Default

    0
    

    Returns number

  • set max(val): void
  • Parameters

    • val: number

    Returns void

  • Returns any[]

  • Parameters

    • value: any[]

    Returns void

  • get min(): number
  • Get/set minimal value of the slider.

    Default

    0
    

    Returns number

  • set min(val): void
  • Parameters

    • val: number

    Returns void

  • get minHeight(): number
  • Returns number

  • set minHeight(value): void
  • Parameters

    • value: number

    Returns void

  • get minWidth(): number
  • Returns number

  • set minWidth(value): void
  • Parameters

    • value: number

    Returns void

  • get multiselect(): boolean
  • Returns boolean

  • set multiselect(value): void
  • Parameters

    • value: boolean

    Returns void

  • get orientation(): string
  • Slider orientation. Possible values: 'vertical', 'horizontal'

    Default

    'horizontal'
    

    Returns string

  • set orientation(val): void
  • Parameters

    • val: string

    Returns void

  • get parentView(): ViewData
  • Gets/sets view data.

    Returns ViewData

  • set parentView(value): void
  • Parameters

    Returns void

  • get resizable(): boolean
  • Returns boolean

  • set resizable(val): void
  • Parameters

    • val: boolean

    Returns void

  • get selectionMode(): boolean
  • Returns boolean

  • set selectionMode(value): void
  • Parameters

    • value: boolean

    Returns void

  • get speechDecimals(): number
  • For screen readers, is is the number of decimals that the screen reader outputs when reading the slider value.

    Default

    0
    

    Returns number

  • set speechDecimals(val): void
  • Parameters

    • val: number

    Returns void

  • get speechName(): string
  • For screen readers, is is the name of the slider. (For example: "Volume")

    Default

    undefined
    

    Returns string

  • set speechName(val): void
  • Parameters

    • val: string

    Returns void

  • get speechUnit(): string
  • For screen readers, this is the unit that the screen readers say when reading the slider value. (For example: "Percent")

    Default

    undefined
    

    Returns string

  • set speechUnit(val): void
  • Parameters

    • val: string

    Returns void

  • get statusParams(): AnyDict
  • Gets/sets params for statusbar.

    Returns AnyDict

  • set statusParams(value): void
  • Parameters

    Returns void

  • get step(): number
  • Get/set step of the slider. 0 means no discrete step.

    Default

    0
    

    Returns number

  • set step(val): void
  • Parameters

    • val: number

    Returns void

  • get tabIndex(): number
  • Gets/sets tabIndex property. Use instead of tabIndex in HTMLElement for correct handling of disabled state.

    Returns number

  • set tabIndex(value): void
  • Parameters

    • value: number

    Returns void

  • get tabbable(): boolean
  • If true, enables focusing control and controlling by arrow keys.

    Default

    true
    

    Returns boolean

  • set tabbable(val): void
  • Parameters

    • val: boolean

    Returns void

  • get tickInterval(): number
  • Slider ticks interval.

    Default

    1
    

    Returns number

  • set tickInterval(val): void
  • Parameters

    • val: number

    Returns void

  • get tickPlacement(): string
  • Slider ticks placement. Possible values: 'none', 'both', 'bottomRight', 'topLeft', 'center'

    Default

    'none'
    

    Returns string

  • set tickPlacement(val): void
  • Parameters

    • val: string

    Returns void

  • get ticks(): number[]
  • Array of slider ticks values. For regular ticks user should rather use tickInterval.

    Default

    []
    

    Returns number[]

  • set ticks(val): void
  • Parameters

    • val: number[]

    Returns void

  • get value(): any
  • Get/set actual value of the slider.

    Default

    0
    

    Returns any

  • set value(val): void
  • Parameters

    • val: any

    Returns void

  • get visible(): boolean
  • Gets/sets visibility state of the control.

    Returns boolean

  • get wheelStep(): number
  • Get/set wheel step of the slider (step used by mouse wheel). Default is undefined = wheel uses "step" property.

    Default

    undefined
    

    Returns number

  • set wheelStep(val): void
  • Parameters

    • val: number

    Returns void

Methods

  • Undocumented

    Parameters

    • orig: any
    • filtered: any
    • phrase: any

    Returns void

  • Add function to be called once during Control cleanUp

    Method

    addCleanFunc

    Parameters

    • func: any

      Function to add

    Returns void

  • Creates a new sub-control.

    Method

    addControl

    Parameters

    • controlClass: string

      Class of the new control.

    • Optional initParams: AnyDict

      Initialization parameters.

    Returns HTMLDivElement

    The new control.

  • Undocumented

    Parameters

    • event: any
    • func: any
    • capture: any

    Returns void

  • Adds item(s) to control context menu.

    Method

    addToContextMenu

    Parameters

    • items: any

    Returns void

  • Undocumented

    Returns boolean

  • Control is allow drop objects.

    Method

    canDrop

    Parameters

    Returns boolean

    true if dragged object can be dropped here

  • Undocumented

    Returns boolean

  • Undocumented

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Parameters

    • e: any

    Returns void

  • Undocumented

    Parameters

    • object: any
    • event: any
    • func: any
    • Optional capture: boolean

    Returns ((...args) => any)

      • (...args): any
      • Parameters

        • Rest ...args: any[]

        Returns any

  • Undocumented

    Parameters

    • pr: any

    Returns any

  • Handle drag enter operation

    Method

    dragEnter

    Parameters

    Returns void

  • Undocumented

    Parameters

    Returns void

  • Handle drag leave operation

    Method

    dragLeave

    Parameters

    Returns void

  • Handle drag over operation

    Method

    dragOver

    Parameters

    Returns void

  • Handle drop operation

    Method

    drop

    Parameters

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Parameters

    Returns void

  • Filters dataSource based on given criteria (used when searching/filtering items within, e.g. via search bar)

    Method

    filterSource

    Parameters

    • phrase: any

      string phrase to filter

    Returns void

    String message or object with detailed data

  • Undocumented

    Parameters

    • element: HTMLElement
    • newState: any

    Returns boolean

  • Undocumented

    Parameters

    Returns void

  • Undocumented

    Parameters

    • newFocusState: any

    Returns void

  • Format status text in this callback, when using object with detailed data.

    Method

    formatStatus

    Parameters

    • data: any

    Returns string

    String message or object with detailed data

  • Undocumented

    Parameters

    • evt: any

    Returns any

  • Undocumented

    Returns string

  • Undocumented

    Returns HTMLElement

  • Returns the first ancestor in the HTML DOM tree, that has controlClass and data-id. Searching is stopped on topParentCtrl, if defined.

    Method

    getParentControl

    Parameters

    • topParentCtrl: any

      ControlClass of the top parent, where to stop searching.

    Returns Control

    Parent Control or undefined if there's no parent.

  • Returns control to decide which subcontrols should be stored e.g. Multiview component overrides this as it stores states only for the active control/view

    Method

    getPersistentStateRootControl

    Returns HTMLElement

    control

  • Returns root key string under which the values are stored in persistent.JSON file on the disk.

    Method

    getPersistentStateRootKey

    Returns string

    store key id

  • Undocumented

    Parameters

    • Optional evt: any

    Returns void

  • Undocumented

    Parameters

    • hotkey: any

    Returns boolean

  • Undocumented

    Parameters

    • parentel: any
    • params: any

    Returns void

  • Undocumented

    Returns boolean

  • This method is pretty similar as app.listen(), but app.unlisten() is called automatically in Control.cleanUp()

    Method

    localListen

    Parameters

    • object: any

      Object where to set listener

    • event: string

      Event of the listener

    • func: AnyCallback

      Method for callback dispatch

    • Optional capture: boolean

    Returns ((...args) => any)

      • (...args): any
      • Parameters

        • Rest ...args: any[]

        Returns any

  • This method is supposed to automatically cancel running promises when component is going to destroy.

    Method

    localPromise

    Parameters

    • promise: any

    Returns any

  • Undocumented

    Parameters

    Returns boolean

  • Control is allow drag object

    Method

    makeDraggable

    Parameters

    • element: any
    • Optional canBeDragged: boolean

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Parameters

    • nodeDataSource: any
    • nodeHandlerID: any
    • clickedArea: any
    • Optional newTab: boolean

    Returns void

  • Undocumented

    Parameters

    • id: string

    Returns any

  • Raise the event on the Control

    Example

    if (!this.raiseEvent('selecting', {
    tabIndex: value,
    oldTabIndex: oldSelected
    }, true))
    return; // canceled, do not change selection

    Parameters

    • eventName: any

      Name of the event

    • Optional details: AnyDict

      Custom parameters to be sent with the event

    • Optional isCancelable: boolean

      Whether the event can be canceled.

    • Optional canBubble: boolean

      Whether the event can bubble.

    • Optional sender: EventTarget

      of the event. Container by default.

    Returns boolean

    Success. If 'false', the event was canceled.

  • Undocumented

    Parameters

    • event: any
    • Optional capture: boolean

    Returns void

  • Undocumented

    Parameters

    • source: any

    Returns void

  • Undocumented

    Parameters

    • event: any
    • func: any
    • capture: any

    Returns void

  • Request an animation frame in the control context. If the control has been cleaned up, then the callback will not execute.

    Example

    this.requestFrame(function () {
    // this callback will be executed at a maximum of your monitor's natural refresh rate.
    }, "myUniqueFrameCallbackName");

    Parameters

    • callback: (() => void)

      Callback to run.

        • (): void
        • Returns void

    • Optional callbackID: string

      Optional ID for callback, so that multiple instances of the callback do not execute at the same time.

    Returns void

  • Request an animation frame in the control context, with the same features as requestAnimationFrameMM(). If the control has been cleaned up, then the callback will not execute.

    Example

    this.requestFrame(function () {
    // this callback will be executed at a maximum of your monitor's natural refresh rate when focused, maximum of 30 fps when not focused, and maximum of 2 fps when window is not visible.
    }, "myUniqueFrameCallbackName");

    Method

    requestFrameMM

    Parameters

    • callback: (() => void)

      Callback to run.

        • (): void
        • Returns void

    • Optional callbackID: string

      Optional ID for callback, so that multiple instances of the callback do not execute at the same time.

    Returns void

  • Calls requestIdleCallback, cancels the previous sheduled callback on cleanup or multiple calls

    Method

    requestIdle

    Parameters

    • callback: any

      Callback, which should be called when idle

    • Optional callbackID: string

      String name, which identifies the callback. If present, it cancels the previous sheduled callback

    • Optional useFirst: boolean

      Valid only if callbackID is present, if true, previous unfinished timer is finished and the last is revoked

    Returns number

  • Calls setTimeout, cancels the previous sheduled callback on cleanup or multiple calls

    Method

    requestTimeout

    Parameters

    • callback: (() => void)

      Callback, which should be called after timeout

        • (): void
        • Returns void

    • timeMS: number

      Timeout, in ms

    • Optional callbackID: string

      String name, which identifies the callback. If present, it cancels the previous sheduled callback

    • Optional useFirst: boolean

      Valid only if callbackID is present, if true, previous unfinished timer is finished and the last is revoked

    Returns number

  • Restores persistent (class) states for the control class and all subcontrols, this stores global (class) state (is same for all instances of the control)

    Method

    restorePersistentStates

    Returns void

  • Restores state of the control and all its subcontrols having data-id specified.

    Method

    restoreState

    Parameters

    • fromObject: ControlState

      hierarchical object including states of the control and the subcontrols

    • Optional isJustViewModeChange: boolean

    Returns void

  • Undocumented

    Parameters

    • message: any

    Returns void

  • Undocumented

    Parameters

    • el: any
    • val: any
    • effectiveVal: any

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Parameters

    • value: any

    Returns void

  • Set details for dragged element

    Method

    setDragElementData

    Parameters

    • element: any
    • e: any

    Returns void

  • Undocumented

    Parameters

    • Optional onlyLV: boolean

    Returns void

  • Undocumented

    Parameters

    • idx: number

    Returns void

  • Undocumented

    Parameters

    • idx: number

    Returns void

  • Undocumented

    Parameters

    • idx: number

    Returns void

  • Set status text. Can be simple string or object with data formatted later in formatStatus method.

    Method

    setStatus

    Parameters

    • data: any

    Returns void

    String message or object with detailed data

  • Stores persistent (class) states for the control class and all subcontrols, this stores global (class) state (is same for all instances of the control)

    Method

    storePersistentStates

    Returns void

  • Stores state of the control and all its subcontrols having data-id specified.

    Method

    storeState

    Returns ControlState

    hierarchical object including states of the control and the subcontrols

  • Method for handling Promise with delayed progress.

    Method

    thenWithProgress

    Parameters

    • pPromise: any

      Passed promise

    • Optional params: any

      Object with possible parameters:

      • thenFunc - function called after resolving promise
      • errorFunc - function called after rejecting promise
      • delayedFunc - function called after given delay
      • delayMS - progress delay, default 100ms. Progress is displayed after this time, in case promise was not resolved yet
      • progressText - text displayed in delayed progress, default string is "Getting data"
      • progress - SimpleTasksController object, used for progress. If not present, use global progress.

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Parameters

    • event: string
    • Optional capture: boolean

    Returns void

  • Undocumented

    Returns void

  • Undocumented

    Parameters

    • source: any

    Returns void

  • Undocumented

    Returns void