web-chart

A numeric value multiplying the value to convert.

A numeric offset to apply to the value to convert.

Scrollbar visibility.

Scrollbar width in pixels.

Scrollbar color.

Grip size in pixels.

Margin between the scrollbar and the series container in pixels.

Horizontal offset. Can be a number for a fixed value in pixels, or a string such as 25% for a value relative to the label's container width.

Vertical offset. Can be a number for a fixed value in pixels, or a string such as 25% for a value relative to the label's container height.

Rotation angle of the label.

Label style.

A unique string identifier for the ChartText object. This value is chartText.

Determines the visibility of the content.

Contains the styling information and text content.

Represents a unique string identifier for the chart cursor's crosshair.

Contains styling information on how the chart cursor's crosshair should be rendered.

Indicates whether the vertical crosshair line should be displayed.

Indicates whether the horizontal crosshair line should be displayed.

A unique string identifier for the ChartLegend object. This value is chartLegend.

Determines the visibility of the content.

Contains styling information on how the title of the legend box should be rendered.

Contains styling information on how legend body (excluding the title) should be rendered. Will use default styling if not provided.

Positions the legends at "right", "left", "top", or "bottom" of the chart.

Legend's maximum height. If not set the legend will occupy the same height as the series container.

Allows the legend markers to be displayed as circles.

• false or undefined: rounded rectangles
• true: circles

Specifies the text to use for the null category. If none is provided, the default null text will be used.

Contains styling information on how the overlay should be rendered. If not provided a default style is applied.

Indicates whether the category associated to a slice is to be displayed in the legend.

Indicates whether the numeric value associated to a slice is to be displayed in the legend. If both displayNumericValue and displayPercentage are true on a same label, they will be displayed as percentage (value)

Indicates whether the percentage to a slice is to be displayed in the legend. If both displayNumericValue and displayPercentage are true on a same label, they will be displayed as percentage (value)

Maximum width in pixels of the label displaying the slice name. If the label is larger than the maximum width, it will automatically wrap.

Maximum width in pixels of the value label displaying the slice value. If the label is larger than the maximum width, it will automatically wrap.

A unique string identifier for the ChartOverlay object. This value is chartOverlay.

Determines whether the overlay is created under the hood. It may or may not be visible.

Determines the visibility of the content.

Contains styling information on how the overlay should be rendered. If not provided a default style is applied.

Represents a unique string identifier for the NumberFormatOptions object. For the NumberFormatOptions object, it is number. It can help to differentiate numerical (value) axis from other types of axes such as date-time axis and category axis.

Represents the JS native Intl.NumberFormatOptions, which is based on CLDR specifications.

Represents a unique string identifier for the NumberFormatOptions object. For the NumberFormatOptions object, it is date. It can help to differentiate date-time axis from other types of axes such as numeric (value) axis and category axis.

Represent the JS native Intl.DateTimeFormatOptions, which is based on CLDR specifications.

Represents how to format specific date and time units when displayed on the axis, independently from the intlOptions.

Represents a unique string identifier for the CategoryFormatOptions object. For the CategoryFormatOptions object, it is category. It can help to differentiate category axis from other types of axes such as date-time axis and numeric (value) axis.

Represents a positive integer which represents the limit on the number of characters to be displayed for all the category strings. The truncated string are appended with .... If property is not present or null, no truncation is done.

Represents a unique string identifier for the Guide object. For the Guide class, it is chartGuide.

Determines the value where the guide should begin.

Determines the value where the guide should end. If it is not specified, a line guide is used, otherwise a fill/rectangular guide is used.

Determines how the guide should be rendered.

A unique string identifier which is used to refer to a particular guide. It is displayed in the charts config UI to differentiate between different guides.

Defines a text label for the given guide. It is displayed on the chart next to the concerned guide and is styled using esriTS format.

Determines the visibility of the content.

Determines whether the guide should be rendered on top of (overlapping) the series or under the series.

Indicates whether to apply the hovered element's color to the guide's tooltip background (false) or its outline (true).

