Basic column chart (v3.0 or later)

Chart style

The basic column chart is a type of column chart. Compared to the radial bar chart, the basic column chart widget supports custom y-axis intervals and data configuration for multiple data series. It can display multi-dimensional data differences more intelligently, but it takes up more space in a visualization application.

Configuration panel

• Search for Configurations: In the right-side panel of Canvas Editor, click the Settings tab, and click Search for Configurations in the upper-right corner. Enter the required configuration item in the search box, and click the search icon to quickly locate the configuration item. Fuzzy match is supported. For more information, see Search for Configurations.
• Size: indicates the size of a widget, including its pixel width and height. You can click the icon to proportionally adjust the width and height of a widget. After you click this icon again, you can adjust the width and height as needed.
• Position: the position of a widget, which is indicated by pixel X and Y coordinates. X-coordinate indicates the pixel distance between the upper-left corner of the widget and the left border of the canvas. Y-coordinate indicates the pixel distance between the upper-left corner of the widget and the upper border of the canvas.
• Rotation Angle: the angle of a rotation that uses the center point of a widget as the rotation point. The unit is degrees (°). You can use one of the following methods to control the rotation angle of a widget:
  • Directly enter the degrees in the Rotation Angle spin box or click the plus sign (+) or minus sign (-) to increase or decrease the value in the Rotation Angle spin box.
  • Drag the black dot in the icon.
  • Click the icon to horizontally flip a widget.
  • Click the icon to vertically flip a widget.
• Opacity: the opacity of a widget. Valid values: 0 and 1. If this parameter is set to 0, the widget is hidden. If this parameter is set to 1, the widget is completely displayed. Default value: 1.

• Chart

  • Margin: Specifies the distance between the column chart area and the top, bottom, left, and right borders of the widget. The default unit is px.

  • Maximum Load: Specifies the maximum number of data records that the system can load for layout, rendering, and calculation to ensure the performance of the visualization application.

  • Column Style: Specifies the style of each column in the chart.

    Background Color: Specifies the background color of the columns. For more information about how to change the color, see Color picker.

  • Value Label: Specifies the style of the value label for each column. You can click the icon to show or hide the value labels.

    Parameter	Description
    Text	The font, weight, size, and color of the value label text.
    Position	The position of the value label text. Valid values: Top, Middle, and Bottom.
    Empty Value Data	Turn on this switch to display value labels even if the data is empty. Turn off this switch to hide value labels if the data is empty.

• Axes: Specifies the axes of the widget, including the x-axis and the y-axis.

  • x-axis

    • Show x-axis: You can turn on this switch to show the x-axis or turn it off to hide the x-axis.

    • Padding: Specifies the padding on the left and right sides of the x-axis. The value can be from 0 to 1.

    • Interval: Specifies the interval between columns on the x-axis. A larger value results in thinner columns and a wider interval. The value can be from 0 to 0.95.

    • Axis Label: Specifies the style of the x-axis labels. You can click the icon to show or hide the x-axis labels.

      Parameter	Description
      Text	The font, weight, size, and color of the x-axis label text.
      Axis Label Display	Angle: The angle of the x-axis labels. Valid values: Horizontal, Slanted, and Vertical. Quantity: The number of x-axis labels. Axis Unit: The unit of the x-axis labels.

    • Axis Line: Specifies the style of the x-axis line. You can click the icon to show or hide the x-axis line.

      Color: Specifies the color of the x-axis line.

    • Gridline: Specifies the style of the x-axis gridlines. You can click the icon to show or hide the x-axis gridlines.

      Color: Specifies the color of the x-axis gridlines.

  • y-axis

    • Show y-axis: You can turn on this switch to show the y-axis or turn it off to hide the y-axis.

    • Range: Specifies the minimum and maximum values for the y-axis.

      Parameter	Description
      Minimum	The minimum value for the y-axis. You can enter a custom value or select one of the following options: 0: The system sets the minimum value of the y-axis to 0 by default. Data Min: Uses the minimum value from the data. Auto Round: The system automatically calculates the value based on the maximum and minimum values in the data and the number of data points.
      Maximum	The maximum value for the y-axis. You can enter a custom value or select one of the following options: Data Max: Uses the maximum value from the data. Auto Round: The system automatically calculates the value based on the maximum and minimum values in the data and the number of data points.

    • Axis Label: Specifies the style of the y-axis labels. You can click the icon to show or hide the y-axis labels.

      Parameter	Description
      Display Format	The display format for the y-axis label values. Valid values: Default, 11 (integer), 11.1 (floating-point number), 11.11 (floating-point number), 11%, 11.1%, and 11.11%.
      Text	The font, weight, size, and color of the y-axis label text.
      Axis Label Display	The number and unit of the y-axis labels.

    • Axis Line: Specifies the style of the y-axis line. You can click the icon to show or hide the y-axis line.

      Color: Specifies the color of the y-axis line.

    • Gridline: Specifies the style of the y-axis gridlines. You can click the icon to show or hide the y-axis gridlines.

      Color: Specifies the color of the y-axis gridlines.

