Skip to content
SumOfficeSumOfficeSumOffice
Menu
What SumOffice isProduct and deliveryAI and MCPContact us
Overview
SumSheet — what it isCapability map next to ExcelArchitecture: four layers and objectsWhat happens from open to saveStrengths and tradeoffs
Getting started
Installing SumSheetQuick start: your first project
Guides
How the API session worksRequests used in the exampleResponding to clicks and the context menuIntegrating into an applicationEmbedding kit: structure, events, menuSurface eventsDiagnosticsVerified script
Runtimes
The core in the browser through WebAssemblyA separate core process alongside your applicationSumSheet as a server-side processorPhone and tabletRuntime environments and the end-to-end scenario
Contract and boundaries
Readiness checklistFrom concept to pilotSumSheet version history
Examples
Live example: a budget spreadsheetSumSheet examplesMinimal sheetSheet with the ribbonEmbedding into a third-party pageA million rowsCrosshairRead-onlyCustom headersSheet without header stripsCustom menu itemCustom keyboard shortcutCustom languageDrop a workbook hereTwo people in one documentAssistants drive the sheetCustom eventHyperlinkFind and replaceNotesSheet outlinePage layoutAllow editing rangesWorkbook linksHeadless
Reference
SumSheet referenceSumSheet transport and message formatSumSheet session and conventionsWhat you can do with each formatSession and workbookCells and rangesSheetsPrinting and layoutFormulas and calculationFormattingData, filters, and objectsPivot tablesPower Query: M expressionsPower Query: connectorsPower Query: queries and stepsPower Query: tables from queriesPower Query: execution and progressPower Query: trust and privacyPower Query: external mashupsVBA and macrosProtection and reviewTypes: session, workbook, and sheetsTypes: cells and rangesTypes: formulas and calculationTypes: formattingTypes: data and sheet objectsTypes: pivot tablesTypes: charts and graphicsTypes: printing and page layoutTypes: Power QueryTypes: VBA and macrosTypes: protection and reviewTypes: general and utility

Types: charts and graphics

Compute Contract type definitions — charts, sparklines, shapes, and images. Names: 92.

Definitions of the names from the “TypeScript type” column on the operation pages.

Other dictionary topics: session, workbook, and sheets · cells and ranges · formulas and calculation · formatting · data and sheet objects · pivot tables · charts and graphics · printing and page layout · Power Query · VBA and macros · protection and review · general and utility.

Types on this page — 92

ContractChartAreaFormatting

Section titled “ContractChartAreaFormatting”
interface ContractChartAreaFormatting {
  style: ContractChartShapeStyle;
  layout?: ContractChartManualLayout | null;
}

ContractChartAxisFormatting

Section titled “ContractChartAxisFormatting”
interface ContractChartAxisFormatting {
  axis: ContractChartAxisId;
  title?: string | null;
  visible: boolean;
  minimum?: number | null;
  maximum?: number | null;
  majorUnit?: number | null;
  minorUnit?: number | null;
  numberFormat?: string | null;
  logBase?: number | null;
  showMajorGridlines: boolean;
  showMinorGridlines: boolean;
}

ContractChartAxisId

Section titled “ContractChartAxisId”
type ContractChartAxisId = | "primary-category" | "primary-value" | "secondary-category" | "secondary-value";

ContractChartBoundedFamily

Section titled “ContractChartBoundedFamily”
type ContractChartBoundedFamily =
  | "bubble"
  | "radar"
  | "radar-markers"
  | "radar-filled"
  | "surface"
  | "wireframe-surface"
  | "contour"
  | "wireframe-contour"
  | "stock-hlc"
  | "stock-ohlc"
  | "stock-volume-hlc"
  | "stock-volume-ohlc"
  | "histogram"
  | "pareto"
  | "waterfall"
  | "funnel"
  | "box-whisker"
  | "treemap"
  | "sunburst"
  | "map";

ContractChartBoxWhiskerSettings

Section titled “ContractChartBoxWhiskerSettings”
interface ContractChartBoxWhiskerSettings {
  quartileMethod: ContractChartQuartileMethod;
  showMeanLine: boolean;
  showMeanMarker: boolean;
  showInnerPoints: boolean;
  showOutlierPoints: boolean;
  readonly summaries: ReadonlyArray<{
    seriesIndex: number;
    firstQuartile: number;
    median: number;
    thirdQuartile: number;
    mean: number;
    whiskerMinimum: number;
    whiskerMaximum: number;
    outliers: number[];
  }>;
}

ContractChartBubblePointIdentity

Section titled “ContractChartBubblePointIdentity”
interface ContractChartBubblePointIdentity {
  pointIndex: number;
  size: number;
}

ContractChartCapabilityRefusal

Section titled “ContractChartCapabilityRefusal”
type ContractChartCapabilityRefusal =
  | "unsupported-chart-type"
  | "unsupported-series-type"
  | "unsupported-three-d"
  | "unsupported-stock"
  | "unsupported-surface"
  | "incompatible-combination";

