Chart

Defined in: src/core/document-model/types.ts:1774

A parsed chart (§21.2): its type, title, categories, series and rendering options.

Properties

backWall?

readonly optional backWall?: ChartSurface

Defined in: src/core/document-model/types.ts:1826

§21.2.2.11 c:backWall — the wall behind the bars; absent, nothing drawn.

bar3D?

readonly optional bar3D?: object

Defined in: src/core/document-model/types.ts:1814

§21.2.2.15 c:bar3DChart with §21.2.2.228 c:view3D — bars drawn as boxes standing in a box of walls and a floor, seen at an angle with the axes kept square: rotX the elevation and rotY the turn in degrees, depthPercent a bar’s depth as a percentage of its width, gapDepth the room before and behind it as a percentage of its depth.

depthPercent

readonly depthPercent: number

gapDepth

readonly gapDepth: number

rotX

readonly rotX: number

rotY

readonly rotY: number

barDir?

readonly optional barDir?: "bar" | "col"

Defined in: src/core/document-model/types.ts:1798

catAxisCrosses?

readonly optional catAxisCrosses?: number | "min" | "max"

Defined in: src/core/document-model/types.ts:1878

§21.2.2.33/§21.2.2.34 c:catAx/c:crosses, c:crossesAt — where along the value axis the category axis lies, and so where bars grow from: at the axis’s minimum or maximum, or at a stated value. Absent ⇒ autoZero, at zero (or the end of the value axis nearest it).

catAxisDeleted?

readonly optional catAxisDeleted?: boolean

Defined in: src/core/document-model/types.ts:1925

§21.2.2.40 c:delete — the author deleted the category axis (a scatter’s x axis): neither its rule nor its labels are drawn, nor room kept for them.

catAxisLine?

readonly optional catAxisLine?: ChartLineStyle

Defined in: src/core/document-model/types.ts:1908

§21.2.2.196 — the category axis’s own rule.

catAxisReversed?

readonly optional catAxisReversed?: boolean

Defined in: src/core/document-model/types.ts:1871

§21.2.2.134 c:catAx/c:scaling/c:orientation = maxMin — the category axis runs the other way. A ranked bar chart is written this way so its first row reads at the TOP (dataValidationTableRange.xlsx ranks 38 counties and we printed the ranking upside down).

catAxisTitle?

readonly optional catAxisTitle?: string

Defined in: src/core/document-model/types.ts:1864

categoriesRef?

readonly optional categoriesRef?: string

Defined in: src/core/document-model/types.ts:1785

§21.2.2.24 c:cat/…/c:f — where the categories live, when uncached.

categoryGroups?

readonly optional categoryGroups?: readonly readonly object[][]

Defined in: src/core/document-model/types.ts:1792

§21.2.2.115 c:multiLvlStrCache — the outer levels of a category axis labelled on more than one: each level’s groups, innermost level first, each group from the category it starts at to the next group’s start. Chart.categories is the innermost level, one label per category.

catTickLabelPos?

readonly optional catTickLabelPos?: "none" | "low" | "high"

Defined in: src/core/document-model/types.ts:1885

§21.2.2.207 c:catAx/c:tickLblPos — where the category labels stand: at the low or high end of the value axis, or nowhere. Absent ⇒ nextTo, beside the category axis wherever it crosses — on the zero line of a chart with values below zero.

dataLabels?

readonly optional dataLabels?: ChartDataLabels

Defined in: src/core/document-model/types.ts:1852

§21.2.2.49 — the data labels’ switches, when the chart has a c:dLbls at all. Absent, it labels nothing.

doughnut?

readonly optional doughnut?: boolean

Defined in: src/core/document-model/types.ts:1800

firstSliceAngle?

readonly optional firstSliceAngle?: number

Defined in: src/core/document-model/types.ts:1830

§21.2.2.68 c:firstSliceAng — a flat pie’s first slice, degrees clockwise from twelve.

floor?

readonly optional floor?: ChartSurface

Defined in: src/core/document-model/types.ts:1824

§21.2.2.69 c:floor — a 3-D chart’s floor, the wall its bars stand on: its fill and its rule. Absent, it is unfilled and ruled in light grey.

frameFillHex?

readonly optional frameFillHex?: string

Defined in: src/core/document-model/types.ts:1956

