@andreiher/pdfkit-table/index.d.ts

Forked and modified version of pdfkit-table. PdfKit Table. Helps to draw informations in simple tables using pdfkit. #server-side. Generate pdf tables with javascript (PDFKIT plugin)

declare module '@andreiher/pdfkit-table'
{
	import PDFDocument from 'pdfkit';

	interface Rect {
		x: number;
		y: number;
		width: number;
		height: number;
	}

	interface Header {
		label?: string;
		property?: string;
		width?: number;
		align?: string; //default 'left'
		valign?: string;
		headerColor?: string; //default '#BEBEBE'
		headerOpacity?: number; //default '0.5'
		headerAlign?: string; //default 'left'
		columnColor?: string;
		columnOpacity?: number;
		renderer?: (
			value: any,
			indexColumn?: number,
			indexRow?: number,
			row?: number,
			rectRow?: Rect,
			rectCell?: Rect
		) => string;
	}

	interface DataOptions {
		fontSize: number;
		fontFamily: string;
		separation: boolean;
	}

	interface Data {
		[key: string]: string | { label: string; options?: DataOptions };
	}

	interface Table {
		title?: string;
		subtitle?: string;
		headers?: (string | Header)[];
		datas?: Data[];
		rows?: string[][];
	}

	interface DividerOptions {
		disabled?: boolean;
		width?: number;
		opacity?: number;
		color?: string;
	}

	interface Divider {
		header?: DividerOptions;
		horizontal?: DividerOptions;
		vertical?: DividerOptions;
	}

	interface Title 
	{
		label: string;
		fontSize?: number;
		fontFamily?: string;
		color?: string; 
	}

	interface Options {
		title?: string | Title ;
		subtitle?: string | Title;
		width?: number;
		x?: number; //default doc.x
		y?: number; //default doc.y
		divider?: Divider;
		columnsSize?: number[];
		columnSpacing?: number; //default 5
		padding?: number[]; 
		addPage?: boolean; //default false
		hideHeader?: boolean;
		minRowHeight?: number;
		prepareHeader?: () => PDFDocumentWithTables;
		prepareRow?: (
			row?: any,
			indexColumn?: number,
			indexRow?: number,
			rectRow?: Rect,
			rectCell?: Rect
		) => PDFDocumentWithTables;
	}

	class PDFDocumentWithTables extends PDFDocument {
		public table(table: Table, options?: Options): Promise<void>;
	}

	// export = PDFDocumentWithTables;
	export default PDFDocumentWithTables;
}