ContractChartCustomErrorBarRange

Section titled “ContractChartCustomErrorBarRange”
interface ContractChartCustomErrorBarRange {
  formula: string;
  pointCount: number;
}

ContractChartDataLabelPosition

Section titled “ContractChartDataLabelPosition”
type ContractChartDataLabelPosition =
  | "best-fit"
  | "center"
  | "inside-end"
  | "inside-base"
  | "outside-end"
  | "left"
  | "right"
  | "above"
  | "below";

ContractChartDataLabelsFormatting

Section titled “ContractChartDataLabelsFormatting”
interface ContractChartDataLabelsFormatting {
  visible: boolean;
  showValue: boolean;
  showCategoryName: boolean;
  showSeriesName: boolean;
  showLegendKey: boolean;
  showPercentage: boolean;
  separator?: string | null;
  numberFormat?: string | null;
  position?: ContractChartDataLabelPosition | null;
  showLeaderLines: boolean;
}

ContractChartDataTableFormatting

Section titled “ContractChartDataTableFormatting”
interface ContractChartDataTableFormatting {
  visible: boolean;
  showLegendKeys: boolean;
  showHorizontalBorder: boolean;
  showVerticalBorder: boolean;
  showOutlineBorder: boolean;
  style: ContractChartShapeStyle;
}

ContractChartErrorBarDirection

Section titled “ContractChartErrorBarDirection”
type ContractChartErrorBarDirection = "x" | "y";

ContractChartErrorBarEndStyle

Section titled “ContractChartErrorBarEndStyle”
type ContractChartErrorBarEndStyle = "both" | "plus" | "minus";

ContractChartErrorBarKind

Section titled “ContractChartErrorBarKind”
type ContractChartErrorBarKind = "fixed" | "percentage" | "standard-deviation" | "standard-error" | "custom";

ContractChartErrorBarsFormatting

Section titled “ContractChartErrorBarsFormatting”
interface ContractChartErrorBarsFormatting {
  direction: ContractChartErrorBarDirection;
  kind: ContractChartErrorBarKind;
  endStyle: ContractChartErrorBarEndStyle;
  noEndCap: boolean;
  value?: number | null;
  plusRange?: ContractChartCustomErrorBarRange | null;
  minusRange?: ContractChartCustomErrorBarRange | null;
}

ContractChartFeatureCapability

Section titled “ContractChartFeatureCapability”
interface ContractChartFeatureCapability {
  supported: boolean;
  reason?: ContractChartCapabilityRefusal | null;
}

ContractChartFormatting

Section titled “ContractChartFormatting”
interface ContractChartFormatting {
  template?: ContractChartTemplateSelection | null;
  family?: ContractChartBoundedFamily | null;
  bubbleScale?: number | null;
  missingValuePolicy?: ContractChartMissingValuePolicy;
  modern?: ContractChartModernFormatting;
  surface?: ContractChartSurfaceFormatting | null;
  title?: string | null;
  legendPosition: ContractChartLegendFormatPosition;
  legendOverlay: boolean;
  dataLabels: ContractChartDataLabelsFormatting;
  dataTable?: ContractChartDataTableFormatting;


  readonly capabilities?: ContractChartFormattingCapabilities;
  chartArea: ContractChartAreaFormatting;
  plotArea: ContractChartAreaFormatting;
  axes: ContractChartAxisFormatting[];
  series: ContractChartSeriesFormatting[];
}

ContractChartFormattingCapabilities

Section titled “ContractChartFormattingCapabilities”
interface ContractChartFormattingCapabilities {
  combo?: ContractChartFeatureCapability;
  boundedFamilies?: ContractChartFeatureCapability;
  dataTable: ContractChartFeatureCapability;
  errorBars: ContractChartSeriesErrorBarCapability[];
}

ContractChartFunnelSettings

Section titled “ContractChartFunnelSettings”
interface ContractChartFunnelSettings {
  readonly points: ReadonlyArray<{ pointIndex: number; value: number }>;
}

ContractChartGeographyRegion

Section titled “ContractChartGeographyRegion”
interface ContractChartGeographyRegion {
  readonly inputLabel: string;
  readonly identity: "FRA" | "DEU" | "ITA" | "ESP" | "PRT" | "GBR";
  readonly value: number;
  readonly color: string;
}

ContractChartGeographySettings

Section titled “ContractChartGeographySettings”
interface ContractChartGeographySettings {
  readonly cultureLanguage?: string | null;
  readonly cultureRegion?: string | null;
  readonly attribution?: string | null;
  readonly minimum: number;
  readonly maximum: number;
  readonly regions: ReadonlyArray<ContractChartGeographyRegion>;
}

ContractChartHierarchyBlankPolicy

Section titled “ContractChartHierarchyBlankPolicy”
type ContractChartHierarchyBlankPolicy = "zero";

