arcgis-chart

Specifies the user action behavior for the chart.

• monoSelection: Select a single data point or series, new selection replaces the previous one.
• multiSelection: Select multiple data points or series, new selection adds to the previous one.
• multiSelectionWithCtrlKey: Select multiple data points or series while holding the Ctrl key (Cmd on Mac). When the key is held, each new selection is added; otherwise, the selection is replaced.
• none: No action is performed on user interaction.
• zoom: Zoom into a specific area of the chart.

Note: Not applicable to gauges.

Whether to allow the object id to be used as a statistic other than Count.

Enable animation on the chart.

Since

ArcGIS Maps SDK for JavaScript 5.0

The ARIA attributes for the chart. Provides accessibility information to assistive technologies such as screen readers. Supports the following properties: label, description, describedByElements, and labelledByElements.

Since

ArcGIS Maps SDK for JavaScript 5.0

If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the destroy() method when you are done to prevent memory leaks.

Auto disposes the chart when a new one is created in the same container.

When true, the data label text color is automatically adjusted for readability based on its background. If the label is dark and appears over a dark series area, the text color is switched to either the chart background color or white.

Note: Applicable to heat charts only.

Since

ArcGIS Maps SDK for JavaScript 5.1

Allows picking the Calcite CSS variables to use when applying a Calcite theme.

By default the following variables are used:

• background: --calcite-color-foreground-1
• text: --calcite-color-text-1
• line: --calcite-color-border-1
• secondary line: --calcite-color-text-3
• spinner: --calcite-color-brand-hover

The charts colors are overridden by those associated to those CSS variables, but only if they have not been customized beforehand.

The index of the chart to be rendered from the layer. Must be used in conjunction with the layerItemId or layer property.

If a layer or layerItemId is set without chartIndex, the first chart in the layer will be rendered.

If the chartIndex is out of bounds, the first chart in the layer will be rendered and a warning event will be emitted.

Customize the maximum number of series allowed on the chart.

The chart's behavior once that limit is reached can be adjusted through the behaviorAfterLimit nested property, to either reject the creation or update of the chart, or render the elements up to the given limits.

Note: Not applicable to gauges.

Lifecycle function executed after the data has been processed and before the chart renders. Can be used to alter the model from information extracted from the data.

Note: Applicable to gauges and pie charts only.

Whether to use features uniquely designed for a chart currently being configured by a user via the UI. When true, the slotted charts action bar will expose an Edit chart action, surfaces relevant error states, and can show a helpful in-container placeholder about the chart’s purpose.

Sets the cursor range when actionMode is set to zoom, multiSelection or multiSelectionWithCtrlKey.

• multi-axes: Allows to draw a free rectangle.
• x-axis: Allows to draw a rectangle bound to the x-axis.
• y-axis: Allows to draw a rectangle bound to the y-axis.
• undefined: Defaults to the preset behavior according to the chart type and action mode.

Note: Not applicable to gauges.

Callback function used to format the data labels. If the returned string contains HTML tags they will be interpreted as such.

Note: Not applicable to gauges.

Disables all interactions on the chart.

Disables the toggling of series from the legend items.

Note: Only applicable to multi-series charts.

Whether to use features uniquely designed for a chart currently being configured by a user via the UI. When true, the slotted charts action bar will expose an Edit chart action, surfaces relevant error states, and can show a helpful in-container placeholder about the chart’s purpose.

Enables the responsive features.

Whether to display an error alert and hide the chart when it can't be created or updated.

The index of the feature to render when using a feature based gauge.

Note: Applicable to gauges only.

When true, all chart elements are filtered based on the view extent.

When true, all chart elements are filtered based on the selection.

Note: Not applicable to gauges or charts configured with imagery layers.

When true, all chart elements are filtered based on the view extent.

Callback function used to format the gauge inner label. If the returned string contains HTML tags they will be interpreted as such.

Note: Applicable to gauges only.

Callback function used to format the axes guides tooltip. If the returned string contains HTML tags they will be interpreted as such.

Note: Not applicable to pie charts.

When true, the empty series are completely hidden from the chart and the legend. For example, a series may become empty after applying a data filter, filter by attribute or geometry (as when using the filter by view extent).

Note: Not applicable to gauges.

Hides the license watermark.

Hides the loader animation (curtain and spinner), showed by default at every update.

Since

ArcGIS Maps SDK for JavaScript 5.1

