Exact TypeScript Contract
This generated interface is the exact callable contract from
types/program.d.ts. Use the family reference pages for defaults, inference,
effects, and errors.
Exact TypeScript signatures
This generated block is the exact callable contract from types/program.d.ts.
The action entries below provide the readable form, behavior, defaults, and routes.
interface ChartProgramActions {
constructor(state?: ActionOptions); readonly semanticSpec: SemanticSpec; readonly graphicSpec: GraphicSpec; readonly resolvedScales: Readonly<Record<string, Readonly<Record<string, unknown>>>>; readonly materializationConfigs: Readonly<Record<string, unknown>>; readonly children: Readonly<Record<string, ChartProgram>>; readonly compositionSpec?: CompositionSpec; readonly context: Readonly<Record<string, unknown>>; readonly trace: TraceNode; readonly actionStack: readonly unknown[]; createCanvas(options?: CanvasOptions): ChartProgram;
editCanvas(options: CanvasOptions): ChartProgram;
createData(options: { id?: string; values: readonly unknown[] }): ChartProgram;
filterData(options: FilterDataOptions): ChartProgram;
filterMarks(options: FilterMarksOptions): ChartProgram;
selectMarks(options: SelectMarksOptions): ChartProgram;
highlightMarks(options: HighlightMarksOptions): ChartProgram;
createDensityData(options: DensityDataOptions): ChartProgram;
createRegressionData(options: RegressionDataOptions): ChartProgram;
createIntervalData(options: IntervalDataOptions): ChartProgram;
createWindowData(options: WindowDataOptions): ChartProgram;
createBin2DData(options: Bin2DDataOptions): ChartProgram;
createPointMark(options?: { id?: string; data?: string; shape?: PointShape; fill?: string; opacity?: number; stroke?: string; strokeWidth?: number; }): ChartProgram;
editPointMark(options: { target?: string; shape?: PointShape; fill?: string; opacity?: number; stroke?: string; strokeWidth?: number; }): ChartProgram;
jitterPoints(options: JitterPointsOptions): ChartProgram;
removeJitter(options?: RemoveJitterOptions): ChartProgram;
createLineMark(options?: { id?: string; data?: string; strokeWidth?: number; curve?: CurveInterpolation; stroke?: string; opacity?: number; closed?: boolean; }): ChartProgram;
editLineMark(options: { target?: string; strokeWidth?: number; curve?: CurveInterpolation; stroke?: string; opacity?: number; closed?: boolean; }): ChartProgram;
createBarMark(options?: { id?: string; data?: string; fill?: string; opacity?: number; stroke?: string; strokeWidth?: number; }): ChartProgram;
editBarMark(options: { target?: string; fill?: string; opacity?: number; stroke?: string | false; strokeWidth?: number; }): ChartProgram;
createAreaMark(options?: { id?: string; data?: string; fill?: string; opacity?: number; stroke?: string; strokeWidth?: number; curve?: CurveInterpolation; }): ChartProgram;
createArcMark(options?: { id?: string; data?: string; innerRadius?: number; padAngle?: number; fill?: string; opacity?: number; stroke?: string; strokeWidth?: number; }): ChartProgram;
editArcMark(options: { target?: string; innerRadius?: number; padAngle?: number; fill?: string; opacity?: number; stroke?: string; strokeWidth?: number; }): ChartProgram;
createRectMark(options?: RectMarkOptions): ChartProgram;
editRectMark(options: EditRectMarkOptions): ChartProgram;
createRuleMark(options?: { id?: string; data?: string }): ChartProgram;
createTextMark(options?: TextMarkOptions): ChartProgram;
editTextMark(options: EditTextMarkOptions): ChartProgram;
layoutLabels(options?: LabelLayoutOptions): ChartProgram;
removeLabelLayout(options?: RemoveLabelLayoutOptions): ChartProgram;
editAreaMark(options: { target?: string; fill?: string; opacity?: number; stroke?: string | false; strokeWidth?: number; curve?: CurveInterpolation; }): ChartProgram;
encodeX(options: PositionEncodingOptions | RulePositionEncodingOptions): ChartProgram;
encodeY(options: PositionEncodingOptions | RulePositionEncodingOptions): ChartProgram;
encodeTheta(options: ThetaEncodingOptions): ChartProgram;
encodeR(options: RadialEncodingOptions): ChartProgram;
encodeX2(options: SecondaryPositionEncodingOptions): ChartProgram;
encodeColor(options: ColorEncodingOptions): ChartProgram;
encodeStrokeDash(options: StrokeDashEncodingOptions): ChartProgram;
encodeSize(options: { field: string; target?: string; fieldType?: "quantitative"; scale?: ScaleOptions }): ChartProgram;
encodeShape(options: { field: string; target?: string; fieldType?: "nominal"; scale?: ScaleOptions }): ChartProgram;
encodeOpacity(options: OpacityEncodingOptions): ChartProgram;
encodeRadius(options: { value: number; target?: string }): ChartProgram;
encodePointRadius(options: { value: number; target?: string }): ChartProgram;
encodeXOffset(options: XOffsetEncodingOptions): ChartProgram;
encodeYOffset(options: YOffsetEncodingOptions): ChartProgram;
encodeY2(options: SecondaryPositionEncodingOptions): ChartProgram;
encodeYRange(options: { lower: string; upper: string; target?: string; fieldType?: "quantitative"; coordinate?: string; scale?: ScaleOptions; }): ChartProgram;
encodeXRange(options: { lower: string; upper: string; target?: string; fieldType?: "quantitative"; coordinate?: string; scale?: ScaleOptions; }): ChartProgram;
encodeGroup(options: { field: string; target?: string; fieldType?: "nominal" }): ChartProgram;
encodePathOrder(options: PathOrderEncodingOptions): ChartProgram;
encodeParallelCoordinates(options: ParallelCoordinatesEncodingOptions): ChartProgram;
removePathOrder(options?: RemovePathOrderOptions): ChartProgram;
encodeText(options: TextEncodingOptions): ChartProgram;
encodeHistogram(options: HistogramEncodingOptions): ChartProgram;
encodeDensity(options: DensityEncodingOptions): ChartProgram;
editDensity(options: EditDensityOptions): ChartProgram;
encodeHorizon(options?: HorizonEncodingOptions): ChartProgram;
editHorizon(options: EditHorizonOptions): ChartProgram;
encodeBarWidth(options?: BarWidthOptions): ChartProgram;
encodeStroke(options: { target?: string; value: string }): ChartProgram;
encodeStrokeWidth(options: StrokeWidthEncodingOptions): ChartProgram;
createRegression(options?: RegressionOptions): ChartProgram;
editRegression(options: EditRegressionOptions): ChartProgram;
createErrorBar(options?: ErrorBarOptions): ChartProgram;
editErrorBar(options: EditErrorBarOptions): ChartProgram;
createErrorBand(options?: ErrorBandOptions): ChartProgram;
editErrorBand(options: EditErrorBandOptions): ChartProgram;
editErrorBandBoundary(options: EditErrorBandBoundaryOptions): ChartProgram;
createBoxPlot(options?: BoxPlotOptions): ChartProgram;
editBoxPlot(options: EditBoxPlotOptions): ChartProgram;
createGradientPlot(options?: GradientPlotOptions): ChartProgram;
editGradientPlot(options: EditGradientPlotOptions): ChartProgram;
createViolinPlot(options: ViolinPlotOptions): ChartProgram;
createScatterPlot(options: CreateScatterPlotOptions): ChartProgram;
createLinePlot(options: CreateLinePlotOptions): ChartProgram;
createBarPlot(options: CreateBarPlotOptions): ChartProgram;
createHistogram(options: CreateHistogramOptions): ChartProgram;
createHeatmap(options: CreateHeatmapOptions): ChartProgram;
createParallelCoordinates(options: CreateParallelCoordinatesOptions): ChartProgram;
removeMark(options?: RemoveMarkOptions): ChartProgram;
createAxes(options?: CreateAxesOptions): ChartProgram;
createXAxis(options?: CompleteAxisOptions<XAxisPosition>): ChartProgram;
createYAxis(options?: CompleteAxisOptions<YAxisPosition>): ChartProgram;
createThetaAxis(options?: CompletePolarAxisOptions): ChartProgram;
createRadialAxis(options?: CompleteRadialAxisOptions): ChartProgram;
editThetaAxisLine(options?: AxisLineStyleOptions): ChartProgram;
editRadialAxisLine(options?: AxisLineStyleOptions): ChartProgram;
editThetaAxisTicks(options?: PolarTickOptions): ChartProgram;
editRadialAxisTicks(options?: PolarTickOptions): ChartProgram;
editThetaAxisLabels(options?: PolarLabelOptions): ChartProgram;
editRadialAxisLabels(options?: PolarLabelOptions): ChartProgram;
editThetaAxisTitle(options?: PolarTitleOptions): ChartProgram;
editRadialAxisTitle(options?: RadialTitleOptions): ChartProgram;
createXAxisLine(options?: AxisLineStyleOptions & { scale?: string; position?: XAxisPosition }): ChartProgram;
createYAxisLine(options?: AxisLineStyleOptions & { scale?: string; position?: YAxisPosition }): ChartProgram;
editXAxisLine(options?: AxisLineStyleOptions & { position?: XAxisPosition }): ChartProgram;
editYAxisLine(options?: AxisLineStyleOptions & { position?: YAxisPosition }): ChartProgram;
createXAxisTicks(options?: AxisTickOptions<XAxisPosition>): ChartProgram;
createYAxisTicks(options?: AxisTickOptions<YAxisPosition>): ChartProgram;
editXAxisTicks(options?: Omit<AxisTickOptions<XAxisPosition>, "scale">): ChartProgram;
editYAxisTicks(options?: Omit<AxisTickOptions<YAxisPosition>, "scale">): ChartProgram;
createXAxisLabels(options?: AxisLabelOptions<XAxisPosition>): ChartProgram;
createYAxisLabels(options?: AxisLabelOptions<YAxisPosition>): ChartProgram;
editXAxisLabels(options?: Omit<AxisLabelOptions<XAxisPosition>, "scale">): ChartProgram;
editYAxisLabels(options?: Omit<AxisLabelOptions<YAxisPosition>, "scale">): ChartProgram;
createXAxisTicksAndLabels(options?: AxisTicksAndLabelsOptions<XAxisPosition>): ChartProgram;
createYAxisTicksAndLabels(options?: AxisTicksAndLabelsOptions<YAxisPosition>): ChartProgram;
editXAxisTicksAndLabels(options: Omit<AxisTicksAndLabelsOptions<XAxisPosition>, "scale">): ChartProgram;
editYAxisTicksAndLabels(options: Omit<AxisTicksAndLabelsOptions<YAxisPosition>, "scale">): ChartProgram;
createXAxisTitle(options?: AxisTitleOptions<XAxisPosition>): ChartProgram;
createYAxisTitle(options?: AxisTitleOptions<YAxisPosition>): ChartProgram;
editXAxisTitle(options?: Omit<AxisTitleOptions<XAxisPosition>, "scale">): ChartProgram;
editYAxisTitle(options?: Omit<AxisTitleOptions<YAxisPosition>, "scale">): ChartProgram;
editXAxis(options: EditAxisOptions<XAxisPosition>): ChartProgram;
editYAxis(options: EditAxisOptions<YAxisPosition>): ChartProgram;
editThetaAxis(options: Omit<EditPolarAxisOptions, "angle">): ChartProgram;
editRadialAxis(options: EditRadialAxisOptions): ChartProgram;
removeXAxis(options?: RemoveAxisOptions): ChartProgram;
removeYAxis(options?: RemoveAxisOptions): ChartProgram;
removeThetaAxis(options?: RemoveAxisOptions): ChartProgram;
removeRadialAxis(options?: RemoveAxisOptions): ChartProgram;
createGrid(options?: CreateGridOptions): ChartProgram;
createHorizontalGrid(options?: GridDirectionOptions): ChartProgram;
createVerticalGrid(options?: GridDirectionOptions): ChartProgram;
createThetaGrid(options?: PolarGridOptions): ChartProgram;
createRadialGrid(options?: PolarGridOptions): ChartProgram;
editHorizontalGrid(options: EditGridOptions): ChartProgram;
editVerticalGrid(options: EditGridOptions): ChartProgram;
editThetaGrid(options: EditPolarGridOptions): ChartProgram;
editRadialGrid(options: EditPolarGridOptions): ChartProgram;
editGrid(options: EditGridDirectionsOptions): ChartProgram;
removeGrid(options?: RemoveGridOptions): ChartProgram;
createLegend(options?: LegendOptions): ChartProgram;
editLegend(options: EditLegendOptions): ChartProgram;
editLegendLayout(options: EditLegendLayoutOptions): ChartProgram;
editLegendLabels(options: EditLegendLabelsOptions): ChartProgram;
editLegendTitle(options: EditLegendTitleOptions): ChartProgram;
editLegendSymbols(options: EditLegendSymbolsOptions): ChartProgram;
editLegendBorder(options: EditLegendBorderOptions): ChartProgram;
removeLegend(options?: RemoveLegendOptions): ChartProgram;
createGuides(options?: CreateGuidesOptions): ChartProgram;
createTitle(options: TitleOptions): ChartProgram;
editTitle(options: EditTitleOptions): ChartProgram;
removeTitle(): ChartProgram;
createCoordinate(options?: CreateCoordinateOptions): ChartProgram;
createScale(options: CreateScaleOptions): ChartProgram;
editScale(options: EditScaleOptions): ChartProgram;
createDerivedData(options: CreateDerivedDataOptions): ChartProgram;
createRegressionBand(options: CreateRegressionBandOptions): ChartProgram;
editRegressionBand(options: { target?: string; color?: string; opacity?: number; stroke?: string | false; strokeWidth?: number; curve?: CurveInterpolation; }): ChartProgram;
createRegressionLine(options: CreateRegressionLineOptions): ChartProgram;
editRegressionLine(options: { target?: string; strokeWidth?: number; curve?: CurveInterpolation; }): ChartProgram;
editCompositionLayout(options: EditCompositionLayoutOptions): ChartProgram;
replaceCompositionChild(options: ReplaceCompositionChildOptions): ChartProgram;
facet(options: FacetOptions): ChartProgram;
editFacetHeaders(options: EditFacetHeadersOptions): ChartProgram;
editSemantic(options: EditSemanticOptions): ChartProgram;
createGraphics(options: { id: string; type: GraphicType; length?: number; parent?: string; before?: string; after?: string; }): ChartProgram;
editGraphics(options: EditGraphicsOptions): ChartProgram;
}