ods-reader 0.1.2 | Documentation

Cell

General data object for storing cell information.

new Cell()

Instance Members

▸ clone()

Creates a shallow copy of this cell.

clone(): Cell

Returns

Cell: The created copy.

CellBuilder

Builds the description of a table cell.

new CellBuilder(callback: Function)

Parameters

callback (Function) A function to be called with the cell data.

Instance Members

▸ beginSheet()

Must be called whenever a new sheet begins.

beginSheet(): CellBuilder

Returns

CellBuilder: This CellBuilder.

▸ emitCell(cell)

Registers the given Cell for the Cell's span of rows and columns and calls the callback function with the Cell's data.

emitCell(cell: Cell): CellBuilder

Parameters

cell (Cell) The Cell object.

Returns

CellBuilder: This CellBuilder.

▸ emitCoveredCell(cell)

Gets the registered master Cell for the given cell and calls the callback function with the Cell's data.

emitCoveredCell(cell: Cell): CellBuilder

Parameters

cell (Cell) The Cell object.

Returns

CellBuilder: This CellBuilder.

ContentParser

Parses the content.xml file of an ODS document.

new ContentParser(styleResolver: StyleResolver, cellBuilder: CellBuilder)

Parameters

styleResolver (StyleResolver) Resolver used to look up styles.

cellBuilder (CellBuilder) Invoked for every parsed table cell.

Instance Members

▸ parse(xml)

Parses a content.xml document.

parse(xml: string): ContentParser

Parameters

xml (string) XML document.

Returns

ContentParser: This ContentParser.

OdsReader

Central class for reading ODS files.

new OdsReader()

Static Members

▸ readBuffer(buffer, callback)

Read an ODS file from a buffer.

readBuffer(buffer: (Buffer | Uint8Array), callback: Function)

Parameters

buffer ((Buffer | Uint8Array)) The byte buffer with file content.

callback (Function) The callback function called for each cell.

▸ readFile(filename, callback)

Read an ODF file from disk.

readFile(filename: string, callback: Function)

Parameters

filename (string) The name of the file to read.

callback (Function) The callback function called for each cell.

RichTextBuilder

Builds the rich text representation of a table cell.

new RichTextBuilder()

Instance Members

▸ clear()

Clears the current content.

clear(): RichTextBuilder

Returns

RichTextBuilder: This RichTextBuilder.

▸ breakSegment()

Prevents the next append() call from being merged with the previous segment.

breakSegment(): RichTextBuilder

Returns

RichTextBuilder: This RichTextBuilder.

▸ append(text, style)

Appends a text segment.

append(text: string, style: Style): RichTextBuilder

Parameters

text (string) Text to append.

style (Style) Style of the text.

Returns

RichTextBuilder: This RichTextBuilder.

▸ appendSpaces(style, count)

Appends one or more space characters.

appendSpaces(style: Style, count: number?): RichTextBuilder

Parameters

style (Style) Style of the text.

count (number?) Number of spaces.

Returns

RichTextBuilder: This RichTextBuilder.

▸ appendTabs(style, count)

Appends one or more tabulator characters.

appendTabs(style: Style, count: number?): RichTextBuilder

Parameters

style (Style) Style of the text.

count (number?) Number of tabs.

Returns

RichTextBuilder: This RichTextBuilder.

▸ appendLineBreaks(style, count)

Appends one or more line break characters.

appendLineBreaks(style: Style, count: number?): RichTextBuilder

Parameters

style (Style) Style of the text.

count (number?) Number of line breaks.

Returns

RichTextBuilder: This RichTextBuilder.

▸ build()

Builds the final rich text data structures for the builder's current content and return an object with the plain text, an array of rich text segments, each consisting of the text data and the corresponding style data, and an array of style data per character. This array contains as many elements as characters are contained in the plain text. Each element index points to the effective style for the corresponding character. Characters in this context are real visible characters (unicode code points or graphemes) that may consist of several UTF16 code units. If you know that your strings contain such characters, don't use plainText.length or plainText.at(), since those only handle UTF16 code units and will lead to wrong indexes. Use one of the methods below, instead, to access single characters.

build(): object

Returns

object: The final rich text data.

Example

{
  plainText: 'Hello World',
  richText: [{text: 'Hello ', style: style1}, {text: 'World', style: style2}],
  styleAt: [style1, style1, style1, style1, style1, style1, style2, style2, style2, style2, style2]
}
const char = plainText.codePointAt();
const chars = [...plainText];
for(const char of plainText) {};
const segmenter = new Intl.Segmenter(undefined, {granularity: "grapheme"});
const chars = [...segmenter.segment(plainText)];

Style

General data object for storing style information.

new Style()

Instance Members

▸ hasProperty(property)