• Series

  • Convert Series to Type

    • You can turn on this switch to convert the data series mode to the type mode. This feature must be used with the s field in your data. The s field defines the column type, which corresponds to the data series. The style of each column must be one of the available types, and each category can represent only one type.

    • You can turn off this switch to use the data series mode. This feature must be used with the s field in your data. The s field defines the column type, which corresponds to the data series. For example, if you configure two series, two columns are displayed for each category. Even if the value of a column is 0, it still occupies a column's position.

  • Data Series: You can click the or icon on the right to add or delete a data series. You can click the or icon to configure the arrangement of multiple data series. You can click the icon to copy the configuration of the current data series and add a new data series with the same configuration.

    Color: Specifies the color of the columns in the series.

• Other

  • Easing Animation: Specifies the animation effect of the column chart. You can click the icon to enable or disable the animation effect.

    Parameter	Description
    Animation Settings	Easing Effect: The easing effect of the animation. The system provides a variety of common animation easing effects. Animate Series Sequentially: Turn on this switch to play animations for each series in sequence. Turn off this switch to play animations for all columns at the same time.
    Entrance Animation	The duration of the first rendering animation of the widget, in ms.
    Update Animation	Update Animation Duration: The duration of the animation when the widget data is updated, in ms. Start from Previous Position: Turn on this switch to start the animation from the position of the previous data when the widget data is updated. Turn off this switch to start the animation from the initial position when the widget data is updated.

  • Tooltip: Specifies the style of the tooltip that appears when you hover over or click a column on the preview or publish page. You can click the icon to enable or disable the tooltip.

    Parameter	Description
    Disappear Delay	The tooltip disappears when the trigger condition is not met. This parameter specifies the delay before the tooltip disappears, in ms.
    Trigger Methods	Trigger Type: The target type that triggers the tooltip. Valid values: Data Item and Axis. Trigger Action: The action that triggers the tooltip. Valid values: Hover and Click.
    Text Style	The style of the text in the tooltip, including the font, weight, size, and color.
    Background Box Style	The style of the tooltip's background box. Background Color: The background color of the tooltip. Custom: The width and height of the tooltip, in px. Click the icon to enable or disable the custom tooltip. Padding: The internal padding of the tooltip, in px. Offset Horizontal Offset: The horizontal offset of the tooltip relative to the mouse pointer, in px. Vertical Offset: The vertical offset of the tooltip relative to the mouse pointer, in px. Border Border Width: The width of the tooltip border, in px. Border Color: The color of the tooltip border.

Data panel

Field description

Table 1. Parameters

