Chart
You have to go through a three-step form wizard to enable this
Control, i.e., Design, API & Advance. Let’s explain these
steps below:
1st Step – Design
-
Key (mandatory): Unique identifier for the chart data.
-
Label (mandatory): Display label for the chart element.
-
Name (mandatory): Name of the chart or data series.
-
Column Width: Define the width of the chart columns.
-
Data Series: Select the type of data series to visualize.
-
Chart Type: Choose a chart type such as Bar Charts, Pie Charts, Line/Area Charts, or Other Charts.
-
Dimensions: Configure the dimensions of the chart.
-
Fit Container: Enable the chart to fit its container.
-
Color Scheme: Configure the colors used in the chart.
-
Color: Select the primary color for the chart.
-
Options: Additional display and behavior settings for the chart.
-
Show X Axis: Enable or disable the X-axis display.
-
Show Y Axis: Enable or disable the Y-axis display.
-
Show Grid Lines: Display grid lines on the chart.
-
Round Domains: Round the domain values for the chart.
-
Gradient: Apply a gradient effect to the chart.
-
Show Legend: Enable or disable the chart legend.
-
Legend Position: Set the position of the legend on the chart.
-
Round Edges: Round the edges of bars or shapes in the chart.
-
Tooltip Disabled: Disable tooltips on hover.
-
Show X Axis Label: Enable or disable the label for the X-axis.
-
Display Text: Set the text to display on the chart.
-
X Axis Label: Define the label for the X-axis.
-
Y Axis Label: Define the label for the Y-axis.
2nd Step – API
- Data
- Bind with data model: This step involves linking the component to a data model for dynamic content binding.
-
Choose Data Source: Select data source from the following AI, HTTP, Workflow, No SQL, or RDBMS.
-
HTTP: A data source type for retrieving data through HTTP requests.
- Data Connection: The configuration used to establish a connection to the data source.
-
Method (mandatory): Select method from the following GET, PUT, POST, PATCH, DELETE, or POCO. This determines the type of HTTP request to send.
- API URL (mandatory): The URL endpoint for the API being called.
-
Query Parameters: Optional parameters included in the API request to filter or modify the response.
- Key: The name of the query parameter.
- Value: The value assigned to the query parameter.
- Query Variable: A variable used in the query parameter.
- Select Type: The type of query parameter (e.g., string, number, etc.).
-
Headers: Additional metadata sent with the request.
- Name: The name of the header.
- Value: The value assigned to the header.
-
Others: Additional settings for the HTTP request.
- Enable raw query: Option to send a raw query without formatting.
- Response Attribute: The data or property that will be returned in the response from the API or data source.
- Mapping
-
API Field Mapping: A process to map API data fields to chart or binding fields.
- Chart Field: Select option from the dropdown menu. This is the field in the chart that corresponds to a data value.
- Binding Field: Select option from the dropdown menu. This field binds the data from the API to the chart.
- Chart Click Filter: A filter triggered by a click on the chart to refine or narrow down the data displayed.
- Is Collection: Indicates whether the field represents a collection of data (e.g., an array of items).
-
Collection Field Mapping: Mapping fields for collections of data, typically in key-value pairs.
- Enter Key: The key representing the unique identifier or field name in the collection.
- Enter Value: The value corresponding to the key, representing the data associated with it.
3rd Step – Advance
- Design
- No. of Column (mandatory): Specifies the number of columns to be displayed. This field is required for layout configuration.
- Height: Defines the height of the component or chart, allowing for customization of its vertical size.
- Hide Data Tab: Option to hide the data tab from the interface, preventing users from accessing raw data directly.
- Hide Chart Tab: Option to hide the chart tab from the interface, preventing users from switching to the chart view.
- Others
-
No Data Configuration: Configuration options for displaying content when no data is available.
- No Data Image URL: The URL for the image displayed when no data is present.
- Background Color: The color of the background to be used when there is no data.
- Image Width: Defines the width of the image displayed in the "No Data" view.
- Cover Height: The height of the cover or placeholder image displayed when no data is available.
- Title: A title message shown when no data is available, often used to inform the user.
- Message: A custom message displayed along with the title when there is no data.
Click “Confirm” and “Chart” control is
configured.