API reference
Charts
Legacy `c:` chart kinds plus the `cx:` chartex family.
Chart
src/chart/chart.ts# makeArea3DChart function
src/chart/chart.ts:1006function makeArea3DChart(opts: { axIds?: [number, number, number]; gapDepth?: number; grouping?: GroupingType; series?: BarSeries[]; varyColors?: boolean }): Area3DChartParameters
| Name | Type | Description |
|---|---|---|
opts | { axIds?: [number, number, number]; gapDepth?: number; grouping?: GroupingType; series?: BarSeries[]; varyColors?: boolean } |
Returns
Area3DChart
# makeAreaChart function
src/chart/chart.ts:778function makeAreaChart(opts: { axIds?: [number, number]; grouping?: GroupingType; series?: BarSeries[]; varyColors?: boolean }): AreaChartParameters
| Name | Type | Description |
|---|---|---|
opts | { axIds?: [number, number]; grouping?: GroupingType; series?: BarSeries[]; varyColors?: boolean } |
Returns
AreaChart
# makeBar3DChart function
src/chart/chart.ts:958function makeBar3DChart(opts: { axIds?: [number, number, number]; barDir?: BarDirection; gapDepth?: number; gapWidth?: number; grouping?: GroupingType; series?: BarSeries[]; shape?: "cone" | "coneToMax" | "box" | "cylinder" | "pyramid" | "pyramidToMax"; varyColors?: boolean }): Bar3DChartParameters
| Name | Type | Description |
|---|---|---|
opts | { axIds?: [number, number, number]; barDir?: BarDirection; gapDepth?: number; gapWidth?: number; grouping?: GroupingType; series?: BarSeries[]; shape?: "cone" | "coneToMax" | "box" | "cylinder" | "pyramid" | "pyramidToMax"; varyColors?: boolean } |
Returns
Bar3DChart
# makeBarChart function
src/chart/chart.ts:692function makeBarChart(opts: { axIds?: [number, number]; barDir?: BarDirection; gapWidth?: number; grouping?: GroupingType; overlap?: number; series?: BarSeries[]; varyColors?: boolean }): BarChartParameters
| Name | Type | Description |
|---|---|---|
opts | { axIds?: [number, number]; barDir?: BarDirection; gapWidth?: number; grouping?: GroupingType; overlap?: number; series?: BarSeries[]; varyColors?: boolean } |
Returns
BarChart
# makeBarSeries function
src/chart/chart.ts:713function makeBarSeries(opts: { cat?: CategoryRef; idx: number; order?: number; tx?: { kind: "literal"; value: string } | { kind: "ref"; ref: string }; val: NumericRef }): BarSeriesParameters
| Name | Type | Description |
|---|---|---|
opts | { cat?: CategoryRef; idx: number; order?: number; tx?: { kind: "literal"; value: string } | { kind: "ref"; ref: string }; val: NumericRef } |
Returns
BarSeries
# makeBubbleChart function
src/chart/chart.ts:866function makeBubbleChart(opts: { axIds?: [number, number]; bubble3D?: boolean; bubbleScale?: number; series?: BubbleSeries[]; showNegBubbles?: boolean; sizeRepresents?: BubbleSizeRepresents; varyColors?: boolean }): BubbleChartParameters
| Name | Type | Description |
|---|---|---|
opts | { axIds?: [number, number]; bubble3D?: boolean; bubbleScale?: number; series?: BubbleSeries[]; showNegBubbles?: boolean; sizeRepresents?: BubbleSizeRepresents; varyColors?: boolean } |
Returns
BubbleChart
# makeBubbleSeries function
src/chart/chart.ts:887function makeBubbleSeries(opts: { bubble3D?: boolean; bubbleSize: NumericRef; idx: number; order?: number; tx?: { kind: "literal"; value: string } | { kind: "ref"; ref: string }; xVal?: NumericRef; yVal: NumericRef }): BubbleSeriesParameters
| Name | Type | Description |
|---|---|---|
opts | { bubble3D?: boolean; bubbleSize: NumericRef; idx: number; order?: number; tx?: { kind: "literal"; value: string } | { kind: "ref"; ref: string }; xVal?: NumericRef; yVal: NumericRef } |
Returns
BubbleSeries
# makeChartSpace function
src/chart/chart.ts:729function makeChartSpace(opts: { backWall?: SurfaceFrame; dispBlanksAs?: "gap" | "zero" | "span"; floor?: SurfaceFrame; legend?: Legend; plotArea: PlotArea; plotVisOnly?: boolean; sideWall?: SurfaceFrame; spPr?: ShapeProperties; style?: number; title?: string | ChartTitle; txPr?: TextBody; view3D?: View3D }): ChartSpaceParameters
| Name | Type | Description |
|---|---|---|
opts | { backWall?: SurfaceFrame; dispBlanksAs?: "gap" | "zero" | "span"; floor?: SurfaceFrame; legend?: Legend; plotArea: PlotArea; plotVisOnly?: boolean; sideWall?: SurfaceFrame; spPr?: ShapeProperties; style?: number; title?: string | ChartTitle; txPr?: TextBody; view3D?: View3D } |
Returns
ChartSpace
# makeDoughnutChart function
src/chart/chart.ts:801function makeDoughnutChart(opts: { firstSliceAng?: number; holeSize?: number; series?: BarSeries[]; varyColors?: boolean }): DoughnutChartParameters
| Name | Type | Description |
|---|---|---|
opts | { firstSliceAng?: number; holeSize?: number; series?: BarSeries[]; varyColors?: boolean } |
Returns
DoughnutChart
# makeLine3DChart function
src/chart/chart.ts:981function makeLine3DChart(opts: { axIds?: [number, number, number]; gapDepth?: number; grouping?: GroupingType; series?: LineSeries[]; varyColors?: boolean }): Line3DChartParameters
| Name | Type | Description |
|---|---|---|
opts | { axIds?: [number, number, number]; gapDepth?: number; grouping?: GroupingType; series?: LineSeries[]; varyColors?: boolean } |
Returns
Line3DChart
# makeLineChart function
src/chart/chart.ts:761function makeLineChart(opts: { axIds?: [number, number]; grouping?: GroupingType; series?: LineSeries[]; smooth?: boolean; varyColors?: boolean }): LineChartParameters
| Name | Type | Description |
|---|---|---|
opts | { axIds?: [number, number]; grouping?: GroupingType; series?: LineSeries[]; smooth?: boolean; varyColors?: boolean } |
Returns
LineChart
# makeOfPieChart function
src/chart/chart.ts:935function makeOfPieChart(opts: { custSplit?: number[]; gapWidth?: number; ofPieType?: OfPieType; secondPieSize?: number; series?: BarSeries[]; splitPos?: number; splitType?: SplitType; varyColors?: boolean }): OfPieChartParameters
| Name | Type | Description |
|---|---|---|
opts | { custSplit?: number[]; gapWidth?: number; ofPieType?: OfPieType; secondPieSize?: number; series?: BarSeries[]; splitPos?: number; splitType?: SplitType; varyColors?: boolean } |
Returns
OfPieChart
# makePie3DChart function
src/chart/chart.ts:998function makePie3DChart(opts: { series?: BarSeries[]; varyColors?: boolean }): Pie3DChartParameters
| Name | Type | Description |
|---|---|---|
opts | { series?: BarSeries[]; varyColors?: boolean } |
Returns
Pie3DChart
# makePieChart function
src/chart/chart.ts:793function makePieChart(opts: { series?: BarSeries[]; varyColors?: boolean }): PieChartParameters
| Name | Type | Description |
|---|---|---|
opts | { series?: BarSeries[]; varyColors?: boolean } |
Returns
PieChart
# makeRadarChart function
src/chart/chart.ts:851function makeRadarChart(opts: { axIds?: [number, number]; radarStyle?: RadarStyle; series?: BarSeries[]; varyColors?: boolean }): RadarChartParameters
| Name | Type | Description |
|---|---|---|
opts | { axIds?: [number, number]; radarStyle?: RadarStyle; series?: BarSeries[]; varyColors?: boolean } |
Returns
RadarChart
# makeScatterChart function
src/chart/chart.ts:816function makeScatterChart(opts: { axIds?: [number, number]; scatterStyle?: ScatterStyle; series?: ScatterSeries[]; varyColors?: boolean }): ScatterChartParameters
| Name | Type | Description |
|---|---|---|
opts | { axIds?: [number, number]; scatterStyle?: ScatterStyle; series?: ScatterSeries[]; varyColors?: boolean } |
Returns
ScatterChart
# makeScatterSeries function
src/chart/chart.ts:831function makeScatterSeries(opts: { idx: number; marker?: Marker; order?: number; smooth?: boolean; tx?: { kind: "literal"; value: string } | { kind: "ref"; ref: string }; xVal?: NumericRef; yVal: NumericRef }): ScatterSeriesParameters
| Name | Type | Description |
|---|---|---|
opts | { idx: number; marker?: Marker; order?: number; smooth?: boolean; tx?: { kind: "literal"; value: string } | { kind: "ref"; ref: string }; xVal?: NumericRef; yVal: NumericRef } |
Returns
ScatterSeries
# makeStockChart function
src/chart/chart.ts:907function makeStockChart(opts: { axIds?: [number, number]; hiLowLines?: boolean | HiLowLines; series?: BarSeries[]; upDownBars?: boolean | UpDownBars }): StockChartParameters
| Name | Type | Description |
|---|---|---|
opts | { axIds?: [number, number]; hiLowLines?: boolean | HiLowLines; series?: BarSeries[]; upDownBars?: boolean | UpDownBars } |
Returns
StockChart
# makeSurface3DChart function
src/chart/chart.ts:1023function makeSurface3DChart(opts: { axIds?: [number, number, number]; series?: BarSeries[]; wireframe?: boolean }): Surface3DChartParameters
| Name | Type | Description |
|---|---|---|
opts | { axIds?: [number, number, number]; series?: BarSeries[]; wireframe?: boolean } |
Returns
Surface3DChart
# makeSurfaceChart function
src/chart/chart.ts:922function makeSurfaceChart(opts: { axIds?: [number, number, number]; series?: BarSeries[]; wireframe?: boolean }): SurfaceChartParameters
| Name | Type | Description |
|---|---|---|
opts | { axIds?: [number, number, number]; series?: BarSeries[]; wireframe?: boolean } |
Returns
SurfaceChart
Chartex
src/chart/cx/chartex.ts# makeBoxWhiskerChart function
src/chart/cx/chartex.ts:448function makeBoxWhiskerChart(opts: { catRef?: string; meanLine?: boolean; meanMarker?: boolean; nonoutliers?: boolean; outliers?: boolean; quartileMethod?: "exclusive" | "inclusive"; valRef?: string }): CxChartSpaceParameters
| Name | Type | Description |
|---|---|---|
opts | { catRef?: string; meanLine?: boolean; meanMarker?: boolean; nonoutliers?: boolean; outliers?: boolean; quartileMethod?: "exclusive" | "inclusive"; valRef?: string } |
Returns
CxChartSpace
# makeCxAxis function
src/chart/cx/chartex.ts:264function makeCxAxis(opts: { catScalingGapWidth?: number; hidden?: boolean; id: number; majorGridlines?: boolean; spPr?: ShapeProperties; title?: CxTitle; txPr?: TextBody; valScaling?: { max?: number; min?: number } }): CxAxisParameters
| Name | Type | Description |
|---|---|---|
opts | { catScalingGapWidth?: number; hidden?: boolean; id: number; majorGridlines?: boolean; spPr?: ShapeProperties; title?: CxTitle; txPr?: TextBody; valScaling?: { max?: number; min?: number } } |
Returns
CxAxis
# makeCxChartSpace function
src/chart/cx/chartex.ts:284function makeCxChartSpace(opts: { axes?: CxAxis[]; data?: CxData[]; dispBlanksAs?: "gap" | "zero" | "span"; externalData?: CxExternalData; legend?: CxLegend; plotAreaSpPr?: ShapeProperties; plotVisOnly?: boolean; series: CxSeries[]; spPr?: ShapeProperties; title?: CxTitle; txPr?: TextBody }): CxChartSpaceParameters
| Name | Type | Description |
|---|---|---|
opts | { axes?: CxAxis[]; data?: CxData[]; dispBlanksAs?: "gap" | "zero" | "span"; externalData?: CxExternalData; legend?: CxLegend; plotAreaSpPr?: ShapeProperties; plotVisOnly?: boolean; series: CxSeries[]; spPr?: ShapeProperties; title?: CxTitle; txPr?: TextBody } |
Returns
CxChartSpace
# makeCxData function
src/chart/cx/chartex.ts:236function makeCxData(id: number, dims: CxDim[]): CxDataParameters
| Name | Type | Description |
|---|---|---|
id | number | |
dims | CxDim[] |
Returns
CxData
# makeCxNumDim function
src/chart/cx/chartex.ts:202function makeCxNumDim(opts: { dir?: "col" | "row"; f?: string; formatCode?: string; ptCount?: number; pts?: CxPoint[]; type: string }): CxNumDimParameters
| Name | Type | Description |
|---|---|---|
opts | { dir?: "col" | "row"; f?: string; formatCode?: string; ptCount?: number; pts?: CxPoint[]; type: string } |
Returns
CxNumDim
# makeCxSeries function
src/chart/cx/chartex.ts:238function makeCxSeries(opts: { axisIds?: number[]; dataId?: number; dataLabels?: CxDataLabels; formatIdx?: number; hidden?: boolean; layoutId: CxLayoutId; layoutPr?: CxLayoutPr; ownerIdx?: number; spPr?: ShapeProperties; tx?: { f?: string; v?: string }; txPr?: TextBody }): CxSeriesParameters
| Name | Type | Description |
|---|---|---|
opts | { axisIds?: number[]; dataId?: number; dataLabels?: CxDataLabels; formatIdx?: number; hidden?: boolean; layoutId: CxLayoutId; layoutPr?: CxLayoutPr; ownerIdx?: number; spPr?: ShapeProperties; tx?: { f?: string; v?: string }; txPr?: TextBody } |
Returns
CxSeries
# makeCxStrDim function
src/chart/cx/chartex.ts:219function makeCxStrDim(opts: { dir?: "col" | "row"; f?: string; formatCode?: string; ptCount?: number; pts?: CxPoint[]; type: string }): CxStrDimParameters
| Name | Type | Description |
|---|---|---|
opts | { dir?: "col" | "row"; f?: string; formatCode?: string; ptCount?: number; pts?: CxPoint[]; type: string } |
Returns
CxStrDim
# makeFunnelChart function
src/chart/cx/chartex.ts:437function makeFunnelChart(opts: { catRef?: string; valRef?: string }): CxChartSpaceParameters
| Name | Type | Description |
|---|---|---|
opts | { catRef?: string; valRef?: string } |
Returns
CxChartSpace
# makeHistogramChart function
src/chart/cx/chartex.ts:378function makeHistogramChart(opts: { binCount?: number; binCountAuto?: boolean; binSize?: number; intervalClosed?: "l" | "r"; overflow?: number; underflow?: number; valRef?: string }): CxChartSpaceParameters
| Name | Type | Description |
|---|---|---|
opts | { binCount?: number; binCountAuto?: boolean; binSize?: number; intervalClosed?: "l" | "r"; overflow?: number; underflow?: number; valRef?: string } |
Returns
CxChartSpace
# makeParetoChart function
src/chart/cx/chartex.ts:408function makeParetoChart(opts: { binCount?: number; binCountAuto?: boolean; binSize?: number; catRef?: string; valRef?: string }): CxChartSpaceParameters
| Name | Type | Description |
|---|---|---|
opts | { binCount?: number; binCountAuto?: boolean; binSize?: number; catRef?: string; valRef?: string } |
Returns
CxChartSpace
# makeRegionMapChart function
src/chart/cx/chartex.ts:482function makeRegionMapChart(opts: { catRef?: string; cultureLanguage?: string; cultureRegion?: string; projectionType?: "automatic" | "mercator" | "miller" | "albers"; regionLabelLayout?: "none" | "bestFit" | "showAll"; valRef?: string }): CxChartSpaceParameters
| Name | Type | Description |
|---|---|---|
opts | { catRef?: string; cultureLanguage?: string; cultureRegion?: string; projectionType?: "automatic" | "mercator" | "miller" | "albers"; regionLabelLayout?: "none" | "bestFit" | "showAll"; valRef?: string } |
Returns
CxChartSpace
# makeSunburstChart function
src/chart/cx/chartex.ts:323function makeSunburstChart(opts: { catRef?: string; valFormatCode?: string; valRef?: string }): CxChartSpaceParameters
| Name | Type | Description |
|---|---|---|
opts | { catRef?: string; valFormatCode?: string; valRef?: string } |
Returns
CxChartSpace
# makeTreemapChart function
src/chart/cx/chartex.ts:338function makeTreemapChart(opts: { catRef?: string; parentLabelLayout?: "none" | "overlapping" | "banner"; valRef?: string }): CxChartSpaceParameters
| Name | Type | Description |
|---|---|---|
opts | { catRef?: string; parentLabelLayout?: "none" | "overlapping" | "banner"; valRef?: string } |
Returns
CxChartSpace
# makeWaterfallChart function
src/chart/cx/chartex.ts:359function makeWaterfallChart(opts: { catRef?: string; subtotalIdx?: number[]; valRef?: string }): CxChartSpaceParameters
| Name | Type | Description |
|---|---|---|
opts | { catRef?: string; subtotalIdx?: number[]; valRef?: string } |
Returns
CxChartSpace
User shapes
src/chart/user-shapes.ts# makeAbsSizeAnchor function
src/chart/user-shapes.ts:88function makeAbsSizeAnchor(from: ChartRelativeMarker, ext: PositiveSize2D, content: UserShapeContent): UserShapeAnchorParameters
| Name | Type | Description |
|---|---|---|
from | ChartRelativeMarker | |
ext | PositiveSize2D | |
content | UserShapeContent |
Returns
UserShapeAnchor
# makeChartDrawing function
src/chart/user-shapes.ts:62function makeChartDrawing(shapes?: UserShapeAnchor[]): ChartDrawingParameters
| Name | Type | Description |
|---|---|---|
shapes? = [] | UserShapeAnchor[] |
Returns
ChartDrawing
# makeChartShape function
src/chart/user-shapes.ts:64function makeChartShape(opts: { descr?: string; hidden?: boolean; id: number; name?: string; spPr?: ShapeProperties; txBody?: TextBody; txBox?: boolean }): ChartDrawingShapeParameters
| Name | Type | Description |
|---|---|---|
opts | { descr?: string; hidden?: boolean; id: number; name?: string; spPr?: ShapeProperties; txBody?: TextBody; txBox?: boolean } |
Returns
ChartDrawingShape
# makeRelSizeAnchor function
src/chart/user-shapes.ts:82function makeRelSizeAnchor(from: ChartRelativeMarker, to: ChartRelativeMarker, content: UserShapeContent): UserShapeAnchorParameters
| Name | Type | Description |
|---|---|---|
from | ChartRelativeMarker | |
to | ChartRelativeMarker | |
content | UserShapeContent |
Returns
UserShapeAnchor