Skip to content

jQuery: Add Event Handler Component Instance Info (#8563) #8577

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arman-boyakhchyan merged 1 commit into from
Mar 20, 2026
Merged

jQuery: Add Event Handler Component Instance Info (#8563) #8577

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 19 additions & 8 deletions ... Components/20 Component Configuration Syntax/13 Get a UI Component Instance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,34 @@
Use the following code to get a UI component instance:

<!--JavaScript-->
var chartInstance = $("#chartContainer").dxChart("instance");
<!-- tab: index.js -->
var chartInstance = $("#chart-container").dxChart("instance");

If the UI component is not yet instantiated, this code throws an [E0009](/api-reference/50%20Common/utils/zz%20Errors%20and%20Warnings/E0009.md '/Documentation/ApiReference/Common/utils/Errors_and_Warnings/#E0009') exception that you can handle with a [try...catch](https://www.w3schools.com/js/js_errors.asp) block:

<!--JavaScript-->
<!-- tab: index.js -->
try {
var chartInstance = $("#chartContainer").dxChart("instance");
var chartInstance = $("#chart-container").dxChart("instance");
}
catch (err) {
alert("Exception handled: " + err.message);
}

Instead of the exception, you can get a truthy or falsy value that can be used in conditional statements. To do this, call the UI component class's static **getInstance(element)** method. This method returns **undefined** if the UI component is not instantiated for the element:
Instead of an exception, you can get a truthy or falsy value for use in conditional statements. Call the UI component class’s static **getInstance(element)**. This method returns **undefined** if no UI component instance is associated with the element:

<!--JavaScript-->
var element = document.getElementById("chartContainer");
<!-- tab: index.js -->
var element = document.getElementById("chart-container");
var chartInstance = DevExpress.viz.dxChart.getInstance(element);
if (chartInstance) {
// Your code goes here
}
}

You can also get component instances in event handlers such as **onInitialized** or **onOptionChanged**:

<!-- tab: index.js -->
$('#data-grid-container').dxDataGrid({
onInitialized(e) {
let dataGridInstance = e.component;
// ...
}
// ...
})
Loading