Interface IContentBlockTree

An abstraction of the content in a IReaderDocument.

interface IContentBlockTree {
    getContentBlockById(contentBlockId: number): IContentBlock;
    getContentBlocks(): IContentBlock[];
    getReaderDocument(): IReaderDocument;
    toSerializableData(
        options?: Partial<IContentBlockSerializationOptions>,
    ): IContentBlockData[];
}

Methods

getContentBlockById

getContentBlockById(contentBlockId: number): IContentBlock
Get a content block by id, previously retrieved using IContentBlock.getId() for a content block associated with this reader document.

Using a contentBlockId from another reader document will produce undefined results.
Parameters
- contentBlockId: number
Returns IContentBlock

getContentBlocks

getContentBlocks(): IContentBlock[]
Get all root content block objects of this tree

Returns IContentBlock[]

getReaderDocument

getReaderDocument(): IReaderDocument
The reader document associated with this instance.

Returns IReaderDocument

toSerializableData

toSerializableData(
options?: Partial<IContentBlockSerializationOptions>,
): IContentBlockData[]
Get all content blocks as tree structure that is serializable to JSON.
Parameters
- Optionaloptions: Partial<IContentBlockSerializationOptions>
Returns IContentBlockData[]