Represents a unique string identifier for the WebChartAxis object. For ChartAxis object, it is chartAxis.

Determines the visibility of the content.

Specifies whether the axis has a logarithmic scale or not.

Contains styling information on how the title of the axis should be rendered

Specifies how numerical/categorical/date-time values should be formatted.

The minimum value which the axis should represent, when it is not defined or null, then the minimum value for the corresponding axis is automatically calculated.

The maximum value which the axis should represent, when it is not defined or null, then the maximum value for the corresponding axis is automatically calculated.

Dictates how the grid lines associated with a particular axis should be rendered.

Represent an array of guides that should be rendered onto the axis.

Contains styling information on how the axis line should be rendered. If not provided a default style is applied.

Contains styling information on how the axis labels should be rendered.

Represents the axis scrollbar style and visibility.

Represents an option to hide/un-hide the zero line on value axis.

Represents an option to show integer-only values for a value axis

Specifies whether cursor tooltip should be displayed.

Allows setting a buffer to a value axis to provide some space around the series.

The desired minimum distance between two adjacent axis ticks. The actual distance may fluctuate depending on the chart's size. When not provided a default value is assigned according to the axis type and axis labels behavior.

Note: This property is not applicable to gauge charts.

Specifies the base interval on a date axis. Will be ignored on the other axis types. It will be overridden by the properties from the series binTemporalData when provided.

Represents a unique string identifier for the GaugeAxisTick object. For WebChartGaugeAxisTick object, it is gaugeAxisTick.

Determines the visibility of the axis ticks.

Represents a unique string identifier for the ChartNeedle object. For WebChartNeedle object, it is gaugeNeedle.

Hides or shows the needle.

Contains styling information on how the needle should be rendered.

Represents the needle's thickness at the bottom (chart's center) in pixels.

Represents the needle's thickness at the top in pixels.

Represents the size of the hole in the middle of the chart. Can be visualized when guides are displayed.

Hides or shows the needle's pin (centroid circle).

Specifies how the axis' inner label needs to be displayed.

Specifies how the axis' needle needs to be displayed.

Specifies how the axis' ticks need to be displayed.

If a label has a value being a multiple of that property, it will be displayed. Otherwise it will be hidden.

If the property is undefined or 0, the chart will be displayed with 6 axis labels distributed evenly along the axis min and max.

If the property has a value that results in more than a set limit of axis labels (25 as defined in ChartDefaults.gauge.maximumNumberOfLabelIntervals) this property value will be ignored and the chart will be displayed with only axis min/max with 4 ticks in between.

Specifies if only the first and last labels need to be displayed. If set to true all the other labels will be hidden. Their visibility still depends on the axis labels visibility (WebChartAxis.labels.visible).

Defines how to convert the axis minimum.

Defines how to convert the axis maximum.

With a gauge by feature:

• minimumFromField is expected to be a field name. The value from that field for the given feature is mapped to the axis minimum value.

With a statistic gauge:

• If minimumFromField is set to a field name (string), the minimum from that field is mapped to the axis minimum value.
• If it is set to an IStatisticDefinition the statistic (min, max, avg...) from the given field is mapped to the axis minimum value.

When minimumFromField is not provided or when it leads to an invalid value, the minimum value from the axis config, if provided, or the default value of 0, in that order, will be used.

With a gauge by feature:

• maximumFromField is expected to be a field name. The value from that field for the given feature is mapped to the axis maximum value.

With a statistic gauge:

• If maximumFromField is set to a field name (string), the maximum from that field is mapped to the axis maximum value.
• If it is set to an IStatisticDefinition the statistic (min, max, avg...) from the given field is mapped to the axis maximum value.

When maximumFromField is not provided or when it leads to an invalid value, the maximum value from the axis config, if provided, or the default value of 0, in that order, will be used.

Defines the labels orientation.

Attribute fields to include in the FeatureSet. Will have an effect on chart with no aggregation.

Acts as a filter on the base data for attribute-based filtering, expect for bar/line charts for which is is used to handle the split-by field values.

