Home Reference Source

Function

Static Public Summary
public

filemanager - dragging and dropping files handler/listener

public

PatchConnectionReceiver(patch: *, options: *, connector: *)

public
public
public

bytesArrToBase64(arr: *): *

public

convertPorts(p1: *, p2: *, converter: *)

public

createEditor(options: *): *

public

escapeHTML(string: *): *

public
public

getConverters(p1: Port, p2: Port): *

public

getHandleBarHtml(name: string, obj: object): *

public

handleBarPrecompiled(name: *): *

public
public

hideNotificaton(toastId: *)

public
public
public

notify(title: *, text: *, options: NotificationDisplayOptions): *

notify displays a toast-notification

public

notifyError(title: *, text: *, options: NotificationDisplayOptions): *

notifyError displays an error as a toast-notification

public

notifyWarn(title: *, text: string, options: {}): *

public

handle global html events like uncaught exceptions, contextmenu, resize etc

public

setUpTheme(theme: {}): *

public

showInfo(txt: *, param: *)

public

showShaderError(shader: *)

public

showShaderErrorCgp(shader: CgpShader, nfo: GPUCompilationInfo)

public

showToolTip(e: object, txt: string, nopadding: boolean)

public
public

startUi(cfg: *)

manage the start of the ui/editor

public

updateHoverToolTip(event: MouseEvent, port: import("cables").Port, overlink: boolean | import("../glpatch/gllink.js").default)

public

valueChanger(eleId: *, focus: *, portName: *, opid: *)

mouse and keyboard interactions with port parameters

Static Public

public DragNDrop() source

filemanager - dragging and dropping files handler/listener

public PatchConnectionReceiver(patch: *, options: *, connector: *) source

import {PatchConnectionReceiver} from './ui/socketcluster/patchconnection.js'

Params:

NameTypeAttributeDescription
patch *
options *
connector *

public PatchConnectionSender(patch: *) source

import {PatchConnectionSender} from './ui/socketcluster/patchconnection.js'

Params:

NameTypeAttributeDescription
patch *

public PatchConnectorBroadcastChannel() source

import {PatchConnectorBroadcastChannel} from './ui/socketcluster/patchconnection.js'

public bytesArrToBase64(arr: *): * source

import {bytesArrToBase64} from './ui/api/patchserverapi.js'

Params:

NameTypeAttributeDescription
arr *

Return:

*

public convertPorts(p1: *, p2: *, converter: *) source

import {convertPorts} from './ui/components/converterops.js'

Params:

NameTypeAttributeDescription
p1 *
p2 *
converter *

public createEditor(options: *): * source

import {createEditor} from './ui/components/editor.js'

Params:

NameTypeAttributeDescription
options *

Return:

*

public escapeHTML(string: *): * source

import {escapeHTML} from './ui/utils/helper.js'

Params:

NameTypeAttributeDescription
string *

Return:

*

public extendCoreAnim() source

public getConverters(p1: Port, p2: Port): * source

import {getConverters} from './ui/components/converterops.js'

Params:

NameTypeAttributeDescription
p1 Port
p2 Port

Return:

*

public getHandleBarHtml(name: string, obj: object): * source

import {getHandleBarHtml} from './ui/utils/handlebars.js'

Params:

NameTypeAttributeDescription
name string
obj object

Return:

*

public handleBarPrecompiled(name: *): * source

import {handleBarPrecompiled} from './ui/utils/handlebars.js'

Params:

NameTypeAttributeDescription
name *

Return:

*

public hideInfo() source

import {hideInfo} from './ui/elements/tooltips.js'

public hideNotificaton(toastId: *) source

import {hideNotificaton} from './ui/elements/notification.js'

Params:

NameTypeAttributeDescription
toastId *

public hideToolTip() source

import {hideToolTip} from './ui/elements/tooltips.js'

public initSplitPanes() source

import initSplitPanes from './ui/elements/splitpane.js'

public notify(title: *, text: *, options: NotificationDisplayOptions): * source

import {notify} from './ui/elements/notification.js'

notify displays a toast-notification

Params:

NameTypeAttributeDescription
title *
text *
options NotificationDisplayOptions

The option object.

Return:

*

Example:

notify("update", "cables has been updated",
{
    "timeout": 1000,
    "closeable": false
});

public notifyError(title: *, text: *, options: NotificationDisplayOptions): * source

import {notifyError} from './ui/elements/notification.js'

notifyError displays an error as a toast-notification

Params:

NameTypeAttributeDescription
title *
text *
options NotificationDisplayOptions

The option object.

Return:

*

Example:

notifyError("error", "something broke",
{
    "timeout": false,
    "closeable": true,
});

public notifyWarn(title: *, text: string, options: {}): * source

import {notifyWarn} from './ui/elements/notification.js'

Params:

NameTypeAttributeDescription
title *
text string
  • optional
  • default:
options {}
  • optional
  • default: {}

Return:

*

public setHtmlDefaultListeners() source

import setHtmlDefaultListeners from './ui/components/htmldefaultlisteners.js'

handle global html events like uncaught exceptions, contextmenu, resize etc

public setUpTheme(theme: {}): * source

import {setUpTheme} from './ui/theme.js'

Params:

NameTypeAttributeDescription
theme {}
  • optional
  • default: {}

Return:

*

public showInfo(txt: *, param: *) source

import {showInfo} from './ui/elements/tooltips.js'

Params:

NameTypeAttributeDescription
txt *
param *

public showShaderError(shader: *) source

import {showShaderError} from './ui/dialogs/modalshadererrorgl.js'

Params:

NameTypeAttributeDescription
shader *

public showShaderErrorCgp(shader: CgpShader, nfo: GPUCompilationInfo) source

import {showShaderErrorCgp} from './ui/dialogs/modalshadererrorcgp.js'

Params:

NameTypeAttributeDescription
shader CgpShader
nfo GPUCompilationInfo

public showToolTip(e: object, txt: string, nopadding: boolean) source

import {showToolTip} from './ui/elements/tooltips.js'

Params:

NameTypeAttributeDescription
e object
txt string
nopadding boolean
  • optional

public startIdleListeners() source

import startIdleListeners from './ui/components/idlemode.js'

public startUi(cfg: *) source

import startUi from './ui/startgui.js'

manage the start of the ui/editor

Params:

NameTypeAttributeDescription
cfg *

public updateHoverToolTip(event: MouseEvent, port: import("cables").Port, overlink: boolean | import("../glpatch/gllink.js").default) source

import {updateHoverToolTip} from './ui/elements/tooltips.js'

Params:

NameTypeAttributeDescription
event MouseEvent
port import("cables").Port
overlink boolean | import("../glpatch/gllink.js").default

public valueChanger(eleId: *, focus: *, portName: *, opid: *) source

mouse and keyboard interactions with port parameters

Params:

NameTypeAttributeDescription
eleId *
focus *
portName *
opid *