ContractChartHierarchyErrorPolicy

Section titled “ContractChartHierarchyErrorPolicy”
type ContractChartHierarchyErrorPolicy = "refuse";

ContractChartHierarchyNode

Section titled “ContractChartHierarchyNode”
interface ContractChartHierarchyNode {
  readonly nodeId: string;
  readonly parentId?: string | null;
  readonly level: number;
  readonly label: string;
  readonly aggregate: number;
  readonly leafCount: number;
  readonly color: string;
}

ContractChartHierarchySettings

Section titled “ContractChartHierarchySettings”
interface ContractChartHierarchySettings {
  readonly blankPolicy: ContractChartHierarchyBlankPolicy;
  readonly errorPolicy: ContractChartHierarchyErrorPolicy;
  readonly rootAggregate: number;
  readonly nodes: ReadonlyArray<ContractChartHierarchyNode>;
}

ContractChartHistogramBin

Section titled “ContractChartHistogramBin”
interface ContractChartHistogramBin {
  readonly binIndex: number;
  readonly lowerBound: number;
  readonly upperBound: number;
  readonly count: number;
  readonly cumulativePercent: number;
}

ContractChartHistogramSettings

Section titled “ContractChartHistogramSettings”
interface ContractChartHistogramSettings {
  binCount?: number | null;
  binWidth?: number | null;
  underflow?: number | null;
  overflow?: number | null;
  intervalClosed: ContractChartIntervalClosedSide;
  readonly bins: ContractChartHistogramBin[];
}

ContractChartIntervalClosedSide

Section titled “ContractChartIntervalClosedSide”
type ContractChartIntervalClosedSide = "left" | "right";

ContractChartLegendFormatPosition

Section titled “ContractChartLegendFormatPosition”
type ContractChartLegendFormatPosition = "none" | "top" | "bottom" | "left" | "right";

ContractChartLegendPosition

Section titled “ContractChartLegendPosition”
type ContractChartLegendPosition = "top" | "left" | "right" | "bottom" | "none";

ContractChartLineDash

Section titled “ContractChartLineDash”
type ContractChartLineDash = "solid" | "dash" | "dot" | "dash-dot";

ContractChartManualLayout

Section titled “ContractChartManualLayout”
interface ContractChartManualLayout {
  x: number;
  y: number;
  width: number;
  height: number;
}

ContractChartMarkerFormatting

Section titled “ContractChartMarkerFormatting”
interface ContractChartMarkerFormatting {
  style: ContractChartMarkerStyle;
  size: number;
  fillColor?: string | null;
  lineColor?: string | null;


  fillThemeSlot?: number | null;
  lineThemeSlot?: number | null;
}

ContractChartMarkerStyle

Section titled “ContractChartMarkerStyle”
type ContractChartMarkerStyle = "none" | "circle" | "square" | "diamond" | "triangle" | "x" | "plus";

ContractChartMissingValuePolicy

Section titled “ContractChartMissingValuePolicy”
type ContractChartMissingValuePolicy = "gap" | "zero" | "connect";

ContractChartModernFormatting

Section titled “ContractChartModernFormatting”
interface ContractChartModernFormatting {
  histogram?: ContractChartHistogramSettings | null;
  waterfall?: ContractChartWaterfallSettings | null;
  funnel?: ContractChartFunnelSettings | null;
  boxWhisker?: ContractChartBoxWhiskerSettings | null;
  hierarchy?: ContractChartHierarchySettings | null;
  geography?: ContractChartGeographySettings | null;
  readonly seriesIdentities: ReadonlyArray<{
    seriesIndex: number;
    uniqueId: string;
  }>;
}

ContractChartPayload

Section titled “ContractChartPayload”
interface ContractChartPayload {
  status: ContractChartStatus;
  chartType?: ContractChartType | null;
  stackMode?: ContractChartStackMode | null;
  title?: string | null;
  categoryAxisTitle?: string | null;
  valueAxisTitle?: string | null;
  stylePreset?: ContractChartStylePreset | null;


  chartStyleGalleryId?: string | null;


  chartColorPaletteId?: string | null;
  legendPosition?: ContractChartLegendPosition | null;
  chartAreaFillColor?: string | null;
  chartAreaLineColor?: string | null;
  plotAreaFillColor?: string | null;
  plotAreaLineColor?: string | null;
  seriesFillColor?: string | null;
  firstDataPointFillColor?: string | null;
  showDataLabels?: boolean | null;
  dataLabelNumberFormat?: string | null;
  valueAxisLineColor?: string | null;
  valueAxisMinimum?: number | null;
  valueAxisMaximum?: number | null;
  valueAxisNumberFormat?: string | null;
  showGridlines?: boolean | null;
  showAxes?: boolean | null;
  showTrendline?: boolean | null;
  showErrorBars?: boolean | null;
  showSecondaryAxis?: boolean | null;
  emptyCellBehavior?: "gaps" | "zero" | "connect" | null;
  pivotSourceName?: string | null;