An array of fields which determine how the base data is grouped. Only one groupBy field is supported,

Represents an array of statistics definitions which dictate how a particular field should be aggregated.

Represents the sorting order of the output result.

It's recommended to use the orderByFields property of the chart's orderOptions object instead of this one. If both are used, the orderByFields property of the chart's orderOptions object will take precedence.

The format of any entry in this array is field_name sorting_order. When sorting_order is not defined, it is assumed to be ascending.

Specifies the geodatabase version to display for feature service queries.

The geometry to apply to the spatial filter. A buffer can be applied to it by setting the properties distance and units.

For spatial filters, this parameter defines the spatial relationship to filter features in the layer view against the filter geometry.

Specifies a search distance for the geometry. To be associated with the units property. For compatible layers only.

The unit for calculating the buffer distance when distance and geometry are provided. If not specified, the unit is derived from the geometry spatial reference.

A time extent [timestamp, timestamp] for a temporal query against time-aware layers.

The zero-based index indicating where to begin retrieving features.

The number of features to retrieve.

If true then the query returns distinct values based on the field(s) specified in outFields. Available for count-based aggregations only.

Indicates whether to fetch null values for them to be counted or displayed as categories on the chart.

An array of objectIds or uniqueIds of the features to be filtered.

A unique string used to differentiate the series on a chart.

Hides or shows the series. If the series is has visible set to false, the corresponding legend is grayed out in the legend box.

Hides or shows data tooltips. Note: Not applicable to gauge.

Indicates whether to apply the hovered element's color to the background (false) or the outline (true). Note: Not applicable to gauge.

Defines how to render numeric values in tooltips.

Defines how to render percent values in tooltips. Used for stacked 100% bar and line charts, as well as pie charts.

Defines how to render dates in tooltips. Used for bar and line charts using a date x-axis with no time binning.

Specifies the name of the series. It would be reflected in the chart's legend.

Specifies a query object associated with a particular series containing information on what data to fetch for that series.

Specifies which field represents the x-coordinates of this series. Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) is needed.

Specifies how the data labels should be rendered.

Specifies whether the series should be assigned to the second value axis, when the axes property defines it. Supported by bar and line series.

Represents a unique string identifier for the CalendarDatePartsBinning object. For CalendarDatePartsBinning object, it is calendarDateParts.

Represents the unit to use to bin the data.

The unit of time to use to bin the temporal data.

Current limitation: the "quarters" unit is only supported if the provided layer supports the queryBins operation.

The span of time that will be binned or aggregated together. Works in coordination with unit.

The time interval alignment type. Valid options include equalIntervalsFromStartTime and equalIntervalsFromEndTime.

When specific the binning will start at the first or last date of the dataset.

Whether to use the time properties to bin the temporal data.

false - the binCount and unit properties can be used to set the date axis base interval.

Describes how to bin the temporal data.

Represents a unique string identifier for the BarChartSeries object. For BarSeries object, it is barSeries.

Specifies which field represents the y-coordinates of this series. Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) are needed.

Contains styling information on how the columns/bars should be rendered.

true or undefined - the labels displayed within a small stacked column are hidden to avoid cluttering. false - all the data labels are displayed.

When true, the labels displayed within a small column for sideBySide bar series are hidden to avoid cluttering. When false or undefined (default), all the data labels are displayed.

Specifies how to display the category with null value. Setting this property will ensure that the item with no data is displayed on the chart with the specified text and color.

Represents a unique string identifier for the HistogramOverlays object. For HistogramOverlays object, it is chartOverlays.

Specifies the mean overlay for histogram.

If not provided, the mean overlay is not displayed.

Specifies the median overlay for histogram.

If not provided, the median overlay is not displayed.

Specifies the standard deviation overlay for histogram.

If not provided, the standard deviation overlay is not displayed.

Specifies the comparison distribution overlay for histogram.

If not provided, the comparison distribution overlay is not displayed.

Represents a unique string identifier for the HistogramSeries object. For HistogramSeries object, it is histogramSeries.

Bin count must be a positive integer.