Whether to display or hide all UI messages (e.g. no data warnings, or when the logarithmic scale can't be applied to an axis when the data contains values <= 0).

Since

ArcGIS Maps SDK for JavaScript 5.1

Whether to keep missing categories from a count aggregation as gaps in the chart's data.

When data is retrieved from the server, the server excludes all features having a count of 0 from the response; hence resulting in missing entries on the charts.

When this property is set to true, the dataset will keep these gaps instead of filling them with 0s.

When left to false, the chart's dataItems associated with empty (no value) categories (from only a Count aggregation) will be populated with 0s.

When true, disables the default setting that uses debounce functions to handle the visibility of markers that are outside of the plotting area when the min/max bound changes and/or when a zoom action is performed (via chart cursor or scrollbar), to increase performance.

This property will be set when the chart is created and cannot be updated after that. It's recommended that this property should only be set to true for small datasets. When left undefined, will be treated as false.

Note: Applicable to line charts only.

This property will be effective when the component's view is provided or when the layer is set to a FeatureLayerView.

By default the queries made by the chart will consider the view's extent as the unique geometry filter applicable. This implies ignoring any geometry passed through the model (component.model.dataFilters) or the runtime filters (component.runtimeDataFilters).

Setting this property to false signals the queries to ignore the view's extent, whether an additional geometry filter is provided or not.

Disables all interactions on the chart.

Used to perform queries. If the layer is a FeatureLayerView or if the layer and the view property are both provided, the queries will be executed client-side.

Allows the chart to update automatically when the layer's fields property changes.

Whether the chart should be refreshed when the layer's filter (definitionExpression) changes.

Layer item ID associated with the chart to be rendered. Can be used in conjunction with the chartIndex property.

If layerItemId is set without chartIndex, the first chart in the layer will be rendered.

Supported layers include: FeatureLayer, SubtypeSublayer, ImageryLayer, ImageryTileLayer and WCSLayer.

Allows the chart to update automatically when the layer's renderer changes. Applies when the color match is enabled.

Note: If the property is set to ignore the chart will still use the layer's renderer information when the data is updated.

Sets the legend's position on the chart.

Note: Not applicable to gauges.

A callback function used to format the legend value labels. If the returned string contains HTML tags they will be interpreted as such. If provided, the formatter will be used if at least displayNumericValue or displayPercentage is true.

Note: Applicable to pie charts only.

When true, the legend is visible on the chart.

Note: Not applicable to gauges.

Defines the colors for the loader animation.

Custom message overrides for the chart's strings.

Provides an API to interact with the chart's configuration.

Note: This property has a union type of ChartModel | WebChart meaning a raw chart configuration object can be passed to it instead, however it is recommended to use the ChartModel instance whenever possible.

Whether to consider a null statistic as valid. If set to false and the data has only null values, the chart's dataset will be considered empty:

• The corresponding warning event will be sent
• The "no data" message will be displayed (unless hideUIMessages is set to true or showUIMessages is set to false)

A placeholder string to provides a brief hint to the user indicating needed information for creating a chart.

Allows the use of the fields alias from the layer.popupTemplate when rendering the field names on the chart (e.g. tooltips, axes, legend).

Builds charts sequentially instead of rendering them all at once.

When true, the chart's dataItems associated with empty (no value) categories (from only a Count aggregation) will be populated with 0s.

When true, the features extent will be returned through the @arcgisDataProcessComplete and @arcgisSelectionComplete events payload. Applies only to:

• Charts using an aggregation.
• Data source using a feature layer compatible with envelope aggregation.

The extent (IExtent) is returned through the property featuresExtentField.

Note: Not applicable to gauges.

When true, the selection indexes will be computed whenever a selection is made on or passed to the chart.

Note: Not applicable to gauges.

When true, the object ids will be computed whenever a selection is made on or passed to the chart. Only considered for a data source using a feature layer.

Note: Not applicable to gauges or charts configured with imagery layers. It's always false for imagery layers. No object ids will be computed.

When true, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.

Note: Applicable to bar chart, line chart, combo bar line chart and box plot.

When true, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.

Note: Applicable to bar chart, line chart, combo bar line chart and box plot.

Applies runtime data filters to the chart.

Callback function used to format the secondary y-axis labels. If the returned string contains HTML tags they will be interpreted as such.

Note: Appliable to bar charts, line charts, combo bar line charts with dual axes.

When this property is set, it will apply a selection on the chart matching the provided selection.

Note: Not applicable to gauges.

Since

ArcGIS Maps SDK for JavaScript 5.1

Selection manager object used to synchronize the selections with the chart when syncViewSelection is true. It has precedence over the layer view's SelectionManager when both are available.

Used to provide a customized theme for the selected and non selected elements.

• If no style is provided for the selected elements, a default selection is applied.
• If no style is provided for the non selected elements, the chart's style is applied.

Note: Not applicable to gauges.

When true, the series properties unit and size become optional and will be automatically set to values that fit the data set. Used when creating or updating a chart compatible with time binning.

Note: Only applicable to charts using the temporal binning feature (bar chart, line chart, combo bar line chart, radar chart).

Since

ArcGIS Maps SDK for JavaScript 5.1

Show the series on the chart even if it doesn't have data (i.e. empty)

When false, the empty series are completely hidden from the chart and the legend. For example a series can be empty after applying a data filter, filter by attribute or geometry (as when using the filter by view extent).

Note: Not applicable to gauges.

Since

ArcGIS Maps SDK for JavaScript 5.1

Shows the license watermark.

Whether to display or hide all UI messages (e.g. no data warnings, or when the logarithmic scale can't be applied to an axis when the data contains values <= 0).

Since

ArcGIS Maps SDK for JavaScript 5.1

Whether to skip the chart rendering queue.

When true, charts will render immediately without waiting for other charts to finish rendering. When false (default), charts are queued so that only one chart renders at a time.

Since

ArcGIS Maps SDK for JavaScript 5.1

Whether to synchronize the selection between chart components from the same layer.

Whether to synchronize the selection between chart components from the same layer.

Determines whether the chart's selection should be synchronized with either the chart's selectionManager or the layer view's.

Since

ArcGIS Maps SDK for JavaScript 5.1

Determines whether the chart's selection should be synchronized with either the chart's selectionManager or the layer view's.

Since

ArcGIS Maps SDK for JavaScript 5.1

Whether the chart should be refreshed when the view's time extent changes.

Note: Not supported for histogram.

Since

ArcGIS Maps SDK for JavaScript 5.1

Whether the chart's data should be in sync with the view's timeZone.

Note: This applies only to charts supporting temporal data. Additionally if the data is binned, it applies only if the layer has the capacity to handle the /queryBins operation. For any other case the chart will ignore the view's time zone regardless of the value of this property.

List of chart types to include from syncing the view's timeZone with the data. Currently heat charts are included by default.

Note: This applies only to charts supporting temporal data. Additionally if the data is binned, it applies only if the layer has the capacity to handle the /queryBins operation. For any other case the chart will ignore the view's time zone regardless of the content of this list.

Used to set a custom time zone for the chart.

Disables the toggling of series via the legend items.

Note: Only applicable to multi-series charts.

Callback function used to format the tooltips. If the returned string contains HTML tags they will be interpreted as such.

Whether to update the series when the data updates while the chart uses a split-by field configuration.

If addMissingSeries is set to true the missing series will be added to cover the split-by values not referenced by the model. The default information from the property updateSplitBySeries.seriesTemplate will be applied to the new series.

Note: Applicable only to bar chart, line chart and box plot when a split-by field is used.

Enable animation on the chart.

Allows the use of the fields alias from the layer.popupTemplate when rendering the field names on the chart (e.g. tooltips, axes, legend).

Used to access the feature layer view instance in order to perform client side queries.

Whether the chart should be refreshed when the view's time extent changes.

Callback function used to format the x-axis labels. If the returned string contains HTML tags they will be interpreted as such.

Note: Not applicable to pie charts.

Callback function used to format the y-axis labels. If the returned string contains HTML tags they will be interpreted as such.

Note: Not applicable to pie charts or gauges.

Clears all selection on the chart.

Note: Not applicable to gauge.

Creates a promise that resolves once the component is fully loaded.

Since

ArcGIS Maps SDK for JavaScript 5.1

Destroys the chart instance and removes it from the DOM.

Triggers an alert to display an error message.

Export the current chart's data as a CSV file.

The Options object can contain the following properties:

• columns: An array of column to include in the CSV file.
• delimiter: The delimiter to use in the CSV file. Default is ,.
• includeHeader: Whether to include the header row in the CSV file. Default is true.
• quoteAll: Whether to quote all values in the CSV file. Default is false.
• locale: The locale to use when formatting the CSV file. Default is en.
  • Locale supported are: "ar", "ar-u-nu-latn", "bs", "bg", "ca", "cs", "da", "de", "el", "en", "en-US", "es", "et", "fi", "fr", "he", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "no", "nl", "pl", "pt-BR", "pt-PT", "ro", "ru", "sr", "sl", "sk", "sv", "th", "tr", "uk", "vi", "zh-CN", "zh-HK", "zh-TW"

Note: The chart types supported by this method are:

• Bar chart
• Box plot
• Combo bar line chart
• Heat chart
• Histogram
• Line chart
• Pie chart

Exports the current chart as an image. Default format is png.

• Alternative formats supported are: jpeg and svg.

Returns a promise that resolves when the chart model is fully loaded.

Notify method allows passing external messages to the chart component. It can be used to pass validation or information messages. In a situation where a model update is overriding the notification modal, consider waiting for the @arcgisUpdateComplete event.

Re-render the chart.

Resets the chart zoom to bring it back to full extent.

Note: Applicable to XY charts only.

Switches the selection on the chart.

Note: Not applicable to gauge.