Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ColorSizeSlider

Hierarchy

Index

Properties

container

container: string | HTMLElement

The ID or node representing the DOM element containing the widget.

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

handlesSyncedToPrimary

handlesSyncedToPrimary: boolean

Only applicable when three thumbs (i.e.

Read more...

histogramConfig

histogramConfig: HistogramConfig

The Histogram associated with the data represented on the slider.

Read more...

id

id: string

The unique ID assigned to the widget when the widget is created.

Read more...

initialized

initialized: boolean

inputFormatFunction

A function used to format user inputs.

Read more...

inputParseFunction

inputParseFunction: InputParser

Function used to parse slider inputs formatted by the inputFormatFunction.

Read more...

label

label: string

The widget's label.

Read more...

labelFormatFunction

A modified version of Slider.labelFormatFunction, which is a custom function used to format labels on the thumbs, min, max, and average values.

Read more...

max

max: number

The maximum value or upper bound of the slider.

Read more...

min

min: number

The minimum value or lower bound of the slider.

Read more...

persistSizeRangeEnabled

persistSizeRangeEnabled: boolean

Only applicable when three thumbs (i.e.

Read more...

precision

precision: number

Defines how slider thumb values should be rounded.

Read more...

primaryHandleEnabled

primaryHandleEnabled: boolean

When true, the slider will render a third handle between the two handles already provided by default.

Read more...

Readonly state

state: "disabled" | "ready"

The state of the view model.

Read more...

stops

stops: ColorSizeStop[]

The colors and sizes corresponding with data values in the ColorVariable and SizeVariable of the renderer associated with the slider.

Read more...

syncedSegmentsEnabled

syncedSegmentsEnabled: boolean

When true, all segments will sync together in updating thumb values when the user drags any segment.

Read more...

viewModel

The view model for the ColorSizeSlider widget.

Read more...

visible

visible: boolean

Indicates whether the widget is visible.

Read more...

visibleElements

The visible elements that are displayed within the widget.

Read more...

zoomOptions

Zooms the slider track to the bounds provided in this property.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns ColorSizeSlider

classes

  • classes(...classNames: any[]): string
  • A utility method used for building the value for a widget's class property.

    Read more...

    Parameters

    • Rest ...classNames: any[]

    Returns string

destroy

  • destroy(): void
  • Destroys the widget instance.

    Read more...

    Returns void

emit

  • emit(type: string, event?: any): boolean
  • Emits an event on the instance.

    Read more...

    Parameters

    • type: string
    • Optional event: any

    Returns boolean

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

hasEventListener

  • hasEventListener(type: string): boolean
  • Indicates whether there is an event listener on the instance that matches the provided event name.

    Read more...

    Parameters

    • type: string

    Returns boolean

isFulfilled

  • isFulfilled(): boolean
  • isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

    Read more...

    Returns boolean

isRejected

  • isRejected(): boolean
  • isRejected() may be used to verify if creating an instance of the class is rejected.

    Read more...

    Returns boolean

isResolved

  • isResolved(): boolean
  • isResolved() may be used to verify if creating an instance of the class is resolved.

    Read more...

    Returns boolean

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

on

own

  • Widget teardown helper.

    Read more...

    Parameters

    Returns void

postInitialize

  • postInitialize(): void
  • This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

    Read more...

    Returns void

render

  • render(): any
  • This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

    Read more...

    Returns any

renderNow

  • renderNow(): void
  • Renders widget to the DOM immediately.

    Read more...

    Returns void

scheduleRender

  • scheduleRender(): void
  • This method is primarily used by developers when implementing custom widgets. Schedules widget rendering.

    Read more...

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns ColorSizeSlider

  • Parameters

    Returns ColorSizeSlider

updateFromRendererResult

updateRenderer

updateVisualVariables

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

when

  • when(callback?: Function, errback?: Function): Promise<any>
  • when() may be leveraged once an instance of the class is created.

    Read more...

    Parameters

    • Optional callback: Function
    • Optional errback: Function

    Returns Promise<any>

Generated using TypeDoc