打印

/**
 * 打印布局设置的配置接口
 */
export interface ISheetPrintLayoutConfig {
  /**
   * 指定要打印的工作表区域（例如，当前工作表，选区）
   */
  area: PrintArea
  /**
   * 要打印的工作簿的工作表 ID 集合，或者包含工作表 ID 和范围的对象集合
   */
  subUnitIds: (string | { id: string, range: IRange })[]
  /**
   * 打印纸张大小设置（例如，A4，信纸）
   */
  paperSize: PrintPaperSize
  /**
   * 打印页面方向（纵向或横向）
   */
  direction: PrintDirection
  /**
   * 打印缩放类型
   */
  scale: PrintScale
  /**
   * 自定义缩放百分比
   */
  customScale: number
  /**
   * 冻结行和列的设置数组
   */
  freeze: PrintFreeze[]
  /**
   * 打印页面的边距预设
   */
  margin: PrintPaperMargin
  /**
   * 使用自定义纸张尺寸时的自定义页面尺寸
   */
  pageSizeCustom?: { w: number, h: number }
  /**
   * 每页打印的最大行数
   */
  maxRowsEachPage: number
  /**
   * 每页打印的最大列数
   */
  maxColumnsEachPage: number
}

/**
 * 定义要打印的电子表格区域
 */
export enum PrintArea {
  /** 只打印当前活动工作表 */
  CurrentSheet = 'CurrentSheet',
  /** 打印整个工作簿 */
  workbook = 'Workbook',
  /** 只打印当前选定的范围 */
  CurrentSelection = 'CurrentSelection',
  /** 打印所有选定的范围 */
  AllSelection = 'AllSelection',
}

/**
 * 定义打印纸张大小
 */
export enum PrintPaperSize {
  /** 使用信纸大小 */
  Letter = 'Letter',
  /** 使用小报纸大小 */
  Tabloid = 'Tabloid',
  /** 使用法律纸张大小 */
  Legal = 'Legal',
  /** 使用报表纸张大小 */
  Statement = 'Statement',
  /** 使用行政公文纸张大小 */
  Executive = 'Executive',
  /** 使用对折纸张大小 */
  Folio = 'Folio',
  /** 使用A3纸张大小 */
  A3 = 'A3',
  /** 使用A4纸张大小 */
  A4 = 'A4',
  /** 使用A5纸张大小 */
  A5 = 'A5',
  /** 使用B4纸张大小 */
  B4 = 'B4',
  /** 使用B5纸张大小 */
  B5 = 'B5',
}

/**
 * 定义打印页面的方向
 */
export enum PrintDirection {
  /** 纵向方向 */
  Portrait = 'Portrait',
  /** 横向方向 */
  Landscape = 'Landscape',
}

/**
 * 定义打印的缩放类型
 */
export enum PrintScale {
  /** 正常缩放 */
  Origin = 'Origin',
  /** 适合宽度 */
  FitWidth = 'FitWidth',
  /** 适合高度 */
  FitHeight = 'FitHeight',
  /** 适合页面大小 */
  FitPage = 'FitPage',
  /** 自定义缩放 */
  Custom = 'Custom',
}

/**
 * 定义打印时应保持冻结的元素
 */
export enum PrintFreeze {
  /** 打印时保持行标题冻结 */
  Row = 'Row',
  /** 打印时保持列标题冻结 */
  Column = 'Column',
}

/**
 * 定义打印页面的边距预设
 */
export enum PrintPaperMargin {
  /** 使用正常边距 */
  Normal = 'Normal',
  /** 使用窄边距 */
  Narrow = 'Narrow',
  /** 使用宽边距 */
  Wide = 'Wide',
  /** 没有边距 */
  None = 'None',
}

/**
 * 打印渲染选项的配置接口
 */
export interface ISheetPrintRenderConfig {
  /**
   * 是否在打印输出中显示网格线
   */
  gridlines: boolean
  /**
   * 水平对齐设置
   */
  hAlign: PrintAlign
  /**
   * 垂直对齐设置
   */
  vAlign: PrintAlign
  /**
   * 包含的页眉和页脚元素数组
   */
  headerFooter: PrintHeaderFooter[]
  /**
   * 页眉和页脚的详细设置
   */
  headerFooterSetting: IPrintHeaderFooter
  /**
   * 是否使用自定义页眉和页脚而不是预设
   */
  isCustomHeaderFooter?: boolean

  watermark?: Nullable<IWatermarkConfigWithType>
}

/**
 * 定义打印内容的可用对齐选项
 */
export enum PrintAlign {
  /** 水平方向左对齐，垂直方向顶部对齐 */
  Start = 'Start',
  /** 水平方向右对齐，垂直方向底部对齐 */
  End = 'End',
  /** 水平方向居中对齐，垂直方向居中对齐 */
  Middle = 'Middle',
}

/**
 * 定义页眉和页脚内容的可用占位符
 */
export enum PrintHeaderFooter {
  /** 插入当前页码信息 */
  PageSize = 'PageSize',
  /** 插入工作簿名称 */
  WorkbookTitle = 'WorkbookTitle',
  /** 插入工作表名称 */
  WorksheetTitle = 'WorksheetTitle',
  /** 插入当前日期 */
  Date = 'Date',
  /** 插入当前时间 */
  Time = 'Time',
}

/**
 * 页眉和页脚内容定位的配置接口
 */
export interface IPrintHeaderFooter {
  /** 左上角显示的内容 */
  topLeft: string
  /** 顶部中心显示的内容 */
  topCenter: string
  /** 右上角显示的内容 */
  topRight: string
  /** 左下角显示的内容 */
  bottomLeft: string
  /** 底部中心显示的内容 */
  bottomCenter: string
  /** 右下角显示的内容 */
  bottomRight: string
}