Specifies the chart overlays. Histogram supports 4 overlays: mean, median, standardDeviation and comparisonDistribution. The overlays won't show if the property is not defined.

Specifies how the data should be transformed (e.g. square root, log, etc.) before binning.

Contains styling information on how the columns should be rendered.

Represents a unique string identifier for the ScatterplotOverlays object. For the ScatterplotOverlays object, it is chartOverlays.

Specifies the trend line overlay for scatterplot.

The trend line won't show if the property is not defined.

Represents a unique string identifier for the sizePolicy object. For the sizePolicy object, it is sizeScale.

The type of scale to apply to the markers (logarithmic or linear).

The field which determines the markers size.

The minimum marker size.

The maximum marker size.

Represents a unique string identifier for the ScatterSeries object. For the ScatterSeries object, it is scatterSeries.

Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) are needed.

Specifies how each data point in the scatterplot should be rendered.

Specifies all the chart overlays. The scatterplot implements only 1 overlay, trendLine. The overlays won't show if the property is not defined.

Specifies rules to use the scatterplot as bubble plot, by changing dynamically the markers size according to a specific field value.

Specifies the additional numeric fields in the tooltip.

Represents a unique string identifier for the WebChartPieChartTick object. For the WebChartPieChartTick object, it is pieTick.

Determines the visibility of the tick.

Assigning the true value will only be considered when the data labels are visible (series.dataLabels.visible) and when the data label associated to the tick is outside of the chart (series.dataLabelsOffset > 0).

Contains styling information on how the pie chart ticks should be rendered.

A unique string used identify the slice of a pie chart.

The slice's original label.

Custom label for the slice.

For grouped slice, the default value is Other. For regular slice, it will be either the category or field name.

Contains styling information on how the slice should be rendered. If not provided, the slice will be styled with default values.

Slices that have a percent value equal or lesser to this threshold are grouped into a unique slice.

Specifies how the grouped slice data labels should be rendered.

If the property is not set the series.dataLabels will be used instead.

Represents a unique string identifier for the WebChartPieChartSeries object. For the WebChartPieChartSeries object, it is pieSeries.

Specifies which field represents the y-coordinates of this series. Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) are needed.

Represents the size of the hole in middle of the chart. The number is used as a percentage rather than a fixed value.

Contains styling information on how the slices should be rendered.

Indicates whether the category associated to a slice is to be displayed on its data label. This property will be ignored if the chart options dataLabelFormatter is provided.

Indicates whether the numeric value associated to a slice is to be displayed on its data label.

If both displayNumericValue & displayPercentage are true on a same label, they will be displayed as percentage (value).

This property will be ignored if the chart options dataLabelFormatter is provided.

Indicates whether the percentage associated to a slice is to be displayed on its data label.

If both displayNumericValue & displayPercentage are true on a same label, they will be displayed as percentage (value)

This property will be ignored if the chart options dataLabelFormatter is provided.

Indicates whether the category associated to a slice is to be displayed on its tooltip.

This property will be ignored if the chart options tooltipFormatter is provided.

Indicates whether the numeric value associated to a slice is to be displayed on its tooltip.

If both displayNumericValue & displayPercentage are true on a same label, they will be displayed as percentage (value)

This property will be ignored if the chart options tooltipFormatter is provided.

Indicates whether the percentage associated to a slice is to be displayed on its tooltip.

If both displayNumericValue & displayPercentage are true on a same label, they will be displayed as percentage (value)

This property will be ignored if the chart options tooltipFormatter is provided.

Specifies how the numerical values should be formatted (applied to label, tooltip and legend).

Can be overridden for the tooltips by series.dataTooltipValueFormat.

Specifies how the percent values should be formatted (applied to label, tooltip and legend).

Can be overridden for the tooltips by series.dataTooltipPercentFormat.

Adds a prefix to all the values displayed on the pie chart: data labels, tooltips and legend.

Adds a suffix to all the values displayed on the pie chart: data labels, tooltips and legend.

Adds a prefix to all the percentages displayed on the pie chart: data labels, tooltips and legend.