Returns whether ths style has the specified property set.

hasProperty(property: string): boolean

Parameters

property (string) The property name to check.

Returns

boolean: true if it is set, false otherwise.

▸ clone()

Creates a copy of this style.

clone(): Style

Returns

Style: The created copy.

▸ merge(parentStyle)

Merges all missing properties from the given parent style. Existing values of this style are preserved.

merge(parentStyle: Style): Style

Parameters

parentStyle (Style) Parent style.

Returns

Style: This Style.

▸ equals(style)

Checks whether two styles are equal.

equals(style: Style): boolean

Parameters

style (Style) The style to compare with.

Returns

boolean: true if styles are equal, false otherwise.

StyleResolver

Resolves styles by their names.

new StyleResolver(styles: Map<string, Style>)

Parameters

styles

(Map<string, Style>
            = new Map())

Map containing all known styles.

Instance Members

▸ hasStyle(name)

Returns whether a style exists.

hasStyle(name: (string | null)): boolean

Parameters

name ((string | null)) Style name.

Returns

boolean: true if style exists, false otherwise.

▸ getStyle(name)

Returns a style by its name.

getStyle(name: (string | null)): (Style | null)

Parameters

name ((string | null)) Style name.

Returns

(Style | null): The style, or null if no such style exists.

▸ getTextStyle(name)

Returns a text style.

getTextStyle(name: (string | null)): (Style | null)

Parameters

name ((string | null)) Style name.

Returns

(Style | null): The style, or null if no such style exists.

▸ getParagraphStyle(name)

Returns a paragraph style.

getParagraphStyle(name: (string | null)): (Style | null)

Parameters

name ((string | null)) Style name.

Returns

(Style | null): The style, or null if no such style exists.

▸ getCellStyle(name)

Returns a table cell style.

getCellStyle(name: (string | null)): (Style | null)

Parameters

name ((string | null)) Style name.

Returns

(Style | null): The style, or null if no such style exists.

▸ getRowStyle(name)

Returns a table row style.

getRowStyle(name: (string | null)): (Style | null)

Parameters

name ((string | null)) Style name.

Returns

(Style | null): The style, or null if no such style exists.

▸ getColumnStyle(name)

Returns a table column style.

getColumnStyle(name: (string | null)): (Style | null)

Parameters

name ((string | null)) Style name.

Returns

(Style | null): The style, or null if no such style exists.

StylesParser

Parses the styles.xml file of an ODS document.

new StylesParser()

Instance Members

▸ parse(xml)

Parses an XML document string.

parse(xml: string): StylesParser

Parameters

xml (string) XML document string.

Returns

StylesParser: This StylesParser.

▸ resolveInheritance()

Resolves all Style inheritances.

resolveInheritance(): StylesParser

Returns

StylesParser: This StylesParser.

▸ getStyles()

Returns all parsed styles.

getStyles(): Map<string, Style>

Returns

Map<string, Style>: Map of resolved styles indexed by style name.

▸ getStyle(name)

Returns a style by its name.

getStyle(name: string): (Style | null)

Parameters

name (string) Style name.

Returns

(Style | null): The style, or null if no such style exists.

XmlContext

Maintains the current XML element hierarchy while parsing an XML document.

new XmlContext()

Instance Members

▸ push(name)

Pushes an element onto the context stack.

push(name: string): XmlContext

Parameters

name (string) XML element name.

Returns

XmlContext: This XmlContext.

▸ root()

Returns the first XML element.

root(): (string | null)

Returns

(string | null): First element or null if the stack is empty.

▸ pop()

Removes the current element from the context stack.

pop(): (string | null)

Returns

(string | null): Removed element or null if the stack is empty.

▸ peek()

Returns the current XML element.

peek(): (string | null)

Returns

(string | null): Current element or null if the stack is empty.

▸ parent()

Returns the parent element.

parent(): (string | null)

Returns

(string | null): Parent element or null if none exists.

▸ path()

Returns a string representation of the current XML path.

path(): string

Returns

string: The current XML path.

▸ contains(name)

Returns whether the specified element exists in the context stack.

contains(name: string): boolean

Parameters

name (string) XML element name.

Returns

boolean: true if the element exists, false otherwise.

▸ isInside(elements)

Returns whether the specified sequence of elements exists at the end of the current XML path.

isInside(elements: ...string): boolean

Parameters

elements (...string) XML elements.

Returns

boolean: true if the elements existi, false otherwise.

▸ isCurrent(name)

Returns whether the current element matches the specified name.

isCurrent(name: string): boolean

Parameters

name (string) XML element name.

Returns

boolean: true if current element matches, false otherwise.

▸ depth()

Returns the current nesting depth.

depth(): number

Returns

number: The depth.