  pivotLayoutBounds?: ContractSheetObjectBounds | null;


  formatting?: ContractChartFormatting | null;
  series: ContractChartSeries[];
}

ContractChartPointFormatting

Section titled “ContractChartPointFormatting”
interface ContractChartPointFormatting {
  pointIndex: number;
  style: ContractChartShapeStyle;
  marker?: ContractChartMarkerFormatting | null;
}

ContractChartQuartileMethod

Section titled “ContractChartQuartileMethod”
type ContractChartQuartileMethod = "inclusive" | "exclusive";

ContractChartSeries

Section titled “ContractChartSeries”
interface ContractChartSeries {
  name?: string | null;
  nameRef?: string | null;
  categoryRef?: string | null;
  valueRef?: string | null;
  categories: string[];


  categoryHierarchy?: string[][];
  values: number[];
}

ContractChartSeriesErrorBarCapability

Section titled “ContractChartSeriesErrorBarCapability”
interface ContractChartSeriesErrorBarCapability {
  seriesIndex: number;
  directions: ContractChartErrorBarDirection[];
  kinds: ContractChartErrorBarKind[];
  reason?: ContractChartCapabilityRefusal | null;
}

ContractChartSeriesFormatting

Section titled “ContractChartSeriesFormatting”
interface ContractChartSeriesFormatting {
  seriesIndex: number;
  chartType?: ContractChartSeriesType | null;
  secondaryAxis: boolean;
  stockRole?: ContractChartStockSeriesRole | null;
  xRange?: string | null;
  yRange?: string | null;
  bubbleSizeRange?: string | null;
  categoryRange?: string | null;
  valueRange?: string | null;


  readonly bubblePoints?: ContractChartBubblePointIdentity[];
  style: ContractChartShapeStyle;
  marker?: ContractChartMarkerFormatting | null;
  pointOverrides: ContractChartPointFormatting[];
  trendlines: ContractChartTrendlineFormatting[];
  errorBars: ContractChartErrorBarsFormatting[];
}

ContractChartSeriesType

Section titled “ContractChartSeriesType”
type ContractChartSeriesType = "clustered-column" | "line" | "area";

ContractChartShapeStyle

Section titled “ContractChartShapeStyle”
interface ContractChartShapeStyle {
  fillColor?: string | null;
  lineColor?: string | null;
  lineWidthPt?: number | null;
  lineDash?: ContractChartLineDash | null;


  fillThemeSlot?: number | null;
  lineThemeSlot?: number | null;
}

ContractChartSheetOrientation

Section titled “ContractChartSheetOrientation”
type ContractChartSheetOrientation = "portrait" | "landscape";

ContractChartSheetPageMargins

Section titled “ContractChartSheetPageMargins”
interface ContractChartSheetPageMargins {
  left: number;
  right: number;
  top: number;
  bottom: number;
  header: number;
  footer: number;
}

ContractChartSheetPrintPreview

Section titled “ContractChartSheetPrintPreview”
interface ContractChartSheetPrintPreview {
  sheetKey: string;
  pageCount: number;
  pageWidthPoints: number;
  pageHeightPoints: number;
  contentWidthPoints: number;
  contentHeightPoints: number;
  scale: number;
  orientation: ContractChartSheetOrientation;
  printArea: boolean;
}

ContractChartSheetPrintSettings

Section titled “ContractChartSheetPrintSettings”
interface ContractChartSheetPrintSettings {
  paperSize: number;
  orientation: ContractChartSheetOrientation;
  scale: number;
  margins: ContractChartSheetPageMargins;
  oddHeader?: string | null;
  oddFooter?: string | null;
  printArea: boolean;
}

ContractChartStackMode

Section titled “ContractChartStackMode”
type ContractChartStackMode = "none" | "stacked" | "percentStacked";

ContractChartStatus

Section titled “ContractChartStatus”
type ContractChartStatus = | "live-readonly" | "unsupported-chart-type" | "missing-cache" | "invalid-payload";

ContractChartStockSeriesRole

Section titled “ContractChartStockSeriesRole”
type ContractChartStockSeriesRole = "volume" | "open" | "high" | "low" | "close";

ContractChartStylePreset

Section titled “ContractChartStylePreset”
type ContractChartStylePreset = "default" | "muted" | "monochrome" | "colorful" | "clean";

ContractChartSurfaceFormatting

Section titled “ContractChartSurfaceFormatting”
interface ContractChartSurfaceFormatting {
  view3D: ContractChartSurfaceView3D;
  backWall: ContractChartShapeStyle;
  sideWall: ContractChartShapeStyle;
  floor: ContractChartShapeStyle;
}

ContractChartSurfaceView3D

Section titled “ContractChartSurfaceView3D”
interface ContractChartSurfaceView3D {
  rotation: number;
  elevation: number;
  perspective: number;
}

ContractChartTemplateSelection

