new Panorama(optionsopt)
- Source:
Properties:
Name | Type | Attributes | Default | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options.mode |
String |
<optional> |
"panorama"
|
Mode of the widget:
|
||||||||||||||||||||
options.range |
Number |
<optional> |
100
|
Sets x and y range to {min:-n,max:n}. If more fine grained access is needed, range_x and range_y need to be set directly. |
||||||||||||||||||||
options.digits |
Integer |
<optional> |
1
|
Amount of digits for displaying values in labels. |
||||||||||||||||||||
options.label |
String | Boolean |
<optional> |
""
|
A label for the Chart.
Set to |
||||||||||||||||||||
options.label_position |
String |
<optional> |
"top-left"
|
Position of the
label inside of the chart. Possible values are
|
||||||||||||||||||||
options.key |
Boolean | String |
<optional> |
false
|
If set to a string
a key is rendered into the chart at the given position. The key
will detail names and colors of the graphs inside of this chart.
Possible values are |
||||||||||||||||||||
options.key_size |
Object |
<optional> |
{x:20,y:10}
|
Size of the colored rectangles inside of the key describing individual graphs. (Defined in Chart) |
||||||||||||||||||||
options.grid_x |
Array.<Object> |
<optional> |
[]
|
An array containing objects with the following optional members to draw the grid: (Defined in Chart) Properties
|
||||||||||||||||||||
options.grid_y |
Array.<Object> |
<optional> |
[]
|
An array containing objects with the following optional members to draw the grid: (Defined in Chart) Properties
|
||||||||||||||||||||
options.show_grid |
Boolean |
<optional> |
true
|
Set to |
||||||||||||||||||||
options.range_x |
function | Object |
<optional> |
{}
|
Either a function returning a Range or an object containing options for a new Range. (Defined in Chart) |
||||||||||||||||||||
options.range_y |
function | Object |
<optional> |
{}
|
Either a function returning a Range or an object containing options for a new Range. (Defined in Chart) |
||||||||||||||||||||
options.range_z |
Object | function |
<optional> |
{ scale: "linear", min: 0, max: 1 }
|
Either a function returning a Range or an object containing options for a new Range. (Defined in Chart) |
||||||||||||||||||||
options.importance_label |
Number |
<optional> |
4
|
Multiplicator of square pixels on hit testing labels to gain importance. (Defined in Chart) |
||||||||||||||||||||
options.importance_handle |
Number |
<optional> |
1
|
Multiplicator of square pixels on hit testing handles to gain importance. (Defined in Chart) |
||||||||||||||||||||
options.importance_border |
Number |
<optional> |
50
|
Multiplicator of square pixels on hit testing borders to gain importance. (Defined in Chart) |
||||||||||||||||||||
options.handles |
Array.<Object> |
<optional> |
[]
|
An array of options for creating ChartHandle on init. (Defined in Chart) |
||||||||||||||||||||
options.show_handles |
Boolean |
<optional> |
true
|
Show or hide all handles. (Defined in Chart) |
||||||||||||||||||||
options.square |
Boolean |
<optional> |
false
|
Keep the Graph as a square. (Defined in Chart) |
||||||||||||||||||||
options.title |
String |
<optional> |
""
|
A string to be set as title attribute on the main element to be displayed as tooltip. (Defined in Widget) |
||||||||||||||||||||
options.disabled |
Boolean |
<optional> |
false
|
Toggles the class |
||||||||||||||||||||
options.active |
Boolean |
<optional> |
Toggles the class |
|||||||||||||||||||||
options.visible |
Boolean |
<optional> |
Toggles the class |
|||||||||||||||||||||
options.needs_resize |
Boolean |
<optional> |
true
|
Set to true if the resize function shall be called before the next redraw. (Defined in Widget) |
||||||||||||||||||||
options.dblclick |
Boolean |
<optional> |
400
|
Set a time in milliseconds for triggering double click event. If 0, no double click events are fired. (Defined in Widget) |
||||||||||||||||||||
options.preset |
String |
<optional> |
Set a preset. This string
gets set as class attribute |
|||||||||||||||||||||
options.presets |
Object |
<optional> |
{}
|
An object with available preset
specific options. Refer to |
||||||||||||||||||||
options.notransitions_duration |
number |
<optional> |
500
|
A time in milliseconds until transitions are activated. (Defined in Widget) |
Panorama is a Chart with a single handle to set panorama or balance on stereo and surround channels.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
options |
Object |
<optional> |
{ }
|
An object containing initial options. |
Extends
Members
_graphs :SVGGroup
- Source:
- Inherited From:
The SVG group containing all graphs.
Has class .aux-graphs
.
Type:
- SVGGroup
_handles :SVGGroup
- Source:
- Overrides:
The SVG group containing all handles.
Has class .aux-handles
.
Type:
- SVGGroup
_key :SVGGroup
- Source:
- Inherited From:
The SVG group containing all descriptions.
Has class .aux-key
.
Type:
- SVGGroup
_key_background :SVGRect
- Source:
- Inherited From:
The SVG rectangle of the key.
Has class .aux-background
.
Type:
- SVGRect
_label :SVGText
- Source:
- Inherited From:
The label of the chart.
Has class .aux-label
.
Type:
- SVGText
element :SVGElement
- Source:
- Overrides:
The main SVG image.
Has class .aux-panorama
.
Type:
- SVGElement
graphs :Array
- Source:
- Inherited From:
An array containing all SVG paths acting as graphs.
Type:
- Array
grid :Grid
- Source:
- Inherited From:
The grid element of the chart.
Has class .aux-grid
.
Type:
handle1 :ChartHandle
- Source:
The ChartHandle
displaying/setting the position on panorama and surround modes.
In panorama mode it affects the x
parameter, in surround it
affects both, x
and y
parameters.
Type:
handle2 :ChartHandle
- Source:
The ChartHandle
displaying/setting the position of the second channel in balance
mode. It affects the y
parameter.
Type:
handles :Array
- Source:
- Inherited From:
An array containing all ChartHandle instances.
Type:
- Array
range_x :Range
- Source:
- Inherited From:
The Range for the x axis.
Type:
range_y :Range
- Source:
- Inherited From:
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. |
addEventListener(event, func)
- Source:
- Inherited From:
Register an event handler.
Parameters:
Name | Type | Description |
---|---|---|
event |
string | The event descriptor. |
func |
function | The function to call when the event happens. |
addGraph(graph) → {Object}
- Source:
- Inherited From:
Add a graph to the chart.
Parameters:
Name | Type | Description |
---|---|---|
graph |
Object | The graph to add. This can be either an instance of Graph or an object of options to Graph. |
Fires:
Returns:
The instance of Graph.
- Type
- Object
addHandle(optionsopt, typeopt)
- Source:
- Inherited From:
Add a new handle to the widget. Options is an object containing options for the ChartHandle.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
options |
Object |
<optional> |
{ }
|
An object containing initial options. - The options for the ChartHandle. |
type |
Object |
<optional> |
ChartHandle
|
A widget class to be used as the new handle. |
Fires:
addHandles(options, typeopt)
- Source:
- Inherited From:
Add multiple new ChartHandle to the widget. Options is an array of objects containing options for the new instances of ChartHandle.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
options |
Array.<Object> | An array of options objects for the ChartHandle. |
||
type |
Object |
<optional> |
ChartHandle
|
A widget class to be used for the new handles. |
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. |
delegateEvents(element) → {HTMLElement}
- Source:
- Inherited From:
Delegates all occuring DOM events of a specific DOM node to the widget. This way the widget fires e.g. a click event if someone clicks on the given DOM node.
Parameters:
Name | Type | Description |
---|---|---|
element |
HTMLElement | The element all native events of the widget should be bound to. |
Fires:
Returns:
The element
- Type
- HTMLElement
destroy()
- Source:
- Inherited From:
Destroys all event handlers and the options object.
disableTansitions()
- Source:
- Inherited From:
Disable CSS transitions.
dispatchEvent(event, …args)
- Source:
- Inherited From:
Fires an event.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
event |
string | The event descriptor. |
|
args |
* |
<repeatable> |
Event arguments. |
empty()
- Source:
- Inherited From:
Remove all graphs from the chart.
Fires:
enableDraw()
- Source:
- Inherited From:
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().
get(key)
- Source:
- Inherited From:
Get the value of an option.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The option name. |
getDefault()
- Source:
- Inherited From:
Returns the default value of a given option. If the option does not exist, an exception is thrown.
getOptionType()
- Source:
- Inherited From:
Returns the type of an option. If the given option does not exist, 'undefined' is returned.
getStyle()
- Source:
- Inherited From:
Returns the computed style of this widget's DOM element.
hasEventListeners(event) → {boolean}
- Source:
- Inherited From:
Test if the event descriptor has some handler functions in the queue.
Parameters:
Name | Type | Description |
---|---|---|
event |
string | The event desriptor. |
Returns:
True if the event has some handler functions in the queue, false if not.
- Type
- boolean
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.
off(event, fun)
- Source:
- Inherited From:
Removes the given function from the event queue. If it is a native DOM event, it removes the DOM event listener as well.
Parameters:
Name | Type | Description |
---|---|---|
event |
string | The event descriptor. |
fun |
function | The function to remove. |
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. |
removeGraph(graph)
- Source:
- Inherited From:
Remove a graph from the chart.
Parameters:
Name | Type | Description |
---|---|---|
graph |
Graph | The Graph to remove. |
Fires:
removeHandle(handle)
- Source:
- Inherited From:
Remove a handle from the widget.
Parameters:
Name | Type | Description |
---|---|---|
handle |
ChartHandle | The ChartHandle to remove. |
Fires:
removeHandles(handles)
- Source:
- Inherited From:
Remove multiple or all ChartHandle from the widget.
Parameters:
Name | Type | Description |
---|---|---|
handles |
Array.<ChartHandle> | An array of
ChartHandle instances. If the argument reveals to
|
reset(key)
- Source:
- Inherited From:
Resets an option to its default value.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The option name. |
set(key, value)
- Source:
- Inherited From:
Sets an option.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The option name. |
value |
The option value. |
setOptions(optionsopt)
- Source:
- Inherited From:
Merges a new options object into the existing one, including deep copies of objects. If an option key begins with the string "on" it is considered an event handler. In this case the value should be the handler function for the event with the corresponding name without the first "on" characters.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
options |
Object |
<optional> |
{ }
|
An object containing initial options. |
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.
update(key, value)
- Source:
- Inherited From:
Conditionally sets an option unless it already has the requested value.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The name of the option. |
value |
mixed | The value of the option. |
Fires:
userset(key, value)
- Source:
- Inherited From:
Sets an option by user interaction. Emits the userset
event. The userset
event can be cancelled (if an event handler
returns false
), in which case the option is not set.
Returns true
if the option was set, false
otherwise. If the option was set, it will emit a useraction
event.
Parameters:
Name | Type | Description |
---|---|---|
key |
string | The name of the option. |
value |
mixed | The value of the option. |
Fires:
- Base#event:userset
- Base#event:useraction
visibleChildren()
- Source:
- Inherited From:
Returns an array of all visible children.
Events
delegated
- Source:
- Inherited From:
Is fired when an element is delegated.
Parameters:
Name | Type | Description |
---|---|---|
element |
HTMLElement | Array | The element which receives all native DOM events. |
old_element |
HTMLElement | Array | The element which previously received all native DOM 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 |
emptied
- Source:
- Overrides:
Is fired when all graphs are removed from the chart.
GenericDOMEvents
- Source:
- Inherited From:
Generic DOM events. Please refer to W3Schools for further details.
graphadded
- Source:
- Inherited From:
Is fired when a graph was added. Arguments are the graph and its position in the array.
Parameters:
Name | Type | Description |
---|---|---|
graph |
Graph | The Graph which was added. |
id |
int | The ID of the added Graph. |
graphremoved
- Source:
- Inherited From:
Is fired when a graph was removed. Arguments are the graph and its position in the array.
Parameters:
Name | Type | Description |
---|---|---|
graph |
Graph | The Graph which was removed. |
id |
int | The ID of the removed Graph. |
handleadded
- Source:
- Inherited From:
Is fired when a new handle was added.
Parameters:
Name | Type | Description |
---|---|---|
handle |
ChartHandle | The ChartHandle which was added. |
handleremoved
- Source:
- Inherited From:
Is fired when a handle was removed.
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.
set_[option]
- Source:
- Inherited From:
Is fired when an option is set.
Parameters:
Name | Type | Description |
---|---|---|
value |
mixed | The value of the option. |
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
.