Class DefaultHelpDocProvider

Hierarchy

DefaultHelpDocProvider

Implements

IHelpDocProvider

Index

Constructors

constructor

Properties

Methods

Constructors

Protected constructor

new DefaultHelpDocProvider(renderedDocs: string[], metadata: any[], latexTypesetter: ILatexTypesetter | null, linkHandler: ILinkHandler | null, resolver: IResolver | null): DefaultHelpDocProvider

- Defined in docprovider.ts:40
Parameters
- renderedDocs: string[]
- metadata: any[]
- latexTypesetter: ILatexTypesetter | null
- linkHandler: ILinkHandler | null
- resolver: IResolver | null
Returns DefaultHelpDocProvider

Properties

Private documents

documents: Array<string>

Private latexTypesetter

latexTypesetter: ILatexTypesetter | null

Private linkHandler

linkHandler: ILinkHandler | null

Private metadata

metadata: Array<Record<string, string> | null>

onChanged

onChanged: Observable<void> = this.onChangedSrc$.asObservable()

onChangedSrc$

onChangedSrc$: Subject<void> = new Subject<void>()

Private resolver

resolver: IResolver | null

Methods

addDocument

addDocument(doc: string): Promise<void>

Implementation of IHelpDocProvider.addDocument
- Defined in docprovider.ts:69
Parameters
- doc: string
Returns Promise<void>

getDocument

getDocument(titleOrIdx: string | number): string

Implementation of IHelpDocProvider.getDocument
- Defined in docprovider.ts:58
Parameters
- titleOrIdx: string | number
Returns string

getMetadata

getMetadata(): (null | object)[]

Implementation of IHelpDocProvider.getMetadata
- Defined in docprovider.ts:56
Returns (null | object)[]

Static Create

Create(latexTypesetter: ILatexTypesetter | null, linkHandler: ILinkHandler | null, resolver: IResolver | null): Promise<DefaultHelpDocProvider>

- Defined in docprovider.ts:23
Parameters
- latexTypesetter: ILatexTypesetter | null
- linkHandler: ILinkHandler | null
- resolver: IResolver | null
Returns Promise<DefaultHelpDocProvider>

Generated using TypeDoc