Chart Settings

You can configure charts to display data from layer fields when the user performs an identify, search or workflow operation.

Charts only appear when the user performs an identify, search, or workflow operation on visible layers, as a set of results (VertiGIS Studio Features) is required to display charts.

To add a chart:

1. While editing your app in Designer, in the Components panel, click + Add Component.

   If the + Add Component button is not visible, you are likely viewing your app's Services; click Components to view the components of your layout.

   The Toolbox panel appears.

2. In the Toolbox panel, click the Other tab.

3. In the Toolbox panel, drag beside theChartcomponent to where you want to place it in the Components panel.

   When adding this component for the first time, there may be a slight delay before it appears in the layout while the component loads.

   The Chart component is added to your layout.

The Chart settings include the following:

• Main Settings

• Chart Settings

• Group By

• Group Values

• Advanced Settings

• Events

• Visibility Filters

• Layout

Main Settings

• Title: Type a title to display for the component. This title is used both in Web and Designer.

• Icon: To select an icon to represent the component, click Select Icon, click the desired icon and click OK. To remove the icon, click Clear Icon.

Chart Settings

Chart Type

• Chart Type: Select the type of chart you want to display:

  • Bar: Displays values as proportional rectangular bars.

  • Pie: Displays values as proportional slices of a circle.

  • Line: Displays values in a graph, each connected with a line.

  • Scatter Plot: Displays values in a graph, similar to a line chart but values are not connected with a line.

• Orientation: Select the way to orient the graph. This option is not available for pie charts.

  • Vertical: Display the graph vertically.

  • Horizontal: Display the graph horizontally.

  Setting the Orientation to Horizontal swaps the positions of the Axis Labels.

• Source: Select the layer or workflow from which to source the data for the chart.

  If the app contains more than one map, layers appear with a (Map Title) suffix. For example, MyLayer (MyMap1), MyLayer (MyMap2).

  Workflows are indicated with a (Workflow) suffix. If you select a workflow, you must be aware of the field names and types of the workflow's output.

  If the workflow executes the charts.display command with results from a layer on your map, set the chart's Source to that layer instead of the workflow.

• Series Type: Select the series type which determines how the chart presents the data:

  • Single-Field Groups: Displays the data grouped by a single field. For example, display the average height of buildings depending on their actual use.

    Group By

    • Field: The layer field to use as the X values (when Orientation is set to Vertical).

    • Is Date Field: Specifies whether this field is a date field. This option only appears when Source is set to a workflow and Series Type is set to Single-Field Groups.

    • Date Unit: Specifies the part of the date to display. This option only appears when Field is a date field and Series Type is set to Single-Field Groups.

      The Hour option ignores all other aspects of the timestamp, including day, minutes and seconds. Therefore, when displaying data for 10, all of the following would match: 10:00, 10:30, 10:59.

    • Axis Label: Specify a label for the X axis (when Orientation is set to Vertical). This option does not appear when Chart Type is set to Pie.

    Group Values

    • Statistic: The function to apply to the Y values (when Orientation is set to Vertical):

      • Average: Returns the average of the Y values.

      • Sum: Returns the total of the Y values added together.

      • Maximum: Returns the highest Y value.

      • Minimum: Returns the lowest Y value.

      • Count: Returns the total number of Y values.

    • Field: The layer field to use as the Y values (when Orientation is set to Vertical).

    • Axis Label: Specify a label for the Y axis (when Orientation is set to Vertical). This option does not appear when Chart Type is set to Pie.

  • Multi-Field Groups: Displays the data grouped by multiple fields. For example, display the average rainfall for January, February, March, and so on. When this option is selected, the fields must be numerical.

    Groups

    • Fields: The layer fields to use as the X values (when Orientation is set to Vertical).

      To add a field:

      1. In the Components panel, select Chart.

      2. In the Charts panel, click +Add Field.

         The Field window appears.

      3. In the menu, select a Field.

      4. Click Submit.

         The field appears in the list of fields.

      To edit a field:

      1. In the Components panel, select Chart.

      2. In the Chart panel, click the name of the field.

      3. Change the field settings you want.

      To reorder a field:

      1. In the Components panel, select Chart.

      2. In the Chart panel, click Edit Items.

      3. Drag the field up or down to the position you want.

      4. Click Done.

      To delete a field:

      1. In the Components panel, select Chart.

      2. In the Chart panel, click Edit Items.

      3. Click the Delete icon .

      4. Click Done.

    • Statistic: The function to apply to the Y values (when Orientation is set to Vertical):

      • Average: Returns the average of the Y values.

      • Sum: Returns the total of the Y values added together.

      • Maximum: Returns the highest Y value.

      • Minimum: Returns the lowest Y value.

    • X Axis Label: Specify a label for the X axis (when Orientation is set to Vertical). This option does not appear when Chart Type is set to Pie.

    • Y Axis Label: Specify a label for the Y axis (when Orientation is set to Vertical). This option does not appear when Chart Type is set to Pie.

  • XY Plot: Plots the data as a series of X and Y values. For example, display the flow rate of fire hydrants depending on their installation date.

    This option only appears when the Chart Type is either Line or Scatter Plot. This option requires that both fields are either numbers or dates.

    X Value

    • Field: The layer field to use as the X values (when Orientation is set to Vertical).

    • Axis Label: Specify a label for the X axis (when Orientation is set to Vertical). This option does not appear when Chart Type is set to Pie.

    Y Value

    • Field: The layer field to use as the Y values (when Orientation is set to Vertical).

    • Axis Label: Specify a label for the Y axis (when Orientation is set to Vertical). This option does not appear when Chart Type is set to Pie.

  Advanced Settings

  The Advanced Mode allows you to edit the code for both the Arcade script that generates the chart, as well as the Chart Definition JSON of the High Charts template that configures the appearance of the chart.

  When you enable Advanced Mode, you lose access to Designer's UI to easily configure most chart settings.

  • Arcade Script: To edit the raw Arcade Script used to transform results into chart data, click the Open Editor button. For more information, see ArcGIS Arcade.

    If changes are made to the script such that it no longer matches a Designer chart template, you will not be able to exit advanced mode.

  • Chart Definition: To edit the raw High Charts template JSON used to configure the appearance of the chart, click the Open Editor button. For more information, see Highcharts JS API Reference.

    If changes are made to the JSON configuration such that it no longer matches a Designer chart template, you will not be able to exit advanced mode. This includes specifying an unsupported chart type or adding more than one object in the series property.

