JsonDataSource.RootElement Property

Gets or sets the name of the root element in the associated data source.

Namespace: DevExpress.DataAccess.Json

Assembly: DevExpress.DataAccess.v24.1.dll

NuGet Packages: DevExpress.DataAccess, DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap

Declaration

C#

[TypeConverter("DevExpress.DataAccess.UI.Native.NoConvertableFromStringConverter,DevExpress.DataAccess.v24.1.UI, Version=24.1.99.0, Culture=neutral, PublicKeyToken=c38a27d2243c2672")]
public string RootElement { get; set; }

VB.NET

<TypeConverter("DevExpress.DataAccess.UI.Native.NoConvertableFromStringConverter,DevExpress.DataAccess.v24.1.UI, Version=24.1.99.0, Culture=neutral, PublicKeyToken=c38a27d2243c2672")>
Public Property RootElement As String

Property Value

Type	Description
String	The root element’s name.

Remarks

This property is used to determine the element in the target JSON object from which data should be retrieved.

This property is set to the root element of the target JSON object by default. You can set this property to any JSON node included in the retrieved JSON data.

Note

The BI Dashboard does not support collection field types. Make sure that the root of a JSON data source has a property with a non-collection type.

If you need to use multiple collections in a single data source, merge them into a single data source. To do this, use the DashboardFederationDataSource class to create a Transformation Query.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the RootElement property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-dashboard-json-data-source/CS/DashboardJsonExample/Form1.cs#L51

jsonDataSource.JsonSource = new UriJsonSource(new Uri("https://raw.githubusercontent.com/DevExpress-Examples/DataSources/master/JSON/customers.json"));
jsonDataSource.RootElement = "Customers";
jsonDataSource.Fill();

asp-net-web-forms-dashboard-register-data-sources/CS/WebFormsDashboardDataSources/Pages/JsonDashboard.aspx.cs#L22

jsonDataSourceUrl.ConnectionName = "jsonUrlConnection";
jsonDataSourceUrl.RootElement = "Employee";
dataSourceStorage.RegisterDataSource("jsonDataSourceUrl", jsonDataSourceUrl.SaveToXml());

asp-net-mvc-dashboard-register-data-sources/CS/MvcDashboardDataSources/Configuration/JsonDataSourceConfigurator.cs#L13

jsonDataSourceUrl.JsonSource = new UriJsonSource(new Uri("https://raw.githubusercontent.com/DevExpress-Examples/DataSources/master/JSON/customers.json"));
jsonDataSourceUrl.RootElement = "Customers";
jsonDataSourceUrl.Fill();

DashboardUserBasedMVC/CS/MVCDashboard/Code/CustomDataSourceStorage.cs#L40

jsonDataSource.JsonSource = new UriJsonSource(new Uri("https://raw.githubusercontent.com/DevExpress-Examples/DataSources/master/JSON/customers.json"));
jsonDataSource.RootElement = "Customers";

VB.NET

winforms-dashboard-json-data-source/VB/DashboardJsonExample/Form1.vb#L48

jsonDataSource.JsonSource = New UriJsonSource(New Uri("https://raw.githubusercontent.com/DevExpress-Examples/DataSources/master/JSON/customers.json"))
jsonDataSource.RootElement = "Customers"
jsonDataSource.Fill()

asp-net-web-forms-dashboard-register-data-sources/VB/WebFormsDashboardDataSources/Pages/JsonDashboard.aspx.vb#L22

jsonDataSourceUrl.ConnectionName = "jsonUrlConnection"
jsonDataSourceUrl.RootElement = "Employee"
dataSourceStorage.RegisterDataSource("jsonDataSourceUrl", jsonDataSourceUrl.SaveToXml())

asp-net-mvc-dashboard-register-data-sources/VB/MvcDashboardDataSources/Configuration/JsonDataSourceConfigurator.vb#L13

jsonDataSourceUrl.JsonSource = New UriJsonSource(New Uri("https://raw.githubusercontent.com/DevExpress-Examples/DataSources/master/JSON/customers.json"))
jsonDataSourceUrl.RootElement = "Customers"
jsonDataSourceUrl.Fill()