Section titled “ContractChartTemplateSelection”
interface ContractChartTemplateSelection {
  templateId: string;
  source: ContractChartTemplateSource;
  chartStyleId: number;
  colorStyleId: number;
  theme: ContractChartThemeReference;
}

ContractChartTemplateSource

Section titled “ContractChartTemplateSource”
type ContractChartTemplateSource = "built-in" | "crtx";

ContractChartThemeColorSlot

Section titled “ContractChartThemeColorSlot”
type ContractChartThemeColorSlot =
  | "dark1"
  | "light1"
  | "dark2"
  | "light2"
  | "accent1"
  | "accent2"
  | "accent3"
  | "accent4"
  | "accent5"
  | "accent6"
  | "hyperlink"
  | "followed-hyperlink";

ContractChartThemeReference

Section titled “ContractChartThemeReference”
interface ContractChartThemeReference {
  themeId: string;
  colorSlot: ContractChartThemeColorSlot;
}

ContractChartTrendlineFacts

Section titled “ContractChartTrendlineFacts”
interface ContractChartTrendlineFacts {
  equation?: string | null;
  rSquared?: number | null;
  coefficients: number[];
  movingAveragePoints: ContractChartTrendlinePoint[];
  sourcePointCount: number;
}

ContractChartTrendlineFormatting

Section titled “ContractChartTrendlineFormatting”
interface ContractChartTrendlineFormatting {
  trendlineIndex: number;
  kind: ContractChartTrendlineKind;
  name?: string | null;
  polynomialOrder?: number | null;
  movingAveragePeriod?: number | null;
  displayEquation: boolean;
  displayRSquared: boolean;


  readonly facts?: ContractChartTrendlineFacts | null;
}

ContractChartTrendlineKind

Section titled “ContractChartTrendlineKind”
type ContractChartTrendlineKind = "linear" | "exponential" | "logarithmic" | "polynomial" | "moving-average";

ContractChartTrendlinePoint

Section titled “ContractChartTrendlinePoint”
interface ContractChartTrendlinePoint {
  x: number;
  y: number;
}

ContractChartType

Section titled “ContractChartType”
type ContractChartType =
  | "column"
  | "bar"
  | "line"
  | "area"
  | "pie"
  | "doughnut"
  | "scatter"
  | "combo"
  | "radar"
  | "map"
  | "waterfall"
  | "funnel"
  | "histogram"
  | "bubble"
  | "pareto"
  | "treemap"
  | "sunburst"
  | "stock"
  | "boxwhisker"
  | "scatter-smooth"
  | "scatter-smooth-line"
  | "scatter-straight"
  | "scatter-straight-line"
  | "radar-markers"
  | "radar-filled"
  | "surface"
  | "area-column"
  | "stock-hlc"
  | "stacked-column"
  | "percent-stacked-column"
  | "stacked-bar"
  | "percent-stacked-bar"
  | "stacked-line"
  | "percent-stacked-line"
  | "stacked-area"
  | "percent-stacked-area";

ContractChartWaterfallPoint

Section titled “ContractChartWaterfallPoint”
interface ContractChartWaterfallPoint {
  readonly pointIndex: number;
  readonly value: number;
  readonly runningTotal: number;
  readonly isTotal: boolean;
}

ContractChartWaterfallSettings

Section titled “ContractChartWaterfallSettings”
interface ContractChartWaterfallSettings {
  totalPointIndices: number[];
  showConnectorLines: boolean;
  readonly points: ContractChartWaterfallPoint[];
}

ContractDataAnalysisChartPlan

Section titled “ContractDataAnalysisChartPlan”
interface ContractDataAnalysisChartPlan {
  available: boolean;
  lifecycle: "create" | "remove";
  chartType: "column" | "line";
  title: string;
  categoryRange: CellRange;
  valueRange: CellRange;
}

ContractDrawingObjectAction

Section titled “ContractDrawingObjectAction”
type ContractDrawingObjectAction =
  | { kind: "replace-text-paragraphs";
    sheetId: string;
    objectStableId: string;
    text: string;
    paragraphs: ContractTextParagraph[];
  }
  | { kind: "create"; sheetId: string; creation: ContractOpenDocumentObjectCreation; }
  | { kind: "command"; sheetId: string; objectStableIds: string[]; primaryStableId?: string
  | null; command: ContractObjectSelectionPaneCommand; geometryAnchor?: ContractObjectAnchor
  | null; groupId?: string
  | null; orderedStableIds?: string[]; memberStableIds?: string[]; };

ContractDrawingObjectImageCrop

Section titled “ContractDrawingObjectImageCrop”
interface ContractDrawingObjectImageCrop {
  leftPct: number;
  topPct: number;
  rightPct: number;
  bottomPct: number;
}

ContractDrawingTextEditSemantics

