Entity Chart Widget Options

An entity chart widget uses JSON to display content about the subject entity and associated entities in a graphical form.

Note: Defining the Chart configuration option for the entity chart widget requires an understanding of JSON. Before using the entity chart widget, try using the chart widget. The chart widget does not require JSON knowledge, and might be adequate for your needs.

Application Builder charts are created using the Highcharts API v 3.0.6. When creating an entity chart widget, the General Configuration Options are available along with the Chart configuration option. The Chart configuration option is a JSON representation of what will be displayed in the chart, and how that data will be displayed.

The following options can be configured when creating an entity chart widget:

Type Description

Type	Description
Chart configuration	Chart configuration in JSON using the Highcharts API v 3.0.6. When creating a chart, the data to be displayed in the chart must be specified, all other chart options have default values. Typically, the data for a chart is defined in the series key of the chart configuration as follows: `{ "series": [ { "facet_id": "name", "faceting": "query" } ] }` See Defining Charts in Application Builder with JSON for detailed information and examples of creating JSON charts. Note: When specifying JSON in Application Builder, all values and keys must be specified in quotation marks (`""`) except Boolean and number values. See the chart examples for valid JSON syntax examples in Application Builder. The Highcharts API has been augmented with the following options to enable integration with Application Builder content: The following `series` options are available: `facet_id` ID that is used to specify the facet. `faceting` Query that is used to return faceted data: `subject.association.faceted_by(xpath("$type").with_facet_id(facet_id)).faceting` or: `subject.association.faceted_by(field(\"field_name\").with_facet_id(facet_id).without_pruning.then(sum(xpath('$type')))).faceting` Note: You can either specify an XPath `xpath("$type")` or a `field(\"field_name\")` when identifying what you want to facet by. `date_format` A date format string. If present, chart values will be parsed as dates. Example: `'%b %y'` `point_limit` The maximum number of points to display. The default is `50`. The following `chart` option is also available: `sort_by_value` When set to `true`, data is sorted in descending order. Important: The Application Builder implementation of the Highcharts API does not support the use of JavaScript functions. Any items identified as a `function` in the Highcharts API are therefore not supported.

Chart configuration

Chart configuration in JSON using the Highcharts API v 3.0.6. When creating a chart, the data to be displayed in the chart must be specified, all other chart options have default values. Typically, the data for a chart is defined in the series key of the chart configuration as follows:

{
  "series": [
    {
      "facet_id": "name",
      "faceting": "query"
    }
  ]
}

See Defining Charts in Application Builder with JSON for detailed information and examples of creating JSON charts.

Note: When specifying JSON in Application Builder, all values and keys must be specified in quotation marks ("") except Boolean and number values. See the chart examples for valid JSON syntax examples in Application Builder.

The Highcharts API has been augmented with the following options to enable integration with Application Builder content:

The following series options are available:

facet_id

ID that is used to specify the facet.

faceting

Query that is used to return faceted data:

subject.association.faceted_by(xpath("$type").with_facet_id(facet_id)).faceting

or:

subject.association.faceted_by(field(\"field_name\").with_facet_id(facet_id).without_pruning.then(sum(xpath('$type')))).faceting

Note: You can either specify an XPath xpath("$type") or a field(\"field_name\") when identifying what you want to facet by.

date_format

A date format string. If present, chart values will be parsed as dates. Example:

'%b %y'

point_limit

The maximum number of points to display. The default is 50.

The following chart option is also available:

sort_by_value: When set to true, data is sorted in descending order.

Important: The Application Builder implementation of the Highcharts API does not support the use of JavaScript functions. Any items identified as a function in the Highcharts API are therefore not supported.

Entity Chart Widget Configuration Options