§21.2.2.198 c:chartSpace/c:spPr — the frame around the whole chart: its background fill and its outline. Excel writes both on every chart it creates, and both references draw them.

frameFillImage?

readonly optional frameFillImage?: object

Defined in: src/core/document-model/types.ts:1962

§20.1.8.14 a:blipFill — the PICTURE the frame is filled with, when it is filled with one rather than a colour. chart-texture-bg.pptx papers its whole chart with a woven cloth, and a chart on white is a different chart.

resource

readonly resource: ResourceId

tiled?

readonly optional tiled?: boolean

frameLineDash?

readonly optional frameLineDash?: ShapeDash

Defined in: src/core/document-model/types.ts:1966

frameLineHex?

readonly optional frameLineHex?: string

Defined in: src/core/document-model/types.ts:1963

frameLineWidthPt?

readonly optional frameLineWidthPt?: number

Defined in: src/core/document-model/types.ts:1965

The frame rule’s width and dash, when it states them.

gapPercent?

readonly optional gapPercent?: number

Defined in: src/core/document-model/types.ts:1857

§21.2.2.75 c:gapWidth — the gap between category slots as a percentage of the bar width. Absent ⇒ the schema’s 150.

gridLine?

readonly optional gridLine?: ChartLineStyle

Defined in: src/core/document-model/types.ts:1918

§21.2.2.100 c:majorGridlines of the value axis (a scatter’s upright one) — its own rule (§21.2.2.197 c:spPr/a:ln). An axis without the element rules nothing, which reads { none: true }; absent, the default rule.

grouping?

readonly optional grouping?: "clustered" | "stacked" | "percentStacked" | "standard"

Defined in: src/core/document-model/types.ts:1799

hasLegend

readonly hasLegend: boolean

Defined in: src/core/document-model/types.ts:1796

legendPos?

readonly optional legendPos?: "r" | "l" | "t" | "b"

Defined in: src/core/document-model/types.ts:1797

lineMarkers?

readonly optional lineMarkers?: boolean

Defined in: src/core/document-model/types.ts:1906

§21.2.2.106 c:marker on a c:lineChart — whether the group’s series mark their data points. WithChart.xlsx asks for them and we drew bare lines.

numberFormat?

readonly optional numberFormat?: string

Defined in: src/core/document-model/types.ts:1979

§21.2.2.121 c:valAx/c:numFmt@formatCode — the number format the value axis’s tick labels and the data labels are drawn in, in the same code grammar cells use (§18.8.31). Absent ⇒ a plain numeric render.

overlapPercent?

readonly optional overlapPercent?: number

Defined in: src/core/document-model/types.ts:1863

§21.2.2.131 c:overlap — how far the bars of one category’s cluster lie over each other, as a percentage of a bar’s width: −100 a bar’s width apart … 100 one on the next. Absent ⇒ 0, bars side by side.

pie3D?

readonly optional pie3D?: object

Defined in: src/core/document-model/types.ts:1806

§21.2.2.140 c:pie3DChart with §21.2.2.228 c:view3D — a pie drawn as a tilted disc: rotX the elevation in degrees (90 looks straight down), rotY how far its first slice is turned clockwise from twelve o’clock.

rotX

readonly rotX: number

rotY

readonly rotY: number

plotBox?

readonly optional plotBox?: object

Defined in: src/core/document-model/types.ts:1836

§21.2.2.104 c:plotArea/c:layout/c:manualLayout in edge mode — the box the author sized the plot to, as fractions of the chart from its top left; a pie is fitted into it whole, keeping its shape.

h

readonly h: number

inner?

readonly optional inner?: boolean

c:layoutTarget inner — the box is the plot’s own rectangle, the axes’ labels outside it; else (outer) it holds them too.

w

readonly w: number

x

readonly x: number

y

readonly y: number

plotFillHex?

readonly optional plotFillHex?: string

Defined in: src/core/document-model/types.ts:1972

§21.2.2.145 c:plotArea/c:spPr — the plot rectangle’s own fill and rule, which sit inside the frame. Chart_Plot_BorderLine_Style.docx rules its plot in a heavy orange dash-dot.

plotLine?

readonly optional plotLine?: ChartLineStyle

Defined in: src/core/document-model/types.ts:1973

scatterStyle?

readonly optional scatterStyle?: "line" | "none" | "lineMarker" | "marker" | "smooth" | "smoothMarker"

