ListCollection Class

A collection of the List objects.

Declaration

export class ListCollection extends Collection<List>

Inherited Members

Inheritance

Collection<T>
ListCollection

Methods

create(type) Method

Creates a new List object of the specified type and adds it to the collection.

Declaration

create(
    type: ListType
): List

Parameters

Name Type Description
type ListType

The type of list.

Returns

Type Description
List

The newly created list.

deleteNumeration(subDocument, interval) Method

Deletes numeration of specified paragraph(s).

Declaration

deleteNumeration(
    subDocument: SubDocument,
    interval: IInterval | number
): void

Parameters

Name Type Description
subDocument SubDocument

A sub-document that contains the processed paragraph(s).

interval IInterval | number

An interval that traverses the processed paragraph(s) or a position in the paragraph.