Adds a suffix to all the percentages displayed on the pie chart: data labels, tooltips and legend.

If set, the category on the data label is truncated to display only characterLimit characters, and an ellipsis ("...") is added to the end of the label.

Does not affect the value or percentage displayed in labels. Not applicable to tooltips or legend labels.

Specifies how to render the ticks shown on each slide. Ticks will be displayed with default values if not provided.

Whether to place the data labels inside the pie slices.

When set to true the following properties will be ignored:

• dataLabelsOffset
• alignDataLabels
• optimizeDataLabelsOverlapping

Determines in pixel how far the data labels should be placed from their slice. If a negative value is provided the label will be placed inside of the chart.

Ignored when dataLabelsInside is set to true.

Aligns labels into columns to make them more readable and avoid them to overlap each other.

Ignored when dataLabelsInside is set to true.

Optimizes the data labels rendering to avoid them to be cut off on the edges or to overlap the legend by wrapping them and adding padding to the chart.

Ignored when dataLabelsInside is set to true.

Specifies if and how the slices under a given percentage threshold are grouped into a unique slice.

An array of WebChartPieChartSlice representing the ids, labels and styles of the pie slices.

When this property is not defined, or when a pie slice does not have a matching slice in this array, the series' fillSymbol will be used. If the series' fillSymbol does not contain color information, colors from the color ramps will be utilized.

Represents a unique string identifier for the WebChartGaugeSeries object. For the WebChartGaugeSeries object, it is gaugeSeries.

Defines the conversion to apply to the gauge value.

Specifies the index of the feature to be rendered.

This property will be ignored for a statistic gauge (indicated via WebGaugeChart.subType property).

For feature-based gauge, if this property is not present, the first feature will be used (featureIndex = 0)

Represents a unique string identifier for the WebChartLineChartSeries object. For the WebChartLineChartSeries object, it is lineSeries.

Specifies the numeric field(s) used by the series.

Contains styling information on how the line or line segments should be rendered.

Specifies whether line segments should be smoothed.

Indicates whether line series show area.

Indicates whether to show or hide the markers/bullets of the line series.

Contains styling information on how the marker should be rendered.

Specifies the color of the filled area for line chart.

areaColor will be applied only if showArea is true, and is defaulted to the line color if not provided.

Specifies how negative values are treated in stacked series. true - negative values will be stacked on the base line. false - negative values will be stacked in relation to their previous values in the stack.

Whether to connect the lines when there's a gap in the data. Can be overridden by the temporal data setting nullPolicy.

Specifies how to display the category with null value.

Setting this property will ensure that the item with no data is displayed on the chart with the specified text and color.

Specifies the numeric field(s) used by the box plot series.

Contains styling information on how the box and whiskers should be rendered. The whiskers use the fillSymbol.outline.

An array of 2 colors to use for the gradient. The first color represents the minimum value, the second color represents the maximum value.

Specifies the custom minimum value for the heat chart. If none is provided, the minimum value from the dataset will be used.

Specifies the custom maximum value for the heat chart. If none is provided, the maximum value from the dataset will be used.

Specifies the color to use for the items outside the lower range specified by minValue. If none is provided, the default color will be used.

Specifies the color to use for the items outside the upper range specified by maxValue. If none is provided, the default color will be used.

The number of class breaks to be used for the heat chart.

The classification method to be used for the heat chart. equal-interval - divides the range of values into equal-sized intervals. quantile - divides the range of values into intervals that contain an equal number of features. natural-breaks - identifies natural groupings of values in the data by minimizing the variance within classes and maximizing the variance between classes. manual - allows you to manually specify the class breaks.

Specifies the text to use by the empty cells. If none is provided, the default null text will be used.

Specifies the symbol to use by the empty cells. If none is provided, the default symbol will be used.

Specifies which field represents the y-coordinates of this series. Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) are needed.

Describes how to bin the temporal data when the x-axis field is a date.

Describes how to bin the temporal data when the y-axis field is a date.

Defines how the cells outline should render.

