No Preview

Sorry, but you either have no stories or none are selected somehow.

If the problem persists, check the browser console, or the terminal you've run Storybook from.

The component failed to render properly, likely due to a configuration issue in Storybook. Here are some common causes and how you can address them:

  1. Missing Context/Providers: You can use decorators to supply specific contexts or providers, which are sometimes necessary for components to render correctly. For detailed instructions on using decorators, please visit the Decorators documentation.
  2. Misconfigured Webpack or Vite: Verify that Storybook picks up all necessary settings for loaders, plugins, and other relevant parameters. You can find step-by-step guides for configuring Webpack or Vite with Storybook.
  3. Missing Environment Variables: Your Storybook may require specific environment variables to function as intended. You can set up custom environment variables as outlined in the Environment Variables documentation.

WebChartLineChartSeries

JSON representation of the Line Chart series.

Referenced by: WebChartSeriesType, WebMapWebBoxPlot, WebBoxPlot

Properties

PropertyDetails
type*

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


The type of this property is: string .

y*

Specifies the numeric field(s) used by the series. The array type is useful when used for a box plot.


Can be any of: array , string

lineSymbolContains styling info on how the line/line segments should be rendered
lineSmoothed

Specifies whether line segments should be smoothed.


The type of this property is: boolean .

showArea

Indicates whether line series show area.


The type of this property is: boolean .

markerVisible

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


The type of this property is: boolean .

markerSymbolContains styling info on how the marker should be rendered
areaColor

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.


The type of this property is: array. Minimum length: 4 . Maximum length: 4 .

stackNegativeValuesToBaseline

Specifies how negative values are treated in stacked series.


If true, negative values will be stacked on the base line.


If false, negative values will be stacked in relation to their previous values in the stack.


The type of this property is: boolean .

id*

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


The type of this property is: string .

visible

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


The type of this property is: boolean .

dataTooltipVisible

Hides or shows data tooltips.


Applies to all charts but Gauge.


The type of this property is: boolean .

dataTooltipReverseColor

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


Applies to all charts but Gauge.


The type of this property is: boolean .

dataTooltipValueFormatDefines how to render numeric values in tooltips.
dataTooltipPercentFormat

Defines how to render percent values in tooltips.


Currently used for stacked 100% bar and line charts, as well as pie charts.

dataTooltipDateFormat

Defines how to render dates in tooltips.


Currently used for bar and line charts using a date x-axis with no time binning.

name*

Specifies the name of the series. It would be reflected in the chart legends


The type of this property is: string .

query

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

x*

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, _) are needed.


The type of this property is: string .

dataLabelsSpecifies how the data labels should be rendered.
assignToSecondValueAxis

Specifies whether the series should be assigned to the second value axis, when the axes property defines it.


Supported by bar and line series.


The type of this property is: boolean .

binTemporalData

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


If set to false the timeIntervalSize and timeIntervalUnits properties can be used to set the date axis base interval.


The type of this property is: boolean .

timeIntervalUnits

The time unit that corresponds to the timeIntervalSize . Valid options include seconds, minutes, hours, days, weeks, months, and years.


The type of this property is: string .


Must be one of the following values: esriTimeUnitsDays , esriTimeUnitsHours , esriTimeUnitsMinutes , esriTimeUnitsMonths , esriTimeUnitsSeconds , esriTimeUnitsWeeks , esriTimeUnitsYears .

timeIntervalSize

The span of time that will be binned or aggregated together. This property must be used in conjunction with timeIntervalUnits .


The type of this property is: number .

timeAggregationType

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


The type of this property is: string .


Must be one of the following values: equalIntervalsFromEndTime , equalIntervalsFromStartTime .

trimIncompleteTimeInterval

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 overreported due to a different amount of time in the interval.


Setting true indicates to trim these incomplete intervals. Setting false does not trim incomplete intervals.


The type of this property is: boolean .

nullPolicy

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


The type of this property is: string .


Must be one of the following values: interpolate , null , zero .