JavaScript/jQuery CircularGauge Events
This section describes events fired by this widget.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
disposing
Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
Event
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if you use Knockout. |
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
drawn
Raised when the widget's rendering has finished.
Event
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if you use Knockout. |
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
exported
Raised after data from the widget is exported.
Event
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if you use Knockout. |
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
exporting
Raised before data from the widget is exported.
Event
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if you use Knockout. |
|
fileName |
The name of the file to which the widget is about to be exported. |
|
cancel |
Allows you to prevent exporting. |
|
format |
The resulting file format. One of PNG, PDF, JPEG, SVG and GIF. |
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
fileSaving
Raised before a file with exported data is saved on the user's local storage.
Event
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
fileName |
The name of the file to be saved. |
|
format |
The format of the file to be saved. |
|
data |
Exported data as a BLOB. |
|
cancel |
Allows you to prevent file saving. |
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
incidentOccurred
Raised when an error or warning appears in the widget.
Event
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if you use Knockout. |
|
target | any |
Information on the occurred incident. |
Main article: onIncidentOccurred
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
initialized
Raised only once, after the widget is initialized.
Event
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
Main article: onInitialized
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
optionChanged
Raised after a widget option is changed.
Event
Information about the event.
Name | Type | Description |
---|---|---|
name |
The option's short name. |
|
model |
The model data. Available only if you use Knockout. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The widget's instance. |
|
fullName |
The option's full name. |
|
value | any |
The option's new value. |
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
tooltipHidden
Fires when an indicator's tooltip becomes hidden.
Event
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if you use Knockout. |
|
target |
Information on the (sub)value indicator being pressed or hovered over with the mouse pointer. Contains the type ("value-indicator" or "subvalue-indicator") and index (undefined for value indicators) fields. |
The indicator's tooltip becomes invisible when a user hovers the mouse cursor over another indicator or moves it outside the widget.
When a tooltip is made hidden, you can perform specific actions by handling this event. To do this, implement a handling function and assign it to the onTooltipHidden option. When implementing a handling function, use the object passed to it as its parameter. This object will provide you with the widget instance, its container and the object describing the hovered indicator. You can use its index field to get the index of the hovered subvalue indicator (the index of the main value indicator is undefined).
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
tooltipShown
Fires when an indicator's tooltip appears.
Event
Information about the event.
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if you use Knockout. |
|
target |
Information on the (sub)value indicator being pressed or hovered over with the mouse pointer. Contains the type ("value-indicator" or "subvalue-indicator") and index (undefined for value indicators) fields. |
The tooltip appears when a user hovers the mouse cursor over an indicator.
When a tooltip appears, you can perform specific actions by handling this event. To do this, implement a handling function and assign it to the onTooltipShown option. When implementing this function, use the object passed to it as its parameter. This object will provide you with the widget instance, its container and the object describing the hovered indicator. You can use its index field to get the index of the hovered subvalue indicator (the index of the main value indicator is undefined).
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
If you have technical questions, please create a support ticket in the DevExpress Support Center.