Defines the type of rule to apply for the heat chart.

Specifies the details of the gradient rules for the heat chart.

Specifies the details of the class breaks rules for the heat chart.

Specifies how to display the empty cells, in terms of text and symbology.

Version of the specification. Used to identify when a saved config was created.

Represents a unique string identifier for the WebChart object. For the WebChart object, it is chart.

Can be used to uniquely identify a chart.

Property representing the layer to be used by the chart. If not provided we expect a layer object to be set on the component.

Used to filter the chart's data while in layer mode.

Specifies title of the chart.

Specifies subtitle of the chart.

Specifies footer of the chart.

Specifies the background color of the chart.

Specifies cursor's crosshair information for the chart. Only for XY charts.

Specifies the Legend information for the chart.

Represents an array of at least 1 or at most 3 chart axes accompanying the chart. The third axis config is used when a series assignToSecondValueAxis is set to true. Some of the axis features won't apply to the third axis (e.g. labels behaviors).

Represents the way the labels should behave when the horizontal axis can't display them all.

Applicable to XY charts only. Histograms support none and rotate only. The default horizontal axis value is rotate, except for histograms, where it is none.

Represents the way the labels should behave when the vertical axis can't display them all.

For XY Chart only.

Represents an array of various chart series to be plot inside the chart.

Empty array is not allowed.

Specifies whether or not the chart is rotated.

Specifies how the bars/lines should be placed when multiple series are rendered in the same chart.

Only applicable to bar and line series.

Specifies whether to first try matching the colors from the layer renderer or the chart renderer for coloring the chart elements, like markers, line segments, columns, etc.

To do so, this property needs to be set to true.

When there is no matching color found (for when colorMatch = true) or when colorMatch = false, the colors from the config, and then from the color ramps will be used, in that order.

Renderer to use to style the series when the chart uses the color match mode.

Considered before the layer's renderer.

Chart order options for data and series.

Represents the size of the hole in middle of the chart. The number is used as a percentage rather than a fixed value.

Represents where is the chart's starting point

Represents where is the chart's ending point. To be related with startAngle. If endAngle-startAngle is 360 the chart will render as a full circle.

Array of one WebChartGaugeAxis.

The type of gauge, like FeatureGauge or StatisticGauge.

When this property is not specified, it will be defaulted to GaugeChartSubTypes.StatisticGauge.

Whether to show the outliers on the chart.

Whether to standardize the values by calculating the series z-score.

Whether to show the mean lines on the chart. Applies only if a split-by field is set.

Additionally the chart will render with that option enabled only if the the series array contains one box plot series and N lines series.

The box plot series can be of type boxPlotSeries or lineSeries.

The radar chart series.

Array of two axes, one specific to the radar chart and the other one common to all charts.

The heat chart series.

Whether to hide entire rows or columns that are empty (i.e. contain no valid data).

The calendar view type for the heat chart.

NOTE: This property is only applicable to the calendar heat chart.

Whether to include leap day (Feb. 29th) in queries.

Determines whether incomplete time intervals at the start or end of the data span (depending on the timeAggregationType) will be removed from the chart.

Incomplete intervals on a chart can cause misleading results in which the period in question is under- or over reported due to a different amount of time in the interval.

true - trim the incomplete intervals. false - does not trim the incomplete intervals.

The binning start date.

Current limitation: this is applied only when the provided layer supports the queryBins operation.

The binning end date.

Current limitation: this is applied only when the provided layer supports the queryBins operation.

Offset to apply to the results.

Current limitation: this is applied only when the provided layer supports the queryBins operation.

Defines the IANA time zone used for temporal bin calculations.

Current limitation: this is applied only when the provided layer supports the queryBins operation.

The first day of the week. This property is used to determine the start of the week for date-based bins. The default value depends on the user locale (e.g. 7 as Sunday for US, 1 as Monday for France).

Current limitation: this is applied only when the provided layer supports the queryBins operation.

How summarized bins returning a null value are displayed. Supported options are:

• null, zero, and interpolate for line series.
• null and zero for bar series.