Section titled “ContractDrawingTextEditSemantics”
interface ContractDrawingTextEditSemantics {
  sheetId: string;
  objectId: string;
  text: string;
  paragraphs: ContractTextParagraph[];
  verticalAlign?: ContractTextVerticalAlign | null;
  wrapText?: boolean | null;
  rotationDegrees?: number | null;
  marginsCm: [number | null, number | null, number | null, number | null];
}

ContractImagePayload

Section titled “ContractImagePayload”
interface ContractImagePayload {
  mimeType: string;
  dataUrl: string;
  widthPx?: number | null;
  heightPx?: number | null;
  byteCount?: number | null;
  editingStatus?:
    "live-supported" | "unsupported" | "malformed" | "oversized" | null;
  editingError?: string | null;


  svgText?: string | null;


  svgTextOriginal?: string | null;
}

ContractOpenDocumentChartSeries

Section titled “ContractOpenDocumentChartSeries”
interface ContractOpenDocumentChartSeries {
  name: string;
  categoryFormula: string;
  valueFormula: string;
  categoryCache: string[];
  valueCache: number[];
}

ContractSparklineAction

Section titled “ContractSparklineAction”
type ContractSparklineAction =
  | { kind: "inventory" }
  | { kind: "create";
    sheetPath: string;
    sourceRange: CellRange;
    targetRow: number;
    targetCol: number;
    sparklineType: ContractSparklineType;
    style: ContractSparklineStyle;
    flags?: ContractSparklineFlags;
    seriesColor?: string;
    negativeColor?: string;
  }
  | { kind: "createGroup";
    sheetPath: string;
    sparklineType: ContractSparklineType;
    style: ContractSparklineStyle;
    flags?: ContractSparklineFlags;
    seriesColor?: string;
    negativeColor?: string;
      members: Array<{ sourceRange: CellRange;
      targetRow: number;
    targetCol: number }>;
  }
  | { kind: "modify"; stableId: string; sourceRange?: CellRange
  | null; sparklineType?: ContractSparklineType
  | null; style?: ContractSparklineStyle
  | null; flags?: ContractSparklineFlags
  | null; seriesColor?: string; negativeColor?: string; }
  | { kind: "delete"; stableId: string };

ContractSparklineFlags

Section titled “ContractSparklineFlags”
interface ContractSparklineFlags {
  showMarkers?: boolean;
  showAxis?: boolean;
  showHighPoint?: boolean;
  showLowPoint?: boolean;
  showFirstPoint?: boolean;
  showLastPoint?: boolean;
  showNegativePoints?: boolean;
}

ContractSparklinePlanMode

Section titled “ContractSparklinePlanMode”
type ContractSparklinePlanMode = "inventory" | "preview" | "apply";

ContractSparklineProjectionEntry

Section titled “ContractSparklineProjectionEntry”
interface ContractSparklineProjectionEntry {
  stableId: string;
  sheetPath: string;
  sourceRef: string;
  targetRef: string;
  targetRow: number;
  targetCol: number;
  sparklineType: ContractSparklineType;
  style: ContractSparklineStyle;
  flags: Required<ContractSparklineFlags>;


  renderText: string;


  values: Array<number | null>;


  seriesColor?: string;
  negativeColor?: string;


  groupId?: string;
}

ContractSparklineStyle

Section titled “ContractSparklineStyle”
type ContractSparklineStyle = "default" | "accent" | "calm";

ContractSparklineType

Section titled “ContractSparklineType”
type ContractSparklineType = "line" | "column" | "winLoss";

ContractXlsxChartCreationPatch

Section titled “ContractXlsxChartCreationPatch”
interface ContractXlsxChartCreationPatch {
  activeSheetPath: string;
  sheetName: string;
  objectId?: string | null;
  objectName?: string | null;
  zOrder?: number | null;
  chartType: ContractChartType;
  stackMode?: ContractChartStackMode | null;
  title?: string | null;
  categoryAxisTitle?: string | null;
  valueAxisTitle?: string | null;
  stylePreset?: ContractChartStylePreset | null;


  chartStyleGalleryId?: string | null;


  chartColorPaletteId?: string | null;
  legendPosition?: ContractChartLegendPosition | null;
  chartAreaFillColor?: string | null;
  chartAreaLineColor?: string | null;
  plotAreaFillColor?: string | null;
  plotAreaLineColor?: string | null;
  seriesFillColor?: string | null;
  firstDataPointFillColor?: string | null;
  showDataLabels?: boolean | null;
  dataLabelNumberFormat?: string | null;
  valueAxisLineColor?: string | null;
  valueAxisMinimum?: number | null;
  valueAxisMaximum?: number | null;
  valueAxisNumberFormat?: string | null;
  showGridlines?: boolean | null;
  showAxes?: boolean | null;
  showTrendline?: boolean | null;
  showErrorBars?: boolean | null;
  showSecondaryAxis?: boolean | null;
  emptyCellBehavior?: "gaps" | "zero" | "connect" | null;
  pivotSourceName?: string | null;
  from: ContractObjectAnchorCell;
  to: ContractObjectAnchorCell;
  series: ContractChartSeries[];
}

