API reference

Charts

Legacy `c:` chart kinds plus the `cx:` chartex family.

38 exports · 3 source files

Chart

src/chart/chart.ts

# makeArea3DChart function

src/chart/chart.ts:1006
function makeArea3DChart(opts: { axIds?: [number, number, number]; gapDepth?: number; grouping?: GroupingType; series?: BarSeries[]; varyColors?: boolean }): Area3DChart

Parameters

NameTypeDescription
opts { axIds?: [number, number, number]; gapDepth?: number; grouping?: GroupingType; series?: BarSeries[]; varyColors?: boolean }

Returns

Area3DChart

# makeAreaChart function

src/chart/chart.ts:778
function makeAreaChart(opts: { axIds?: [number, number]; grouping?: GroupingType; series?: BarSeries[]; varyColors?: boolean }): AreaChart

Parameters

NameTypeDescription
opts { axIds?: [number, number]; grouping?: GroupingType; series?: BarSeries[]; varyColors?: boolean }

Returns

AreaChart

# makeBar3DChart function

src/chart/chart.ts:958
function 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 }): Bar3DChart

Parameters

NameTypeDescription
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:692
function makeBarChart(opts: { axIds?: [number, number]; barDir?: BarDirection; gapWidth?: number; grouping?: GroupingType; overlap?: number; series?: BarSeries[]; varyColors?: boolean }): BarChart

Parameters

NameTypeDescription
opts { axIds?: [number, number]; barDir?: BarDirection; gapWidth?: number; grouping?: GroupingType; overlap?: number; series?: BarSeries[]; varyColors?: boolean }

Returns

BarChart

# makeBarSeries function

src/chart/chart.ts:713
function makeBarSeries(opts: { cat?: CategoryRef; idx: number; order?: number; tx?: { kind: "literal"; value: string } | { kind: "ref"; ref: string }; val: NumericRef }): BarSeries

Parameters

NameTypeDescription
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:866
function makeBubbleChart(opts: { axIds?: [number, number]; bubble3D?: boolean; bubbleScale?: number; series?: BubbleSeries[]; showNegBubbles?: boolean; sizeRepresents?: BubbleSizeRepresents; varyColors?: boolean }): BubbleChart

Parameters

NameTypeDescription
opts { axIds?: [number, number]; bubble3D?: boolean; bubbleScale?: number; series?: BubbleSeries[]; showNegBubbles?: boolean; sizeRepresents?: BubbleSizeRepresents; varyColors?: boolean }

Returns

BubbleChart

# makeBubbleSeries function

src/chart/chart.ts:887
function makeBubbleSeries(opts: { bubble3D?: boolean; bubbleSize: NumericRef; idx: number; order?: number; tx?: { kind: "literal"; value: string } | { kind: "ref"; ref: string }; xVal?: NumericRef; yVal: NumericRef }): BubbleSeries

Parameters

NameTypeDescription
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:729
function 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 }): ChartSpace

Parameters

NameTypeDescription
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:801
function makeDoughnutChart(opts: { firstSliceAng?: number; holeSize?: number; series?: BarSeries[]; varyColors?: boolean }): DoughnutChart

Parameters

NameTypeDescription
opts { firstSliceAng?: number; holeSize?: number; series?: BarSeries[]; varyColors?: boolean }

Returns

DoughnutChart

# makeLine3DChart function

src/chart/chart.ts:981
function makeLine3DChart(opts: { axIds?: [number, number, number]; gapDepth?: number; grouping?: GroupingType; series?: LineSeries[]; varyColors?: boolean }): Line3DChart

Parameters

NameTypeDescription
opts { axIds?: [number, number, number]; gapDepth?: number; grouping?: GroupingType; series?: LineSeries[]; varyColors?: boolean }

Returns

Line3DChart

# makeLineChart function

src/chart/chart.ts:761
function makeLineChart(opts: { axIds?: [number, number]; grouping?: GroupingType; series?: LineSeries[]; smooth?: boolean; varyColors?: boolean }): LineChart

Parameters

NameTypeDescription
opts { axIds?: [number, number]; grouping?: GroupingType; series?: LineSeries[]; smooth?: boolean; varyColors?: boolean }

Returns

LineChart

# makeOfPieChart function

src/chart/chart.ts:935
function makeOfPieChart(opts: { custSplit?: number[]; gapWidth?: number; ofPieType?: OfPieType; secondPieSize?: number; series?: BarSeries[]; splitPos?: number; splitType?: SplitType; varyColors?: boolean }): OfPieChart