Events

• Series Point Hover: The command to execute when the user hovers the cursor over a series point on the chart.

• Series Point Hover End: The command to execute when the user moves the cursor away from a series point on the chart.

• Series Point Click: The command to execute when the user clicks a series point on the chart.

Visibility Filters

Visible To

The Visible To settings determine which users and groups can access this component. If no users or groups are specified, all users can access this component by default.

The Hidden From setting overrides this setting.

To add a user:

1. In the menu on the right, select Users.

2. In the menu on the left, select the name of the user you want to add.

   To quickly find a user, click the menu on the left and start typing the name of the user.

To add a group:

1. In the menu on the right, select Groups.

2. In the menu on the left, select the name of the group you want to add.

   To quickly find a group, click the menu on the left and start typing the name of the group.

   There are three special groups that are always available even if no Esri groups have been configured:

   • All Users: Any user regardless of whether they are signed in or not.

   • Anonymous Users: Users who are not signed in.

   • Authenticated Users: Users who are signed in.

To remove a user or group:

1. Click the X beside the name of the user or group.

Hidden From

The Hidden From setting determines which users and groups are explicitly forbidden to access this component.

This setting overrides the Visible To setting.

To add a user:

1. In the menu on the right, select Users.

2. In the menu on the left, select the name of the user you want to add.

   To quickly find a user, click the menu on the left and start typing the name of the user.

To add a group:

1. In the menu on the right, select Groups.

2. In the menu on the left, select the name of the group you want to add.

   To quickly find a group, click the menu on the left and start typing the name of the group.

   There are three special groups that are always available even if no Esri groups have been configured:

   • All Users: Any user regardless of whether they are signed in or not.

   • Anonymous Users: Users who are not signed in.

   • Authenticated Users: Users who are signed in.

To remove a user or group:

1. Click the X beside the name of the user or group.

Layout

• Slot: Select the slot to position the component within the Map component. In addition to the various positions on the map such as Top Left and Bottom Center, you can position the component within the map context menu, which appears when the user right-clicks the map. You can also position the component within the Popup slot, which appears at the mouse cursor.

  This setting only appears when the component is within the Map component.

• Margin (px): The margin space around the component in pixels.

• Initially Hidden: Specifies whether or not the component is initially hidden when the app loads. If selected, the component remains hidden unless activated, for example, by the Show command.