Scale

Scale

new Scale(optionsopt)

Source:
Properties:
Name Type Attributes Default Description
options.layout String <optional>
 "right"

The layout of the Scale. right and left are vertical layouts with the labels being drawn right and left of the scale, respectively. top and bottom are horizontal layouts for which the labels are drawn on top and below the scale, respectively.
options.division Integer <optional>
 1

Minimal step size of the markers.
options.levels Array.<Number> <optional>
 [1]

Array of steps for labels and markers.
options.base Number <optional>
 false

Base of the scale. If set to false it will default to the minimum value.
options.labels function <optional>
 FORMAT("%.2f")

Formatting function for the labels.
options.gap_dots Integer <optional>
 4

Minimum gap in pixels between two adjacent markers.
options.gap_labels Integer <optional>
 40

Minimum gap in pixels between two adjacent labels.
options.show_labels Boolean <optional>
 true

If true, labels are drawn.
options.show_max Boolean <optional>
 true

If true, display a label and a dot for the 'max' value.
options.show_min Boolean <optional>
 true

If true, display a label and a dot for the 'min' value.
options.show_base Boolean <optional>
 true

If true, display a label and a dot for the 'base' value.
options.fixed_dots Array.<ScaleDot> | Array.<number> | Boolean <optional>

This option can be used to specify fixed positions for the markers to be drawn at. false disables fixed dots.
options.fixed_labels Array.<ScaleLabel> | Array.<number> | Boolean <optional>

This option can be used to specify fixed positions for the labels to be drawn at. false disables fixed labels.
options.show_markers Boolean <optional>
 true

If true, every dot which is located at the same position as a label has the .aux-marker class set.
options.pointer Number | Boolean <optional>
 false

The value to set the pointers position to. Set to false to hide the pointer.
options.bar Number | Boolean <optional>
 false

The value to set the bars height to. Set to false to hide the bar.

Scale can be used to draw scales. It is used in Meter and Fader. Scale draws labels and markers based on its parameters and the available space. Scales can be drawn both vertically and horizontally. Scale mixes in Ranged and inherits all its options.

Parameters:
Name Type Attributes Default Description
options Object <optional>
 { }

An object containing initial options.

Extends

Methods

addChild(child)

Source:
Inherited From:
See:

Registers a widget as a child widget. This method is used to build up the widget tree. It does not modify the DOM tree.

Parameters:
Name Type Description
child Widget

The child to add.
Fires:
  • Widget#event:child_added

addChildren(a)

Source:
Inherited From:

Registers an array of widgets as children.

Parameters:
Name Type Description
a Array.<Widget>

An array of Widgets.

allChildren()

Source:
Inherited From:

Returns an array of all children.

appendChild(child)

Source:
Inherited From:

Appends child.element to the widget element and registers child as a child widget.

Parameters:
Name Type Description
child Widget

The child widget to append.

appendChildren(children)

Source:
Inherited From:

Calls Widget#appendChild for an array of widgets.

Parameters:
Name Type Description
children Array.<Widget>

The child widgets to append.

destroy()

Source:
Overrides:

Dispose of this Widget.

destroyAndRemove()

Source:
Inherited From:

Dispose of this Widget and remove it from the DOM.

disableTansitions()

Source:
Inherited From:

Disable CSS transitions.

enableDraw()

Source:
Overrides:

Schedules this widget for drawing.

Fires:

enableDrawChildren()

Source:
Inherited From:

Enables rendering for all children of this widget.

enableTransitions()

Source:
Inherited From:

Enable CSS transitions.

forceHide()

Source:
Inherited From:

Hide the widget immediately by applying the class aux-hide. Does not call disableDraw().

forceShow()

Source:
Inherited From:

Show the widget immediately by applying the class aux-show. Does not call enableDraw().

getStyle()

Source:
Inherited From:

Returns the computed style of this widget's DOM element.

hidden()

Source:
Inherited From:

Returns the current hidden status.

hide()

Source:
Inherited From:

Hide the widget. This will result in the class aux-hide being applied to this widget in the next rendering step.

invalidate(key)

Source:
Inherited From:

Invalidates an option and triggers a redraw() call.

Parameters:
Name Type Description
key string

invalidateAll()

Source:
Inherited From:

Invalidates all dependencies which will trigger all renderers to rerun.

observeResize(cb)

Source:
Inherited From:

Calls a callback whenever the widget resizes. This method will trigger one resize.

Parameters:
Name Type Description
cb function

removeChild(child)

Source:
Inherited From:

Removes a child widget. Note that this method only modifies the widget tree and does not change the DOM.

Parameters:
Name Type Description
child Widget

The child to remove.
Fires:
  • Widget#event:child_removed

removeChildren(a)

Source:
Inherited From:

Removes an array of children.

Parameters:
Name Type Description
a Array.<Widget>

An array of Widgets.

set(key, value)

Source:
Inherited From:

Sets an option.

Parameters:
Name Type Description
key string

The option name.
value

The option value.

setStyle()

Source:
Inherited From:

Sets a CSS style property in this widget's DOM element.

show()

Source:
Inherited From:

Make the widget visible. This will apply the class aux-show during the next rendering step.

toggleHidden()

Source:
Inherited From:

Toggle the hidden status. This is equivalent to calling hide() or show(), depending on the current hidden status of this widget.

transitionsDisabled()

Source:
Inherited From:

Returns true if transitions are currently disabled on this widget.

visibleChildren()

Source:
Inherited From:

Returns an array of all visible children.

Events

destroy

Source:
Inherited From:

Is fired when a widget is destroyed.

doubleclick

Source:
Inherited From:

Is fired after a double click appeared. Set dblclick to 0 to disable click event handling.

Parameters:
Name Type Description
event string

The browsers MouseEvent.

GenericDOMEvents

Source:
Inherited From:

Generic DOM events. Please refer to W3Schools for further details.

hide

Source:
Inherited From:

The hide event is emitted when a widget is hidden and is not rendered anymore. This happens both with browser visibility changes and also internally when using layout widgets such as Pager.

initialized

Source:
Inherited From:

Is fired when a widget is initialized.

resize

Source:
Inherited From:

The resize event is emitted whenever a widget is being resized. This event can be used to e.g. measure its new size. Note that some widgets do internal adjustments after the resize event. If that is relevant, the Widget#resized event can be used instead.

resized

Source:
Inherited From:

The resized event is emitted after each rendering frame, which was triggered by a resize event.

scalechanged

Source:

Gets fired when an option the rendering depends on was changed

Parameters:
Name Type Description
key string

The name of the option which changed the Scale.
value mixed

The value of the option.

set

Source:
Inherited From:

The set event is emitted when an option was set using the Widget#set method. The arguments are the option name and its new value.

Note that this happens both for user interaction and programmatical option changes.

show

Source:
Inherited From:

The show event is emitted when a widget is shown and is being rendered. This is the counterpart to Widget#hide.

visibility

Source:
Inherited From:

Is fired when the visibility state changes. The first argument is the visibility state, which is either true or false.