Print

/**
 * Configuration interface for sheet print layout settings
 */
export interface ISheetPrintLayoutConfig {
  /**
   * Specifies which area of the sheet to print (e.g., current sheet, selection)
   */
  area: PrintArea
  /**
   * List of sub-unit IDs to print, can include specific ranges within units
   */
  subUnitIds: (string | { id: string, range: IRange })[]
  /**
   * Paper size setting (e.g., A4, Letter)
   */
  paperSize: PrintPaperSize
  /**
   * Page orientation (Portrait or Landscape)
   */
  direction: PrintDirection
  /**
   * Scale type for fitting content to page
   */
  scale: PrintScale
  /**
   * Custom scale percentage when scale type is custom
   */
  customScale: number
  /**
   * Array of freeze settings for rows and columns
   */
  freeze: PrintFreeze[]
  /**
   * Margin preset for the printed page
   */
  margin: PrintPaperMargin
  /**
   * Custom page dimensions when using custom paper size
   */
  pageSizeCustom?: { w: number, h: number }
  /**
   * Maximum number of rows to print per page
   */
  maxRowsEachPage: number
  /**
   * Maximum number of columns to print per page
   */
  maxColumnsEachPage: number
}

/**
 * Defines the area of the spreadsheet to be printed
 */
export enum PrintArea {
  /** Print only the current active sheet */
  CurrentSheet = 'CurrentSheet',
  /** Print the entire workbook */
  workbook = 'Workbook',
  /** Print only the current selected range */
  CurrentSelection = 'CurrentSelection',
  /** Print all selected ranges across sheets */
  AllSelection = 'AllSelection',
}

/**
 * Defines the paper size for printing
 */
export enum PrintPaperSize {
  /** Use the letter paper size */
  Letter = 'Letter',
  /** Use the tabloid paper size */
  Tabloid = 'Tabloid',
  /** Use the legal paper size */
  Legal = 'Legal',
  /** Use the statement paper size */
  Statement = 'Statement',
  /** Use the executive paper size */
  Executive = 'Executive',
  /** Use the folio paper size */
  Folio = 'Folio',
  /** Use the A3 paper size */
  A3 = 'A3',
  /** Use the A4 paper size */
  A4 = 'A4',
  /** Use the A5 paper size */
  A5 = 'A5',
  /** Use the B4 paper size */
  B4 = 'B4',
  /** Use the B5 paper size */
  B5 = 'B5',
}

/**
 * Defines the direction of the printed page
 */
export enum PrintDirection {
  /** Portrait orientation */
  Portrait = 'Portrait',
  /** Landscape orientation */
  Landscape = 'Landscape',
}

/**
 * Defines the scale type for printing
 */
export enum PrintScale {
  /** normal scale */
  Origin = 'Origin',
  /** Fit to width */
  FitWidth = 'FitWidth',
  /** Fit to height */
  FitHeight = 'FitHeight',
  /** Fit to page */
  FitPage = 'FitPage',
  /** Custom scale */
  Custom = 'Custom',
}

/**
 * Defines which elements should remain frozen when printing
 */
export enum PrintFreeze {
  /** Keep row headers frozen when printing */
  Row = 'Row',
  /** Keep column headers frozen when printing */
  Column = 'Column',
}

/**
 * Defines the margin preset for the printed page
 */
export enum PrintPaperMargin {
  /** Use the normal margin */
  Normal = 'Normal',
  /** Use the narrow margin */
  Narrow = 'Narrow',
  /** Use the wide margin */
  Wide = 'Wide',
  /** Not set any margin */
  None = 'None',
}

/**
 * Configuration interface for sheet print rendering options
 */
export interface ISheetPrintRenderConfig {
  /**
   * Whether to show gridlines in the printed output
   */
  gridlines: boolean
  /**
   * Horizontal alignment setting for content
   */
  hAlign: PrintAlign
  /**
   * Vertical alignment setting for content
   */
  vAlign: PrintAlign
  /**
   * Array of header and footer elements to include
   */
  headerFooter: PrintHeaderFooter[]
  /**
   * Detailed settings for header and footer content
   */
  headerFooterSetting: IPrintHeaderFooter
  /**
   * Whether using custom header/footer instead of presets
   */
  isCustomHeaderFooter?: boolean

  watermark?: Nullable<IWatermarkConfigWithType>
}

/**
 * Defines the available alignment options for printed content
 */
export enum PrintAlign {
  /** horizontally align content to the left, vertically align content to the top */
  Start = 'Start',
  /** horizontally align content to the right, vertically align content to the bottom */
  End = 'End',
  /** horizontally align content to the center, vertically align content to the center */
  Middle = 'Middle',
}

/**
 * Defines the available placeholders for header and footer content
 */
export enum PrintHeaderFooter {
  /** Insert current page numbers information */
  PageSize = 'PageSize',
  /** Insert workbook name */
  WorkbookTitle = 'WorkbookTitle',
  /** Insert worksheet name */
  WorksheetTitle = 'WorksheetTitle',
  /** Insert current date */
  Date = 'Date',
  /** Insert current time */
  Time = 'Time',
}

/**
 * Configuration interface for header and footer content positioning
 */
export interface IPrintHeaderFooter {
  /** Content to display in the top-left section */
  topLeft: string
  /** Content to display in the top-center section */
  topCenter: string
  /** Content to display in the top-right section */
  topRight: string
  /** Content to display in the bottom-left section */
  bottomLeft: string
  /** Content to display in the bottom-center section */
  bottomCenter: string
  /** Content to display in the bottom-right section */
  bottomRight: string
}