docxml
Version:
TypeScript (component) library for building and parsing a DOCX file
57 lines (56 loc) • 1.82 kB
TypeScript
import { Length } from '../utilities/length.js';
/**
* All the formatting options that can be given on a text run (inline text).
*
* Serializes to the <w:rPr> element.
* https://c-rex.net/projects/samples/ooxml/e1/Part4/OOXML_P4_DOCX_rPr_topic_ID0EIEKM.html
*/
export declare type SectionProperties = {
/**
* A reference to the header portion on every page in this section.
*/
headers?: null | string | {
first?: string | null;
even?: string | null;
odd?: string | null;
};
/**
* A reference to the footer portion on every page in this section.
*/
footers?: null | string | {
first?: string | null;
even?: string | null;
odd?: string | null;
};
/**
* The width of any page in this section.
*/
pageWidth?: null | Length;
/**
* The height of any page in this section.
*/
pageHeight?: null | Length;
/**
* The supposed orientation noted for pages in this section. Overridden by `.pageWidth` or `.pageHeight`
* when they are set.
*/
pageOrientation?: null | 'landscape' | 'portrait';
/**
* The space between content and various other boundaries in the page layout.
*/
pageMargin?: {
top?: null | Length;
right?: null | Length;
bottom?: null | Length;
left?: null | Length;
header?: null | Length;
footer?: null | Length;
gutter?: null | Length;
};
/**
* Specifies whether sections in the document shall have different headers and footers for even and odd pages.
*/
isTitlePage?: null | boolean;
};
export declare function sectionPropertiesFromNode(node?: Node | null): SectionProperties;
export declare function sectionPropertiesToNode(data?: SectionProperties): Node;