Class Section

Hierarchy

NPXObject
- Section

Implements

Parent

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Section(title: string, sections?: Section[], notes?: Note[], internalRef?: undefined | string, parent?: Parent | string): Section

Overrides NPXObject.constructor
- Defined in src/Section.ts:6
Parameters
- title: string
- Default value sections: Section[] = []
- Default value notes: Note[] = []
- Optional internalRef: undefined | string
- Optional parent: Parent | string
Returns Section

Properties

Readonly internalRef

internalRef: string

Readonly notes

notes: Note[]

parent

parent: Parent | string | undefined

Readonly sections

sections: Section[]

Readonly title

title: string

Methods

addNote

addNote(note: Note): Section

- Defined in src/Section.ts:31
Parameters
- note: Note
Returns Section

addSection

addSection(section: Section): Section

- Defined in src/Section.ts:17
Parameters
- section: Section
Returns Section

Protected clean

clean(str: string): string

Inherited from NPXObject.clean
- Defined in src/NPXObject.ts:37
Parameters
- str: string
Returns string

The string without certain values that could cause parsing issues in the future

clone

clone(opts?: Partial<Section>): Section

- Defined in src/Section.ts:82
Parameters
- Default value opts: Partial<Section> = {}
Returns Section

Protected generateGuid

generateGuid(): string

Inherited from NPXObject.generateGuid
- Defined in src/NPXObject.ts:26
Returns string

search

search(query: string): Note[]

Overrides NPXObject.search
- Defined in src/Section.ts:45
Parameters
- query: string
Returns Note[]

toMarkdown

toMarkdown(assets: Asset[]): Promise<MarkdownNote[]>

- Defined in src/Section.ts:68
Parameters
- assets: Asset[]
Returns Promise<MarkdownNote[]>

toXmlObject

toXmlObject(): any

Overrides NPXObject.toXmlObject
- Defined in src/Section.ts:56
Returns any

Generated using TypeDoc