Parameters

NameTypeDescription
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:998
function makePie3DChart(opts: { series?: BarSeries[]; varyColors?: boolean }): Pie3DChart

Parameters

NameTypeDescription
opts { series?: BarSeries[]; varyColors?: boolean }

Returns

Pie3DChart

# makePieChart function

src/chart/chart.ts:793
function makePieChart(opts: { series?: BarSeries[]; varyColors?: boolean }): PieChart

Parameters

NameTypeDescription
opts { series?: BarSeries[]; varyColors?: boolean }

Returns

PieChart

# makeRadarChart function

src/chart/chart.ts:851
function makeRadarChart(opts: { axIds?: [number, number]; radarStyle?: RadarStyle; series?: BarSeries[]; varyColors?: boolean }): RadarChart

Parameters

NameTypeDescription
opts { axIds?: [number, number]; radarStyle?: RadarStyle; series?: BarSeries[]; varyColors?: boolean }

Returns

RadarChart

# makeScatterChart function

src/chart/chart.ts:816
function makeScatterChart(opts: { axIds?: [number, number]; scatterStyle?: ScatterStyle; series?: ScatterSeries[]; varyColors?: boolean }): ScatterChart

Parameters

NameTypeDescription
opts { axIds?: [number, number]; scatterStyle?: ScatterStyle; series?: ScatterSeries[]; varyColors?: boolean }

Returns

ScatterChart

# makeScatterSeries function

src/chart/chart.ts:831
function makeScatterSeries(opts: { idx: number; marker?: Marker; order?: number; smooth?: boolean; tx?: { kind: "literal"; value: string } | { kind: "ref"; ref: string }; xVal?: NumericRef; yVal: NumericRef }): ScatterSeries

Parameters

NameTypeDescription
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:907
function makeStockChart(opts: { axIds?: [number, number]; hiLowLines?: boolean | HiLowLines; series?: BarSeries[]; upDownBars?: boolean | UpDownBars }): StockChart

Parameters

NameTypeDescription
opts { axIds?: [number, number]; hiLowLines?: boolean | HiLowLines; series?: BarSeries[]; upDownBars?: boolean | UpDownBars }

Returns

StockChart

# makeSurface3DChart function

src/chart/chart.ts:1023
function makeSurface3DChart(opts: { axIds?: [number, number, number]; series?: BarSeries[]; wireframe?: boolean }): Surface3DChart

Parameters

NameTypeDescription
opts { axIds?: [number, number, number]; series?: BarSeries[]; wireframe?: boolean }

Returns

Surface3DChart

# makeSurfaceChart function

src/chart/chart.ts:922
function makeSurfaceChart(opts: { axIds?: [number, number, number]; series?: BarSeries[]; wireframe?: boolean }): SurfaceChart

Parameters

NameTypeDescription
opts { axIds?: [number, number, number]; series?: BarSeries[]; wireframe?: boolean }

Returns

SurfaceChart

Chartex

src/chart/cx/chartex.ts

# makeBoxWhiskerChart function

src/chart/cx/chartex.ts:448
function makeBoxWhiskerChart(opts: { catRef?: string; meanLine?: boolean; meanMarker?: boolean; nonoutliers?: boolean; outliers?: boolean; quartileMethod?: "exclusive" | "inclusive"; valRef?: string }): CxChartSpace

Parameters

NameTypeDescription
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:264
function makeCxAxis(opts: { catScalingGapWidth?: number; hidden?: boolean; id: number; majorGridlines?: boolean; spPr?: ShapeProperties; title?: CxTitle; txPr?: TextBody; valScaling?: { max?: number; min?: number } }): CxAxis

Parameters

NameTypeDescription
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:284
function 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 }): CxChartSpace

Parameters

NameTypeDescription
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:236
function makeCxData(id: number, dims: CxDim[]): CxData

Parameters

NameTypeDescription
id number
dims CxDim[]

Returns

CxData

# makeCxNumDim function

src/chart/cx/chartex.ts:202
function makeCxNumDim(opts: { dir?: "col" | "row"; f?: string; formatCode?: string; ptCount?: number; pts?: CxPoint[]; type: string }): CxNumDim

Parameters

NameTypeDescription
opts { dir?: "col" | "row"; f?: string; formatCode?: string; ptCount?: number; pts?: CxPoint[]; type: string }

Returns