ContractXlsxChartMutationPatch

Section titled “ContractXlsxChartMutationPatch”
interface ContractXlsxChartMutationPatch {
  activeSheetPath: string;
  objectId: string;
  relId: string;
  chartType: ContractChartType;
  stackMode?: ContractChartStackMode | null;
  title?: string | null;
  categoryAxisTitle?: string | null;
  valueAxisTitle?: string | null;
  stylePreset?: ContractChartStylePreset | null;


  chartStyleGalleryId?: string | null;


  chartColorPaletteId?: string | null;
  legendPosition?: ContractChartLegendPosition | null;
  showDataLabels?: boolean | null;
  dataLabelNumberFormat?: string | null;
  valueAxisMinimum?: number | null;
  valueAxisMaximum?: number | null;
  valueAxisNumberFormat?: string | null;
  showGridlines?: boolean | null;
  showAxes?: boolean | null;
  showSecondaryAxis?: boolean | null;
  emptyCellBehavior?: "gaps" | "zero" | "connect" | null;


  refreshCaches?: boolean | null;
  series: ContractChartSeries[];
}

ContractXlsxChartObjectMovePatch

Section titled “ContractXlsxChartObjectMovePatch”
interface ContractXlsxChartObjectMovePatch {
  activeSheetPath: string;
  objectId: string;
  relId: string;
  from: ContractObjectAnchorCell;
  ext: ContractObjectExtent;
}

ContractXlsxChartSeriesUpdatePatch

Section titled “ContractXlsxChartSeriesUpdatePatch”
interface ContractXlsxChartSeriesUpdatePatch {
  activeSheetPath: string;
  objectId: string;
  relId: string;
  seriesIndex: number;
  nameRef?: string | null;
  nameLiteral?: string | null;
  categoryAxisTitle?: string | null;
  valueAxisTitle?: string | null;
  categoryRef: string;
  valueRef: string;
  categories?: string[] | null;
  values?: number[] | null;
}

ContractXlsxDrawingImageCreationPatch

Section titled “ContractXlsxDrawingImageCreationPatch”
interface ContractXlsxDrawingImageCreationPatch {
  activeSheetPath: string;
  sheetName: string;
  objectId: string;
  objectName?: string | null;
  mimeType: "image/png" | "image/jpeg";
  dataUrl: string;
  from: ContractObjectAnchorCell;
  ext: ContractObjectExtent;
  altText?: string | null;
  linkedSourceRange?: string | null;


  svgText?: string | null;
}

ContractXlsxDrawingObjectDeletionPatch

Section titled “ContractXlsxDrawingObjectDeletionPatch”
interface ContractXlsxDrawingObjectDeletionPatch {
  activeSheetPath: string;
  objectId: string;
  objectFamily: "chart" | "image";
  relId: string;
}

ContractXlsxDrawingObjectGroupMemberPatch

Section titled “ContractXlsxDrawingObjectGroupMemberPatch”
interface ContractXlsxDrawingObjectGroupMemberPatch {
  objectId: string;
  objectFamily: "chart" | "image";
  relId: string;
}

ContractXlsxDrawingObjectGroupPatch

Section titled “ContractXlsxDrawingObjectGroupPatch”
interface ContractXlsxDrawingObjectGroupPatch {
  activeSheetPath: string;
  groupId: string;
  groupName?: string | null;
  members: ContractXlsxDrawingObjectGroupMemberPatch[];
}

ContractXlsxDrawingObjectImageTransformPatch

Section titled “ContractXlsxDrawingObjectImageTransformPatch”
interface ContractXlsxDrawingObjectImageTransformPatch {
  activeSheetPath: string;
  objectId: string;
  objectFamily: "image";
  relId: string;
  rotationDeg?: number | null;
  imageCrop?: ContractDrawingObjectImageCrop | null;
  flipH?: boolean | null;
  flipV?: boolean | null;
  hidden?: boolean | null;
}

ContractXlsxDrawingObjectMetadataPatch

Section titled “ContractXlsxDrawingObjectMetadataPatch”
interface ContractXlsxDrawingObjectMetadataPatch {
  activeSheetPath: string;
  objectId: string;
  objectFamily: "chart" | "image";
  relId: string;
  objectName?: string | null;
  altText?: string | null;
  title?: string | null;
  description?: string | null;
  decorative?: boolean | null;
  hidden?: boolean | null;
  printObject?: boolean | null;
  locksWithSheet?: boolean | null;
}

ContractXlsxDrawingObjectMovePatch

Section titled “ContractXlsxDrawingObjectMovePatch”
interface ContractXlsxDrawingObjectMovePatch {
  activeSheetPath: string;
  objectId: string;
  objectFamily: "chart" | "image";
  relId: string;
  from: ContractObjectAnchorCell;
  ext: ContractObjectExtent;
}

ContractXlsxDrawingObjectUngroupPatch

