Grid

Grid

new Grid(optionsopt)

Source:
Properties:
Name Type Attributes Default Description
options.grid_x Array.<(Object|Number)> <optional>
 []

Array for vertical grid lines containing either numbers or objects with the members:

Properties
Name Type Attributes Description
pos Number <optional>

The value where to draw grid line and correspon ding label.
color String <optional>

A valid CSS color string to colorize the elements.
class String <optional>

A class name for the elements.
label String <optional>

A label string.
y_min String <optional>

Start this line at this values position instead of 0.
y_max String <optional>

End this line at this values position instead of maximum height.
options.grid_y Array.<(Object|Number)> <optional>
 []

Array for horizontal grid lines containing either positions or objects with the members:

Properties
Name Type Attributes Description
pos Number <optional>

The value where to draw grid line and corresponding label.
color String <optional>

A valid CSS color string to colorize the elements.
class String <optional>

A class name for the elements.
label String <optional>

A label string.
x_min String <optional>

Start this line at this values position instead of 0.
x_max String <optional>

End this line at this values position instead of maximum width.
options.range_x function | Object <optional>
 {}

A function returning a Range instance for vertical grid lines or an object containing options. for a new Range.
options.range_y function | Object <optional>
 {}

A function returning a Range instance for horizontal grid lines or an object containing options. for a new Range.
options.width Number <optional>
 0

Width of the grid.
options.height Number <optional>
 0

Height of the grid.
options.x_min Number <optional>
 false

Value to start horizontal lines at this position instead of 0.
options.x_max Number <optional>
 false

Value to end horizontal lines at this position instead of maximum width.
options.y_min Number <optional>
 false

Value to start vertical lines at this position instead of 0.
options.y_max Number <optional>
 false

Value to end vertical lines at this position instead of maximum height.

Grid creates a couple of lines and labels in a SVG image on the x and y axis. It is used in e.g. Graph and FrequencyResponse to draw markers and values. Grid needs a parent SVG image do draw into. The base element of a Grid is a SVG group containing all the labels and lines.

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

An object containing initial options.

Extends

Members

element :SVGGroup

Source:

The main SVG group containing all grid elements. Has class .aux-grid.

Type:
  • SVGGroup

range_x :Range

Source:

The range for the x axis.

Type:

range_y :Range

Source:

The range for the y axis.

Type:

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.

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

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:
Overrides:

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.

redraw

Source:
Inherited From:

The redraw event is emitted when a widget is redrawn. This can be used to do additional DOM modifications to a Widget.

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.

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.