Parameter	Description
Controlled Mode	If you turn on the switch, data is not requested when a widget is initialized. Data requests are triggered only based on callback IDs or the method configured in Blueprint Editor. If you turn off the switch, data requests are automatically triggered. By default, the switch is turned off.
Auto Data Request	After you select the Auto Data Request check box, you can enable dynamic polling, and manually specify the polling interval. If you do not select this check box, data is not automatically requested. You must manually refresh the page to request data or use Blueprint Editor or callback ID events to trigger data requests.
Data Source	In the right-side panel of Canvas Editor, click the Data tab. Click Set next to Static Data. In the Configure Datasource panel, select a data source from the Data Source Type drop-down list. Enter code for data query in the code editor, click Preview Data Response to preview the response of the data source, and then view the response. For more information, see Configure asset data.
Data Filter	If you select the Data Filter check box, you can convert the data structure, filter data, and perform simple calculations. If you click the plus sign (+) next to Add Filter, you can configure the script for the data filter in the editor that appears. For more information, see Use the data filter.
Data Response Result	The response to a data request. If the data source changes, you can click the icon next to Data Response Result to view the data response in real time.

Interaction panel

You can select Enable to turn on the interaction feature for the widget. When you click a column in the basic column chart, a data request is triggered, a callback value is returned, and the data for different columns is dynamically loaded. By default, the x, y, and s values from the data are returned. For more information about the configuration, see Configure a callback ID for a ticker board widget.

Blueprint editor interaction configuration

1. On the canvas editor page, you can right-click the widget and select Export to Blueprint Editor.

2. Click the icon in the upper-left corner of the page.

3. On the blueprint editor configuration page, click the Basic Column Chart widget in the Imported Nodes pane. The following figure shows the configuration parameters of the basic column chart in the blueprint editor.

   • Events

     Event	Description
     When Basic Column Chart API Request Succeeded	This event is triggered when the data API request is successfully returned and processed by the filter. The processed data is returned in JSON format. For a data example, see the Data Response section on the Data tab of the widget's configuration panel in the canvas editor.
     When Basic Column Chart API Request Failed	This event is triggered when the data API request fails because of network issues or API errors and is processed by the filter. The processed data is returned in JSON format. For a data example, see the Data Response section on the Data tab of the widget's configuration panel in the canvas editor.
     When Data Item Clicked	This event is triggered when you click a column in the basic column chart. The data item that corresponds to the column is also returned.

   • Actions

     Action	Description
     Request basic column chart API	Requests data from the server again. Data from input data processing nodes or layer nodes is used as parameters. For example, if the API data source for the basic column chart is https://api.test and the data passed to the Request basic column chart API action is { id: '1'}, the final API request is https://api.test?id=1.
     Import basic column chart data	Processes data in the format required by the component, then imports the data to redraw the chart. This action does not request data from the server. For a data example, see the Data Response area on the Data tab in the component's configuration pane in the canvas editor.
     Highlight	Highlights the element that corresponds to a data item. The following is a data example. return { "data": {}, "options": { "style": { "stroke": "#f00", "fill": "" }, "selectMode": "single", "cancelHighlightFirst": false } }
     Remove highlight	Removes the highlight from the element that corresponds to a data item. The following is a data example. return { "data": {}, "options": { "mode": "single" } }
     Clear component	Clears the component's data. This action requires no parameters.
     Update component configuration	Updates the component's style configuration dynamically. In the component's Configuration pane, click Copy Configuration to Clipboard to get the configuration data. Then, in the data processing node on the blueprint editor's configuration page, change the style field values as needed.
     Show	Shows the component. The following is a data example. return{ "animationType": "", "animationDuration": 1000, "animationEasing": "linear" }
     Hide	Hides the component. The following is a data example. return{ "animationType": "", "animationDuration": 1000, "animationEasing": "linear" }
     Toggle visibility	Switches the component between visible and hidden. The following is a data example. return { "animationIn": { "animationType": "", "animationDuration": 1000, "animationEasing": "linear" }, "animationOut": { "animationType": "", "animationDuration": 1000, "animationEasing": "linear" } }
     Move	Moves the component to a specified position. The following is a data example. return{ // Movement method. 'to': absolute positioning, 'by': relative positioning. Default: 'to'. "positionType": "to", // Target position (x and y coordinates). "attr": { "x": 0, "y": 0 }, // Animation settings. "animation": { "enable": false, // Animation duration. "animationDuration": 1000, // Animation curve. Valid values: linear, easeInOutQuad, or easeInOutExpo. "animationEasing": "linear" } }