Home Reference Source
import OpDocs from './ui/components/opdocs.js'
public class | source

OpDocs

op documentation loading

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

coreLibs: *[]

public

libs: *[]

Private Members
private
private

_log: *

private

_opDocs: *[]

private

Method Summary

Public Methods
public
public

addOpDocs(opDocs: *[])

public

addTypeStringToPorts(ports: array)

Creates a "typeString" attribute for each port-object in the array (e.g.

public
public

extendOpDocs(_opDocs: array)

Adds some properties to each doc in the op docs array

public

getAll(): *

public

getAttachmentFiles(opname: *): *[]

public
public

getHtml(opName: string, collectionInfo: *): *

Returns the documentation for an op as Html

public

getLayoutSvg(opname: *): *

public

getNamespaceDocs(namespace: *): *

public

getOpDocById(opId: string): *

Returns the op documentation object for an op

public

getOpDocByName(opName: string): *

Returns the op documentation object for an op

public

getOpDocs(): *

public

getPortDoc(op_docs: *, portname: *, type: *): *

public

getPortDocText(port: object, opDoc: object): string

Checks for the existence of a documentation text for the port with name port.name

public

getStats(): {"countCoreOps": *, "countTeamOps": *, "countExtensionOps": *, "countUserOps": *}

public

getSummary(opname: *): number

public
public

parseMarkdown(mdText: *): *

public

removeOpDoc(opDoc: *)

public

setPortDocTexts(ports: object, opDoc: object)

Sets a text property for each port with the documentation

public

showPortDoc(opname: *, portname: *)

Public Constructors

public constructor() source

Public Members

public coreLibs: *[] source

public libs: *[] source

Private Members

private _extensions: *[] source

private _log: * source

private _opDocs: *[] source

private _teamnamespaces: *[] source

Public Methods

public addCoreOpDocs() source

public addOpDocs(opDocs: *[]) source

Params:

NameTypeAttributeDescription
opDocs *[]
  • optional
  • default: []

public addTypeStringToPorts(ports: array) source

Creates a "typeString" attribute for each port-object in the array (e.g. "Value")

Params:

NameTypeAttributeDescription
ports array

Array of port objects with a "type" attribute

public checkDefaultOpsOutdated() source

public extendOpDocs(_opDocs: array) source

Adds some properties to each doc in the op docs array

Params:

NameTypeAttributeDescription
_opDocs array

The array of op docs

public getAll(): * source

Return:

*

public getAttachmentFiles(opname: *): *[] source

Params:

NameTypeAttributeDescription
opname *

Return:

*[]

public getExtensions(): * source

Return:

*

public getHtml(opName: string, collectionInfo: *): * source

Returns the documentation for an op as Html

Params:

NameTypeAttributeDescription
opName string

The name of the op to get the documentation as Html for

collectionInfo *

Return:

*

public getLayoutSvg(opname: *): * source

Params:

NameTypeAttributeDescription
opname *

Return:

*

public getNamespaceDocs(namespace: *): * source

Params:

NameTypeAttributeDescription
namespace *

Return:

*

public getOpDocById(opId: string): * source

Returns the op documentation object for an op

Params:

NameTypeAttributeDescription
opId string

Return:

*

public getOpDocByName(opName: string): * source

Returns the op documentation object for an op

Params:

NameTypeAttributeDescription
opName string

Complete op name (long form), e.g. "Ops.Value"

Return:

*

public getOpDocs(): * source

Return:

*

public getPortDoc(op_docs: *, portname: *, type: *): * source

Params:

NameTypeAttributeDescription
op_docs *
portname *
type *

Return:

*

public getPortDocText(port: object, opDoc: object): string source

Checks for the existence of a documentation text for the port with name port.name

Params:

NameTypeAttributeDescription
port object

The port-object containing a name property to look for

opDoc object

The doc object of the op

Return:

string

The documeentation for the port as html (markdown parsed)

public getStats(): {"countCoreOps": *, "countTeamOps": *, "countExtensionOps": *, "countUserOps": *} source

Return:

{"countCoreOps": *, "countTeamOps": *, "countExtensionOps": *, "countUserOps": *}

public getSummary(opname: *): number source

Params:

NameTypeAttributeDescription
opname *

Return:

number

public getTeamNamespaces(): * source

Return:

*

public parseMarkdown(mdText: *): * source

Params:

NameTypeAttributeDescription
mdText *

Return:

*

public removeOpDoc(opDoc: *) source

Params:

NameTypeAttributeDescription
opDoc *

public setPortDocTexts(ports: object, opDoc: object) source

Sets a text property for each port with the documentation

Params:

NameTypeAttributeDescription
ports object

Array-like object with ports

opDoc object

The op doc

public showPortDoc(opname: *, portname: *) source

Params:

NameTypeAttributeDescription
opname *
portname *