How to determine the types of chart widgets used in Bold BI dashboards?
Overview
When working with Bold BI dashboards, it’s essential to understand the types of chart widgets you’re using to display your data effectively. Bold BI offers a variety of widgets, and identifying them can be done through two main methods: utilizing the REST API and inspecting the widget properties directly in the dashboard designer.
Using the REST API to Identify Chart Widget Types
Bold BI includes a RESTful web API that allows for programmatic interaction with the dashboard from third-party applications. To identify the type of chart widget used in a dashboard, you can use the following steps:
-
Get an Access Token: Before making API calls, you need to authenticate the user using the password authentication method. Obtain an access token by following the instructions provided. Password Authentication section of the Bold BI API reference.
-
Make the API Call: With the access token, you can call the
GetWidgetsAPI. Include the access token in the authorization header of your request. The API endpoint will return a response that includes “WidgetInfo,” which specifies the type of widget. For more details on the API call, refer to the Dashboards_GetWidgets section. -
Review the Response: The response from the API will contain information about the widgets used in the dashboard, including their types.
Identifying Widget Types in the Dashboard Editor
Another way to identify chart widget types is directly within the Bold BI dashboard designer:
-
Access the Dashboard: Open the dashboard where the widget is located and go to the properties. Each chart widget has a “Chart Type” property that can be viewed by selecting the change option.
-
View the Widget Type: The “Chart Type” property will display the type of widget being used, such as a spline widget or a bar widget.
By using these methods, you can easily determine the types of chart widgets present in your Bold BI dashboards and make informed decisions about how to best visualize your data.
Additional References
- Bold BI Server API Reference: API Reference
- Bold BI Authentication Guide: Password Authentication
