Events

This section describes events exposed by this widget.

To handle events, use one of the following methods.

  • Attach a handler to a widget option
    Assign a callback function to the widget option that takes on a handler for the required event. The events that can be handled within the widget's configuration object are listed in the Configuration section. All these events have names starting with on.

  • Attach several handlers for one or several events to a widget
    Specify event handling functions for one or more events using the on() method. All the widget events are listed in the Events section.

disposing

Fires when you dispose of this component.

Event Handler Argument:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

drawn

Fires when the widget has finished drawing itself.

Event Handler Argument:

Information about the event.

Object structure:
component: Object

The widget instance.

element: Object

The widget's container.

Cannot be used in themes.

To learn how to handle widget events, see the Handle Events topic.

incidentOccurred

Fires when an error or warning appears in a widget.

Event Handler Argument:

Information about the event.

Object structure:
component: Object

The widget instance.

element: Object

The widget's container.

target: Object

Information about the occurred incident.

When implementing a handling function for this event, you can access information about the occurred incident using the target field of the function's argument. This information includes the following.

  • id
    Contains the ID of the incident. The full list of IDs can be found in the Errors and Warnings section.
  • type
    Contains the type of the incident. This field equals 'error' for errors or 'warning' for warnings.
  • args
    Contains the argument of the incident's message. The content of this field varies greatly, depending on the incident. For example, it may contain the name of the data source field that was not specified correctly, or the name of the option that was not set properly.
  • text
    Contains the text passed to the browser console. This text includes the content of the args field, if there is any.
  • widget
    Contains the name of the widget that produced the error or warning.
  • version
    Contains the currently used version of the ChartJS library.

For more information about handling widget events, see the Handle Events topic.

optionChanged

Fires after an option of the component is changed.

Event Handler Argument:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

value: any

Specifies a new value for the option.