Section titled “ContractXlsxDrawingObjectUngroupPatch”
interface ContractXlsxDrawingObjectUngroupPatch {
  activeSheetPath: string;
  groupId: string;
}

ContractXlsxDrawingObjectZOrderPatch

Section titled “ContractXlsxDrawingObjectZOrderPatch”
interface ContractXlsxDrawingObjectZOrderPatch {
  activeSheetPath: string;
  objectId: string;
  objectFamily: "chart" | "image";
  relId: string;
  action: "forward" | "backward" | "front" | "back";
}

ContractXlsxShapeObjectPatch

Section titled “ContractXlsxShapeObjectPatch”
interface ContractXlsxShapeObjectPatch {
  objectId: string;
  objectName?: string | null;
  altText?: string | null;
  hidden?: boolean | null;
  prst: string;


  savePrst?: string | null;
  from: ContractObjectAnchorCell;


  to?: ContractObjectAnchorCell | null;
  ext: ContractObjectExtent;
  zOrder?: number | null;
  fillHex?: string | null;


  fillOpacity?: number | null;
  gradientFill?: boolean | null;
  gradientAngle?: number | null;
  gradientColor1?: string | null;
  gradientColor2?: string | null;
  lineHex?: string | null;


  strokeOnly?: boolean | null;
  lineWidthEmu?: number | null;


  rotationDegrees?: number | null;


  textRotationDegrees?: number | null;


  adj?: number | null;


  isLine?: boolean | null;
  flipH?: boolean | null;
  flipV?: boolean | null;
  headEnd?: string | null;
  tailEnd?: string | null;


  shadowPreset?: string | null;
  shadowColor?: string | null;
  shadowOpacity?: number | null;
  shadowBlur?: number | null;
  shadowAngle?: number | null;
  shadowDist?: number | null;
  glowColor?: string | null;
  glowSize?: number | null;
  glowOpacity?: number | null;
  softEdges?: number | null;
  reflectionOpacity?: number | null;
  reflectionBlur?: number | null;
  reflectionDistance?: number | null;
  reflectionSize?: number | null;


  textOutlineHex?: string | null;
  textFillType?: string | null;
  textFillOpacity?: number | null;
  textOutlineType?: string | null;
  textOutlineOpacity?: number | null;
  textOutlineWidth?: number | null;
  textShadow?: boolean | null;
  textShadowColor?: string | null;
  textShadowOpacity?: number | null;
  textShadowBlur?: number | null;
  textShadowAngle?: number | null;
  textShadowDist?: number | null;
  textGlowColor?: string | null;
  textGlowSize?: number | null;
  textGlowOpacity?: number | null;
  textSoftEdges?: number | null;


  bevelTopPreset?: string | null;
  bevelTopWidth?: number | null;
  bevelTopHeight?: number | null;
  bevelBottomPreset?: string | null;
  bevelBottomWidth?: number | null;
  bevelBottomHeight?: number | null;
  depthColor?: string | null;
  depth?: number | null;
  contourColor?: string | null;
  contourWidth?: number | null;
  material?: string | null;
  lightingRig?: string | null;
  lightingAngle?: number | null;
  cameraPreset?: string | null;
  rotationX?: number | null;
  rotationY?: number | null;
  rotationZ?: number | null;
  perspective?: number | null;
  wrapText?: boolean | null;
  overflowText?: boolean | null;
  autofit?: string | null;
  textDirection?: string | null;
  textMarginLeft?: number | null;
  textMarginRight?: number | null;
  textMarginTop?: number | null;
  textMarginBottom?: number | null;


  underline?: boolean | null;


  stCxnObjectId?: string | null;
  stCxnIdx?: number | null;
  endCxnObjectId?: string | null;
  endCxnIdx?: number | null;


  nativeNvId?: number | null;


  text?: string | null;
  paragraphs?: ContractTextParagraph[] | null;
  fontFamily?: string | null;
  fontSize?: number | null;
  bold?: boolean | null;
  italic?: boolean | null;
  textColor?: string | null;
  horizontalAlign?: ContractTextHorizontalAlign | null;
  verticalAlign?: ContractTextVerticalAlign | null;


  freeformPoints?: ReadonlyArray<{
    x: number;
    y: number;
    c1x?: number | null;
    c1y?: number | null;
    c2x?: number | null;
    c2y?: number | null;
  }> | null;
  isClosed?: boolean | null;


  rawAnchorXml?: string | null;


  geometryEdited?: boolean | null;


  adjustments?: ReadonlyArray<{ name: string; val: number }> | null;


  strokeDash?: string | null;
}

ContractXlsxShapeSheetPatch

Section titled “ContractXlsxShapeSheetPatch”
interface ContractXlsxShapeSheetPatch {
  activeSheetPath: string;
  objects: ContractXlsxShapeObjectPatch[];
}

Documentation assistant

Answers are assembled from the documentation and may be inaccurate — check the sources.