Events

This section describes events fired by this widget.

See Also

disposing

Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget instance.

element

jQuery

The widget's container.

model

Object

The model data. Available only if you use Knockout.

Main article: onDisposing

See Also

drawn

Fires when the widget has finished drawing itself.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.

element

Object

The widget's container.

Cannot be used in themes.

See Also

exported

Fires after data from the widget is exported.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.

element

jQuery

The widget's container.

model

Object

Data that is available for binding against the element. Available only in Knockout and AngularJS approaches.

To perform a custom action after data from the widget is exported, implement a handler for this event. For example, this handler can notify the user that the exporting has been completed. Within this handler, you can use the object passed to it as the parameter.

See Also

exporting

Fires before data from the widget is exported.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.

element

jQuery

The widget's container.

model

Object

Data that is available for binding against the element. Available only in the Knockout approach.

fileName

String

The name of the file to which the widget is about to be exported.

cancel

Boolean

Assign true to this field if you need to prevent exporting.

format

String

The resulting file format. One of PNG, PDF, JPEG, SVG and GIF.

To perform a custom action before data from the widget is exported, implement a handler for this event. Within this handler, you can use the object passed to it as the parameter. For example, using the cancel field of this object, you can cancel exporting.

See Also

fileSaving

Fires before a file with exported data is saved on the user's local storage.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.

element

jQuery

The widget's container.

fileName

String

The name of the file to be saved.

format

String

The format of the file to be saved.
Possible Values: 'PNG' | 'PDF' | 'JPEG' | 'SVG' | 'GIF'

data

BLOB

Exported data as a BLOB.

cancel

Boolean

Assign true to this field if you need to prevent the file from being saved.

To perform a custom action before a file with exported data is saved on the user's local storage, implement a handler for this event. Within this handler, you can use the object passed to it as the parameter. For example, using the cancel field of this object, you can cancel file saving.

See Also

incidentOccurred

Fires when an error or warning appears in a widget.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's 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.
See Also

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.

element

jQuery

The widget's container.

Main article: onInitialized

See Also

optionChanged

Raised after an option of the widget is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.

name

String

A short name of the option whose value has been changed.

fullName

String

A full name of the option whose value has been changed; contains a full hierarchy of the option.

value any

A new value for the option.

element

jQuery

The widget's container.

model

Object

The model data. Available only if you use Knockout.

Main article: onOptionChanged

See Also

selectedRangeChanged Deprecated

Use the onValueChanged event instead.

Fires when the selected range is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.

element

Object

The widget's container.

startValue

Date

|

Number

The updated start range value.

endValue

Date

|

Number

The updated end range value.

Cannot be used in themes.

valueChanged

Fires when the selected range is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
component

Object

The widget's instance.

element

Object

The widget's container.

value

Array

Two values that represent new start and end values.

previousValue

Array

Two values that represent old start and end values.

Cannot be used in themes.

When implementing a handling function, use the object passed to it as the parameter. Among fields of this object, you can find old and new start and end range values.

The valueChanged event can be fired when a user moves a slider or after he/she has stopped moving it. To specify the required mode, use the behavior.callValueChanged option.

View Demo

See Also