CxNumDim

# makeCxSeries function

src/chart/cx/chartex.ts:238
function 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 }): CxSeries

Parameters

NameTypeDescription
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:219
function makeCxStrDim(opts: { dir?: "col" | "row"; f?: string; formatCode?: string; ptCount?: number; pts?: CxPoint[]; type: string }): CxStrDim

Parameters

NameTypeDescription
opts { dir?: "col" | "row"; f?: string; formatCode?: string; ptCount?: number; pts?: CxPoint[]; type: string }

Returns

CxStrDim

# makeFunnelChart function

src/chart/cx/chartex.ts:437
function makeFunnelChart(opts: { catRef?: string; valRef?: string }): CxChartSpace

Parameters

NameTypeDescription
opts { catRef?: string; valRef?: string }

Returns

CxChartSpace

# makeHistogramChart function

src/chart/cx/chartex.ts:378
function makeHistogramChart(opts: { binCount?: number; binCountAuto?: boolean; binSize?: number; intervalClosed?: "l" | "r"; overflow?: number; underflow?: number; valRef?: string }): CxChartSpace

Parameters

NameTypeDescription
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:408
function makeParetoChart(opts: { binCount?: number; binCountAuto?: boolean; binSize?: number; catRef?: string; valRef?: string }): CxChartSpace

Parameters

NameTypeDescription
opts { binCount?: number; binCountAuto?: boolean; binSize?: number; catRef?: string; valRef?: string }

Returns

CxChartSpace

# makeRegionMapChart function

src/chart/cx/chartex.ts:482
function makeRegionMapChart(opts: { catRef?: string; cultureLanguage?: string; cultureRegion?: string; projectionType?: "automatic" | "mercator" | "miller" | "albers"; regionLabelLayout?: "none" | "bestFit" | "showAll"; valRef?: string }): CxChartSpace

Parameters

NameTypeDescription
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:323
function makeSunburstChart(opts: { catRef?: string; valFormatCode?: string; valRef?: string }): CxChartSpace

Parameters

NameTypeDescription
opts { catRef?: string; valFormatCode?: string; valRef?: string }

Returns

CxChartSpace

# makeTreemapChart function

src/chart/cx/chartex.ts:338
function makeTreemapChart(opts: { catRef?: string; parentLabelLayout?: "none" | "overlapping" | "banner"; valRef?: string }): CxChartSpace

Parameters

NameTypeDescription
opts { catRef?: string; parentLabelLayout?: "none" | "overlapping" | "banner"; valRef?: string }

Returns

CxChartSpace

# makeWaterfallChart function

src/chart/cx/chartex.ts:359
function makeWaterfallChart(opts: { catRef?: string; subtotalIdx?: number[]; valRef?: string }): CxChartSpace

Parameters

NameTypeDescription
opts { catRef?: string; subtotalIdx?: number[]; valRef?: string }

Returns

CxChartSpace

User shapes

src/chart/user-shapes.ts

# makeAbsSizeAnchor function

src/chart/user-shapes.ts:88
function makeAbsSizeAnchor(from: ChartRelativeMarker, ext: PositiveSize2D, content: UserShapeContent): UserShapeAnchor

Parameters

NameTypeDescription
from ChartRelativeMarker
ext PositiveSize2D
content UserShapeContent

Returns

UserShapeAnchor

# makeChartDrawing function

src/chart/user-shapes.ts:62
function makeChartDrawing(shapes?: UserShapeAnchor[]): ChartDrawing

Parameters

NameTypeDescription
shapes? = []UserShapeAnchor[]

Returns

ChartDrawing

# makeChartShape function

src/chart/user-shapes.ts:64
function makeChartShape(opts: { descr?: string; hidden?: boolean; id: number; name?: string; spPr?: ShapeProperties; txBody?: TextBody; txBox?: boolean }): ChartDrawingShape

Parameters

NameTypeDescription
opts { descr?: string; hidden?: boolean; id: number; name?: string; spPr?: ShapeProperties; txBody?: TextBody; txBox?: boolean }

Returns

ChartDrawingShape

# makeRelSizeAnchor function

src/chart/user-shapes.ts:82
function makeRelSizeAnchor(from: ChartRelativeMarker, to: ChartRelativeMarker, content: UserShapeContent): UserShapeAnchor

Parameters

NameTypeDescription
from ChartRelativeMarker
to ChartRelativeMarker
content UserShapeContent

Returns

UserShapeAnchor