chartEx charts

getChartSeriesCount(c::ChartEx) -> Int

Number of series in the chart. A Pareto chart's Pareto line is not counted: it belongs to its column series, and is reached with pareto = true.

getChartDataBlocks(c::ChartEx) -> Vector{ChartExData}

Every cx:data block in the chart, in document order, with its dimensions.

getChartAxisIds(c::ChartEx) -> Vector{Int}

The id of each cx:axis, in document order. These are the values getSeriesAxisIds refers to.

getChartTitleRange(c::ChartEx) -> ChartRange

The cell the chart title is bound to. nothing if the title is typed or absent.

getSeriesLayout(c::ChartEx, i; pareto=false) -> Symbol

The layout of series i as written in its layoutId attribute, e.g. :waterfall, :funnel, :treemap, :clusteredColumn. With pareto = true, the layout of series i's Pareto line, :paretoLine; an error if it has none.

See also getChartType, which describes the chart as a whole.

getSeriesLayoutFlag(c::ChartEx, i, flag) -> Union{Nothing, Bool}

One attribute of cx:layoutPr/cx:visibility: :meanLine, :meanMarker, :nonoutliers, :outliers (box & whisker) or :connectorLines (waterfall). nothing if not written.

getSeriesData(c::ChartEx, i; pareto=false) -> Union{Nothing, ChartExData}

The data block series i draws from, found through its cx:dataId. With pareto = true, series i's Pareto line instead; an error if it has none. nothing if the series names no data block.

getSeriesName(c::ChartEx, i; pareto=false) -> Union{Nothing, String}

The name of series i, typed or the cached value of a cell binding. nothing if the series has no name of its own.

With pareto = true, series i's Pareto line instead; an error if it has none.

getSeriesNameRange(c::ChartEx, i; pareto=false) -> ChartRange

The cell a series name is bound to. nothing if the name is typed or absent.

With pareto = true, series i's Pareto line instead; an error if it has none.

getSeriesHidden(c::ChartEx, i; pareto=false) -> Union{Nothing, Bool}

The series' hidden attribute. With pareto = true, series i's Pareto line instead; an error if it has none. nothing if not written.

getSeriesAxisIds(c::ChartEx, i; pareto=false) -> Vector{Int}

The ids of the cx:axis elements series i is plotted against, as written. These are axis ids, not positions. Empty if the series names none.

With pareto = true, series i's Pareto line instead; an error if it has none.

getSeriesSubtotals(c::ChartEx, i) -> Union{Nothing, Vector{Int}}

The 1-based points of a waterfall series drawn as totals. An empty vector means cx:subtotals is present with no points; nothing means it is absent.

getSeriesBinning(c::ChartEx, i) -> Union{Nothing, ChartExBinning}

Histogram binning for series i; nothing if the series has no cx:binning.

getSeriesAggregation(c::ChartEx, i) -> Bool

Whether series i aggregates repeated categories (cx:aggregation). The element carries no value; its presence is the setting.

getSeriesQuartileMethod(c::ChartEx, i) -> Union{Nothing, Symbol}

Box & whisker quartile calculation, :inclusive or :exclusive.

getSeriesParentLabelLayout(c::ChartEx, i) -> Union{Nothing, Symbol}

Treemap parent label placement, e.g. :overlapping, :banner, :none.

getLabelFlag(c::ChartEx, i, flag; pareto=false) -> Union{Nothing, Bool}

Whether series i's data labels show :seriesName, :categoryName or :value, from cx:dataLabels/cx:visibility. With pareto = true, series i's Pareto line instead; an error if it has none. nothing if not written.

getLabelPosition(c::ChartEx, i; pareto=false) -> Union{Nothing, Symbol}

Data label position for series i, e.g. :outEnd (outside-end), :inEnd (inside-end), :ctr (centre). With pareto = true, series i's Pareto line instead; an error if it has none.

setSeriesName(c::ChartEx, i, name::AbstractString; pareto=false) -> ChartEx

Set the name of series i to name, typed rather than bound to a cell. Creates the series' cx:tx if it has none, and drops any cx:f binding. With pareto = true, series i's Pareto line instead; an error if it has none.

Returns c, which remains valid.

setSeriesLayoutFlag(c::ChartEx, i, flag, value) -> ChartEx

Set one attribute of cx:layoutPr/cx:visibility: :meanLine, :meanMarker, :nonoutliers, :outliers (box & whisker) or :connectorLines (waterfall). value is a Bool, or :inherit to remove the attribute.

setSeriesSubtotals(c::ChartEx, i, points) -> ChartEx

Mark the given points of a waterfall series as totals, replacing whatever was marked before. points counts from 1, in any order; an empty collection writes <cx:subtotals/>, which is what Excel writes for a waterfall with no totals.

Pass :inherit to remove cx:subtotals entirely. Any other value is an error unless series i is a waterfall series (Excel refuses a file with subtotals on other layouts).

Returns c, which remains valid.

setSeriesBinning(c::ChartEx, i; intervalClosed, underflow, overflow, binSize, binCount) -> ChartEx

Set histogram binning for series i in one rebuild. A keyword left unspecified is left alone; pass :inherit to remove one that is set.

intervalClosed is :r (right-closed) or :l (left-closed). underflow and overflow take a number or :auto. binSize and binCount are alternatives: setting one removes the other. cx:binning excludes cx:aggregation, which is removed if present.

setSeriesAggregation(c::ChartEx, i, on::Bool) -> ChartEx

Turn category aggregation on or off for series i. cx:aggregation carries no value, so its presence is the setting. It excludes cx:binning, which is removed when this is turned on.

setSeriesQuartileMethod(c::ChartEx, i, method) -> ChartEx

Set the quartile calculation of a box & whisker series to :inclusive or :exclusive, or :inherit to remove cx:statistics. Setting a method is an error unless series i is a box & whisker series (Excel refuses a file with one on other layouts).

setSeriesParentLabelLayout(c::ChartEx, i, layout) -> ChartEx

Set a treemap series' parent label placement to :none, :banner or :overlapping, or :inherit to remove cx:parentLabelLayout.