Make API simplier with interfaces
This commit is contained in:
@ -16,19 +16,19 @@ export class StyleLevel {
|
||||
* Short Guide:
|
||||
* http://officeopenxml.com/WPtableOfContents.php
|
||||
*/
|
||||
export class TableOfContentsProperties {
|
||||
export interface ITableOfContentsProperties {
|
||||
/**
|
||||
* \a option - Includes captioned items, but omits caption labels and numbers.
|
||||
* The identifier designated by text in this switch's field-argument corresponds to the caption label.
|
||||
* Use captionLabelIncludingNumbers (\c) to build a table of captions with labels and numbers.
|
||||
*/
|
||||
public captionLabel: string;
|
||||
captionLabel?: string;
|
||||
|
||||
/**
|
||||
* \b option - Includes entries only from the portion of the document marked by
|
||||
* the bookmark named by text in this switch's field-argument.
|
||||
*/
|
||||
public entriesFromBookmark: string;
|
||||
entriesFromBookmark?: string;
|
||||
|
||||
/**
|
||||
* \c option - Includes figures, tables, charts, and other items that are numbered
|
||||
@ -36,24 +36,24 @@ export class TableOfContentsProperties {
|
||||
* field-argument, which corresponds to the caption label, shall match the identifier in the
|
||||
* corresponding SEQ field.
|
||||
*/
|
||||
public captionLabelIncludingNumbers: string;
|
||||
captionLabelIncludingNumbers?: string;
|
||||
|
||||
/**
|
||||
* \d option - When used with \s, the text in this switch's field-argument defines
|
||||
* the separator between sequence and page numbers. The default separator is a hyphen (-).
|
||||
*/
|
||||
public sequenceAndPageNumbersSeparator: string;
|
||||
sequenceAndPageNumbersSeparator?: string;
|
||||
|
||||
/**
|
||||
* \f option - Includes only those TC fields whose identifier exactly matches the
|
||||
* text in this switch's field-argument (which is typically a letter).
|
||||
*/
|
||||
public tcFieldIdentifier: string;
|
||||
tcFieldIdentifier?: string;
|
||||
|
||||
/**
|
||||
* \h option - Makes the table of contents entries hyperlinks.
|
||||
*/
|
||||
public hyperlink: boolean;
|
||||
hyperlink?: boolean;
|
||||
|
||||
/**
|
||||
* \l option - Includes TC fields that assign entries to one of the levels specified
|
||||
@ -61,14 +61,14 @@ export class TableOfContentsProperties {
|
||||
* where startLevel and endLevel are integers, and startLevel has a value equal-to or less-than endLevel.
|
||||
* TC fields that assign entries to lower levels are skipped.
|
||||
*/
|
||||
public tcFieldLevelRange: string;
|
||||
tcFieldLevelRange?: string;
|
||||
|
||||
/**
|
||||
* \n option - Without field-argument, omits page numbers from the table of contents.
|
||||
* Page numbers are omitted from all levels unless a range of entry levels is specified by
|
||||
* text in this switch's field-argument. A range is specified as for \l.
|
||||
*/
|
||||
public pageNumbersEntryLevelsRange: string;
|
||||
pageNumbersEntryLevelsRange?: string;
|
||||
|
||||
/**
|
||||
* \o option - Uses paragraphs formatted with all or the specified range of builtin
|
||||
@ -77,20 +77,20 @@ export class TableOfContentsProperties {
|
||||
* to the style with a style ID of HeadingX (e.g. 1 corresponds to Heading1).
|
||||
* If no heading range is specified, all heading levels used in the document are listed.
|
||||
*/
|
||||
public headingStyleRange: string;
|
||||
headingStyleRange?: string;
|
||||
|
||||
/**
|
||||
* \p option - Text in this switch's field-argument specifies a sequence of characters
|
||||
* that separate an entry and its page number. The default is a tab with leader dots.
|
||||
*/
|
||||
public entryAndPageNumberSeparator: string;
|
||||
entryAndPageNumberSeparator?: string;
|
||||
|
||||
/**
|
||||
* \s option - For entries numbered with a SEQ field (§17.16.5.56), adds a prefix to the page number.
|
||||
* The prefix depends on the type of entry. text in this switch's field-argument shall match the
|
||||
* identifier in the SEQ field.
|
||||
*/
|
||||
public seqFieldIdentifierForPrefix: string;
|
||||
seqFieldIdentifierForPrefix?: string;
|
||||
|
||||
/**
|
||||
* \t field-argument Uses paragraphs formatted with styles other than the built-in heading styles.
|
||||
@ -98,25 +98,25 @@ export class TableOfContentsProperties {
|
||||
* with each doublet being a comma-separated set of style name and table of content level.
|
||||
* \t can be combined with \o.
|
||||
*/
|
||||
public stylesWithLevels: StyleLevel[];
|
||||
stylesWithLevels?: StyleLevel[];
|
||||
|
||||
/**
|
||||
* \u Uses the applied paragraph outline level.
|
||||
*/
|
||||
public useAppliedParagraphOutlineLevel = false;
|
||||
useAppliedParagraphOutlineLevel?: boolean;
|
||||
|
||||
/**
|
||||
* \w Preserves tab entries within table entries.
|
||||
*/
|
||||
public preserveTabInEntries = false;
|
||||
preserveTabInEntries?: boolean;
|
||||
|
||||
/**
|
||||
* \x Preserves newline characters within table entries.
|
||||
*/
|
||||
public preserveNewLineInEntries = false;
|
||||
preserveNewLineInEntries?: boolean;
|
||||
|
||||
/**
|
||||
* \z Hides tab leader and page numbers in web page view (§17.18.102).
|
||||
*/
|
||||
public hideTabAndPageNumbersInWebView = false;
|
||||
hideTabAndPageNumbersInWebView?: boolean;
|
||||
}
|
||||
|
Reference in New Issue
Block a user