Defined in: src/core/document-model/types.ts:1901

§21.2.2.161 c:scatterStyle — whether a scatter’s points are joined by a line, marked, or both. The schema’s default is marker; Excel writes lineMarker for the chart most people insert.

secondaryValAxisLine?

readonly optional secondaryValAxisLine?: ChartLineStyle

Defined in: src/core/document-model/types.ts:1912

§21.2.2.196 — the secondary value axis’s own rule.

secondaryValAxisTitle?

readonly optional secondaryValAxisTitle?: string

Defined in: src/core/document-model/types.ts:1895

§21.2.2.168 — the title of the secondary value axis, when one is drawn.

series

readonly series: readonly ChartSeries[]

Defined in: src/core/document-model/types.ts:1795

seriesColorCycle?

readonly optional seriesColorCycle?: readonly string[]

Defined in: src/core/document-model/types.ts:1984

MS-ODRAWXML chartColorStyle (colorsN.xml): the cycle of series colours; overrides the built-in Office accent cycle when present.

showValues?

readonly optional showValues?: boolean

Defined in: src/core/document-model/types.ts:1847

sideWall?

readonly optional sideWall?: ChartSurface

Defined in: src/core/document-model/types.ts:1828

§21.2.2.191 c:sideWall — the wall beside them; absent, nothing drawn.

text?

readonly optional text?: ChartTextStyles

Defined in: src/core/document-model/types.ts:1782

The chart’s text, role by role, as its application sets it. Absent when the reader resolves none: the renderer then keeps its own sizes and greys in the document’s base face.

title?

readonly optional title?: string

Defined in: src/core/document-model/types.ts:1776

type

readonly type: ChartType

Defined in: src/core/document-model/types.ts:1775

valAxisCrosses?

readonly optional valAxisCrosses?: number | "min" | "max"

Defined in: src/core/document-model/types.ts:1892

§21.2.2.33 c:valAx/c:crosses — where along the category axis the value axis lies: at the last category (max) or the first (absent, autoZero). The first is at the far end when the categories run backwards (Chart.catAxisReversed): a ranked bar chart has its values on top.

valAxisDeleted?

readonly optional valAxisDeleted?: boolean

Defined in: src/core/document-model/types.ts:1927

§21.2.2.40 — …or the value axis (a scatter’s upright one).

valAxisLine?

readonly optional valAxisLine?: ChartLineStyle

Defined in: src/core/document-model/types.ts:1910

§21.2.2.196 — the value axis’s own rule.

valAxisMajorUnit?

readonly optional valAxisMajorUnit?: number

Defined in: src/core/document-model/types.ts:1940

§21.2.2.103 c:valAx/c:majorUnit — the step between the value axis’s labels, when the author fixed it. Absent ⇒ the application’s own choice.

valAxisMax?

readonly optional valAxisMax?: number

Defined in: src/core/document-model/types.ts:1935

valAxisMin?

readonly optional valAxisMin?: number

Defined in: src/core/document-model/types.ts:1934

§21.2.2.157 c:valAx/c:scaling/c:min|c:max — the value axis the AUTHOR fixed. Absent means “auto”, and only then is the range read off the data: a chart whose cells all read zero still has the axis its author pinned, and scaling it to the data drew 0…1 where every reader draws 0…300.

valAxisTitle?

readonly optional valAxisTitle?: string

Defined in: src/core/document-model/types.ts:1893

xAxisMajorUnit?

readonly optional xAxisMajorUnit?: number

Defined in: src/core/document-model/types.ts:1949

xAxisMax?

readonly optional xAxisMax?: number

Defined in: src/core/document-model/types.ts:1948

xAxisMin?

readonly optional xAxisMin?: number

Defined in: src/core/document-model/types.ts:1947

§21.2.2.226 — a scatter’s lying value axis, the x’s: the ends and step the author fixed and its number format, as Chart.valAxisMin, Chart.valAxisMax, Chart.valAxisMajorUnit and Chart.numberFormat are its upright one’s.

xGridLine?

readonly optional xGridLine?: ChartLineStyle

Defined in: src/core/document-model/types.ts:1920

The same for a scatter’s lying (x) axis.

xNumberFormat?

readonly optional xNumberFormat?: string

Defined in: src/core/document-model/types.ts:1950