Types: printing and page layout

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 — 26

• ContractPageBreakAreaBounds
• ContractPageBreakAreaProjection
• ContractPageBreakKind
• ContractPageBreakLine
• ContractPageBreakPageSetup
• ContractRemoveDuplicatesHeaderPolicy
• ContractWorksheetPageAxisRange
• ContractWorksheetPageBreakAxis
• ContractWorksheetPageBreakIntent
• ContractWorksheetPageMargins
• ContractWorksheetPageOrder
• ContractWorksheetPageOrientation
• ContractWorksheetPageScaleMode
• ContractWorksheetPageSetup
• ContractWorksheetPrintArea
• ContractXlsxPrintAreaClearPatch
• ContractXlsxPrintAreaPatch
• ContractXlsxPrintTitlesClearPatch
• ContractXlsxPrintTitlesPatch
• ContractXlsxWorksheetHeaderFooterClearPatch
• ContractXlsxWorksheetHeaderFooterPatch
• ContractXlsxWorksheetPageBreakPatch
• ContractXlsxWorksheetPageBreakResetPatch
• ContractXlsxWorksheetPageSetupPatch
• ContractXlsxWorksheetPrintOptionsPatch
• SortRangeRowsHeaderMode

ContractPageBreakAreaBounds

interface ContractPageBreakAreaBounds {
  rowStart: number;
  rowEnd: number;
  colStart: number;
  colEnd: number;
}

ContractPageBreakAreaProjection

interface ContractPageBreakAreaProjection {
  bounds: ContractPageBreakAreaBounds;
  rowBreaks: ContractPageBreakLine[];
  colBreaks: ContractPageBreakLine[];
  pagesAcross: number;
  pagesDown: number;
  pageCount: number;
}

ContractPageBreakKind

type ContractPageBreakKind = "manual" | "automatic";

ContractPageBreakLine

interface ContractPageBreakLine {

  position: number;
  kind: ContractPageBreakKind;
}

ContractPageBreakPageSetup

interface ContractPageBreakPageSetup {
  paperSize: number;
  orientationLandscape: boolean;

  scale: number;
  marginLeftIn: number;
  marginRightIn: number;
  marginTopIn: number;
  marginBottomIn: number;
}

ContractRemoveDuplicatesHeaderPolicy

type ContractRemoveDuplicatesHeaderPolicy = "auto" | "present" | "absent";

ContractWorksheetPageAxisRange

interface ContractWorksheetPageAxisRange {
  start: number;
  end: number;
}

ContractWorksheetPageBreakAxis

type ContractWorksheetPageBreakAxis = "row" | "column";

ContractWorksheetPageBreakIntent

type ContractWorksheetPageBreakIntent =
  | { action: "insert-at-cell"; rowPosition?: number
  | null; colPosition?: number
  | null; }
  | { action: "remove-at-cell"; rowPosition?: number
  | null; colPosition?: number
  | null; }
  | { action: "insert"; axis: ContractWorksheetPageBreakAxis; position: number }
  | { action: "remove"; axis: ContractWorksheetPageBreakAxis; position: number }
  | { action: "move"; axis: ContractWorksheetPageBreakAxis; fromPosition: number; toPosition: number; }
  | { action: "reset-all" };

ContractWorksheetPageMargins

interface ContractWorksheetPageMargins {
  left: number;
  right: number;
  top: number;
  bottom: number;
  header: number;
  footer: number;
}

ContractWorksheetPageOrder

type ContractWorksheetPageOrder = "downThenOver" | "overThenDown";

ContractWorksheetPageOrientation

type ContractWorksheetPageOrientation = "portrait" | "landscape";

ContractWorksheetPageScaleMode

type ContractWorksheetPageScaleMode = "adjust" | "fit";

ContractWorksheetPageSetup

interface ContractWorksheetPageSetup {
  orientation: ContractWorksheetPageOrientation;
  paperSize: number;
  scaleMode: ContractWorksheetPageScaleMode;

  scaleDraft: string;
  fitToWidth: number;
  fitToHeight: number;
  margins: ContractWorksheetPageMargins;
  printGridLines: boolean;
  printHeadings: boolean;

  printArea?: ContractWorksheetPrintArea | null;

  printTitleRows?: ContractWorksheetPageAxisRange | null;

  printTitleColumns?: ContractWorksheetPageAxisRange | null;

  oddHeader?: string;

  oddFooter?: string;

  pageOrder?: ContractWorksheetPageOrder;
}

ContractWorksheetPrintArea

interface ContractWorksheetPrintArea {
  rowStart: number;
  rowEnd: number;
  colStart: number;
  colEnd: number;
}

ContractXlsxPrintAreaClearPatch

interface ContractXlsxPrintAreaClearPatch {
  activeSheetPath: string;
}

ContractXlsxPrintAreaPatch

interface ContractXlsxPrintAreaPatch {
  activeSheetPath: string;
  ref: string;
}

ContractXlsxPrintTitlesClearPatch

interface ContractXlsxPrintTitlesClearPatch {
  activeSheetPath: string;
}

ContractXlsxPrintTitlesPatch

interface ContractXlsxPrintTitlesPatch {
  activeSheetPath: string;
  rowStart: number;
  rowEnd: number;
}

ContractXlsxWorksheetHeaderFooterClearPatch

interface ContractXlsxWorksheetHeaderFooterClearPatch {
  activeSheetPath: string;
}

ContractXlsxWorksheetHeaderFooterPatch

interface ContractXlsxWorksheetHeaderFooterPatch {
  activeSheetPath: string;
  oddHeader?: string | null;
  oddFooter?: string | null;
}

ContractXlsxWorksheetPageBreakPatch

interface ContractXlsxWorksheetPageBreakPatch {
  activeSheetPath: string;
  rowBreakId?: number | null;
  columnBreakId?: number | null;
}

ContractXlsxWorksheetPageBreakResetPatch

interface ContractXlsxWorksheetPageBreakResetPatch {
  activeSheetPath: string;
}

ContractXlsxWorksheetPageSetupPatch

interface ContractXlsxWorksheetPageSetupPatch {
  activeSheetPath: string;
  orientation?: "portrait" | "landscape" | null;
  paperSize?: number | null;
  scale?: number | null;
  fitToWidth?: number | null;
  fitToHeight?: number | null;
  pageMargins?: {
    left: number;
    right: number;
    top: number;
    bottom: number;
    header: number;
    footer: number;
  } | null;
}

ContractXlsxWorksheetPrintOptionsPatch

interface ContractXlsxWorksheetPrintOptionsPatch {
  activeSheetPath: string;
  gridLines?: boolean | null;
  headings?: boolean | null;
}

SortRangeRowsHeaderMode

type SortRangeRowsHeaderMode = "auto" | "present" | "absent";