Typedef

Static Public Summary
public	AddOpOptions: *
public	AnimLineOptions: *
public	BindingObject: *
public	CablesTheme: *
public	CanvasContext: *
public	CanvasPointEditorOptions: *
public	ClickedPort: *
public	CommandPaletteOptions: *
public	ContextMenuItem: *
public	ContextMenuParams: *
public	DialogOptions: *
public	EditorOptions: *
public	EditorSessionOptions: *
public	GizmoParams: *
public	GlRectInstancerOptions: Object
public	GlRectOptions: Object
public	GlSplineObject: *
public	GlTextWriterOptions: Object
public	GotoOpOptions: *
public	KeyObject: *
public	KeyOptions: *
public	LinkObject: *
public	LinterDiag: Object
public	ModalDialogButton: Object
public	ModalDialogCheckbox: Object
public	ModalDialogOptions: Object configuration object for a modal dialog
public	ModalErrorException: *
public	ModalErrorOptions: *
public	NewOpOptions: *
public	NotificationDisplayOptions: Object configuration object for loading a patch
public	OpCredit: import("cables-shared-client").OpCredit
public	OpDependency: import("cables-shared-client").OpDependency
public	OpDoc: import("cables-shared-client").OpDoc
public	OpDoc: import("cables-shared-client").OpDoc
public	OpDoc: import("cables-shared-client").OpDoc
public	OpDoc: import("cables-shared-client").OpDoc
public	OpDoc: import("cables-shared-client").OpDoc
public	OpDoc: import("cables-shared-client").OpDoc
public	OpDoc: import("cables-shared-client").OpDoc
public	OpSearchListItem: *
public	OpSelectOptions: *
public	PatchStructureItem: *
public	PatchStructureQueryIncludeOptions: *
public	PatchStructureQueryOnlyOptions: *
public	PatchStructureQueryOptions: *
public	PlatformConfig: *
public	PlatformFrontendOptions: *
public	PortChildren: {portOut: any, children: UiOp[]}
public	SpreadSheetOptions: *
public	SuggestionItem: *
public	TabOptions: import("./tab.js").TabOptions
public	TabOptions: import("./tab.js").TabOptions
public	TabOptions: *
public	TabPanelOptions: *
public	TlConfig: *
public	TlTitleOptions: object
public	User: *
public	VizLayerItem: *
public	VizLayerOptions: *
public	VizTextOptions: *
public	cbData: *
public	theme_colors_html: *
public	theme_colors_namespaces: Object<string, Number[]>
public	theme_colors_objtypes: Object<string, Number[]>
public	theme_colors_patch: *
public	theme_colors_timeline: *
public	theme_colors_types: *
public	theme_colors_vizlayer: *
public	theme_patch: *
public	theme_textedit: Number

Static Public

public AddOpOptions: * source

Properties:

Name	Type	Attribute	Description
subPatch	string	optional
createdLocally	string	optional
linkNewOpToPort	Port	optional
linkNewLink	Object	optional
linkNewOpToOp	UiOp	optional
linkOnlyFirstPort	boolean	optional
onOpAdd	AddOpCallback	optional
uiAttribs	import("cables/src/core/core_patch.js").OpUiAttribs	optional

public AnimLineOptions: * source

Properties:

Name	Type	Attribute	Description
title	string	optional
keyYpos	boolean	optional
multiAnims	boolean	optional
parentEle	HTMLElement	optional

public BindingObject: * source

Properties:

Name	Type	Attribute	Description
title	String
category	String
id	String
default	function
func	function

public CablesTheme: * source

Properties:

Name	Type	Attribute	Description
colors_types	theme_colors_types
colors_objtypes	theme_colors_objtypes
colors_namespaces	theme_colors_namespaces
textedit	theme_textedit
colors_timeline	theme_colors_timeline
colors_patch	theme_colors_patch
colors_html	theme_colors_html
patch	theme_patch
colors_vizlayer	theme_colors_vizlayer

public CanvasContext: * source

Properties:

Name	Type	Attribute	Description
cg	CgContext	optional
id	string
title	string
canvasUi	CanvasUi	optional
canvas	HTMLCanvasElement

public CanvasPointEditorOptions: * source

Properties:

Name	Type	Attribute	Description
openerEle	HTMLElement
template	string	optional

public ClickedPort: * source

Properties:

Name	Type	Attribute	Description
port	Port	optional
title	String
id	String
opid	String
order	number
size	String

public CommandPaletteOptions: * source

Properties:

Name	Type	Attribute	Description
cablesCommands	boolean	optional
showCategory	boolean	optional
showIcons	boolean	optional
commands	import("../commands/commands.js").CommandObject[]	optional

public ContextMenuItem: * source

Properties:

Name	Type	Attribute	Description
title	String
iconClass	String	optional
iconText	String	optional
func	Function

public ContextMenuParams: * source

Properties:

Name	Type	Attribute	Description
items	Array<ContextMenuItem>
title	String	optional
iconClass	String	optional	// * @property {Function} func

public DialogOptions: * source

Properties:

Name	Type	Attribute	Description
title	string
shortName	string
type	string
suggestedNamespace	string
showReplace	boolean
rename	boolean
sourceOpName	string
hasOpDirectories	boolean

public EditorOptions: * source

Properties:

Name	Type	Attribute	Description
title	string	optional
name	string	optional
dataId	string	optional
syntax	string	optional
singleton	boolean	optional
allowEditReason	string	optional
content	string	optional
showSaveButton	boolean	optional
hideFormatButton	boolean	optional
loading	boolean	optional
allowEdit	boolean	optional
editorObj	import("../elements/tabpanel/editor_session.js").EditorSessionOptions	optional
onClose	function	optional
onSave	function	optional
onFinished	function	optional

public EditorSessionOptions: * source

Properties:

Name	Type	Attribute	Description
type	string
data	object
name	string

public GizmoParams: * source

Properties:

Name	Type	Attribute	Description
posX	Port
posY	Port
posZ	Port

public GlRectInstancerOptions: Object source

Properties:

Name	Type	Attribute	Description
name	String	optional
initNum	Number	optional
allowDragging	boolean	optional
hoverWhenButton	boolean	optional

public GlRectOptions: Object source

Properties:

Name	Type	Attribute	Description
name	String
interactive	Boolean
draggable	Boolean	optional
parent	GlRect	optional

public GlSplineObject: * source

Properties:

Name	Type	Attribute	Description
name	string
points	number[]
color	number[]
colorInactive	number[]
colorBorder	number[]
origPoints;	number[]
speed	number
index	number
startOffset	number
hidden	boolean
pointsNeedProgressUpdate	boolean
deleted	boolean

public GlTextWriterOptions: Object source

Properties:

Name	Type	Attribute	Description
name	String	optional
initNum	Number	optional

public GotoOpOptions: * source

Properties:

Name	Type	Attribute	Description
focusAnim	boolean	optional default: true
showParams	boolean	optional default: false
center	boolean	optional default: true
zoom	boolean	optional default: false
unselectAll	boolean	optional

public KeyObject: * source

Properties:

Name	Type	Attribute	Description
pos	number
r	number
g	number
b	number
a	number
posy	number
ele	HTMLElement

public KeyOptions: * source

Properties:

Name	Type	Attribute	Description
minRestriction	number	optional
displayGroup	string	optional
cmdCtrl	boolean	optional
shiftKey	boolean	optional
altKey	boolean	optional
ignoreInput	boolean	optional

public LinkObject: * source

Properties:

Name	Type	Attribute	Description
in	Port
out	Port

public LinterDiag: Object source

Properties:

Name	Type	Attribute	Description
message	string
line	number
column	number	optional
severity	number	optional
fatal	boolean	optional

public ModalDialogButton: Object source

Properties:

Name	Type	Attribute	Description
text	String	optional
cssClasses	String	optional
disabled	Boolean	optional default: false
callback	ModalDialogSubmitCallback	optional

public ModalDialogCheckbox: Object source

Properties:

Name	Type	Attribute	Description
name	string
value	any
checked	boolean
disabled	boolean
tooltip	string
title	string

public ModalDialogOptions: Object source

configuration object for a modal dialog

Properties:

Name	Type	Attribute	Description
html	String	optional	html content
title	String	optional	a title of the dialog
text	String	optional
footer	String	optional
notices	String[]	optional
okButton	ModalDialogButton	optional
cancelButton	ModalDialogButton	optional
nopadding	Boolean	optional default: false	remove padding around the window
warning	Boolean	optional default: false	show a warning triangle
showOkButton	Boolean	optional default: false	show a ok button to close the dialog
prompt	Boolean	optional default: false	show an input field to enter a value
promptValue	String	optional
promptSelectText	Boolean	optional default: false	select the text of the input field when shown
promptOk	ModalPromptCallback	optional
choice	Boolean	optional default: false	show ok/cancel buttons with onSubmit and onClosed callbacks
checkboxGroups	{title: string, checkboxes: ModalDialogCheckbox[]}[]	optional
notices	string[]	optional
footer	string	optional
persistInIdleMode	boolean	optional default: false

public ModalErrorException: * source

Properties:

Name	Type	Attribute	Description
cause	string	optional	indicates a failing op, format "opId:<id>"
error	Error	optional	wrapped underlying error, used instead of the exception itself when set
message	string	optional
stack	string	optional
customMessage	string	optional	extra message appended below the stacktrace

public ModalErrorOptions: * source

Properties:

Name	Type	Attribute	Description
title	string	optional	will replace title
text	string	optional
codeText	string	optional	will be shown as monospace font
op	UiOp	optional	will add an "edit op" button
opname	string	optional	will show opname
exception	ModalErrorException	optional	will show stacktrace and exception message
triggerStack	string	optional

public NewOpOptions: * source

Properties:

Name	Type	Attribute	Description
linkNewLink	Link	optional
linkNewOpToPort	Port	optional

public NotificationDisplayOptions: Object source

configuration object for loading a patch

Properties:

Name	Type	Attribute	Description
timeout	Number \| Boolean	optional default: 2000	fade out notification after x ms, `false` to disable
closeable	Boolean	optional default: false	show closing button on notification
force	Boolean	optional default: false	force showing of notification even if last one was the same

public OpCredit: import("cables-shared-client").OpCredit source

public OpDependency: import("cables-shared-client").OpDependency source

public OpDoc: import("cables-shared-client").OpDoc source

public OpSearchListItem: * source

Properties:

Name	Type	Attribute	Description
opId	string \| number		simpleId if op has no doc
name	string		full op name, e.g. Ops.Math.Sum
summary	string
description	string	optional	collections only
collectionOpNames	string	optional	lowercase, space separated op names of a collection
nscolor	string		namespace css class name
isOp	boolean		false for collections
userOp	boolean
devOp	boolean
extensionOp	boolean
teamOp	boolean
patchOp	boolean
isExtension	boolean
isTeamNamespace	boolean
isCollection	boolean
shortName	string
nameSpace	string
namespaces	string[]		all parent namespaces, e.g. ["Ops.Math"]
oldState	string		"", "OLD" or "DEPREC"
lowercasename	string
buttonText	string
type	string		"op", "team", "extension" or "patchop"
pop	number		popularity
teamName	string	optional	collections only
teamLink	string	optional	collections only
numOps	number	optional	collections only
ops	string[]	optional	collections only
id	number	optional	index in list, set by buildList
old	boolean	optional	deprecated or outdated version
abbrev	string	optional	abbreviation of shortName
_summary	string	optional	lowercase search cache
_shortName	string	optional	lowercase search cache
_lowerCaseName	string	optional	lowercase search cache
_nameSpace	string	optional	lowercase search cache
_nameSpaceFull	string	optional	lowercase search cache
score	number	optional	search score
scoreDebug	string	optional	html explaining the score
element	HTMLElement	optional	result element in opselect
elementHidden	boolean	optional

public OpSelectOptions: * source

Properties:

Name	Type	Attribute	Description
search	string	optional
x	number	optional
y	number	optional
subPatch	string \| number	optional
onOpAdd	Function	optional
autoLinkCurrentOp	boolean	optional

public PatchStructureItem: * source

Properties:

Name	Type	Attribute	Description
title	string	optional
id	string	optional
order	string \| number	optional
childs	array	optional
icon	string	optional
rowClass	string	optional
iconBgColor	string	optional
subPatchId	string \| number	optional
subPatchVer	number	optional

public PatchStructureQueryIncludeOptions: * source

Properties:

Name	Type	Attribute	Description
include.all	boolean	optional
include.areas	boolean	optional
include.comments	boolean	optional
include.customOps	boolean	optional
include.commented	boolean	optional
include.bookmarks	boolean	optional
include.uierrors	boolean	optional
include.animated	boolean	optional
include.selected	boolean	optional
include.colored	boolean	optional
include.subpatches	boolean	optional
include.portsAnimated	boolean	optional

public PatchStructureQueryOnlyOptions: * source

Properties:

Name	Type	Attribute	Description
include.selected	boolean	optional

public PatchStructureQueryOptions: * source

Properties:

Name	Type	Attribute	Description
include	PatchStructureQueryIncludeOptions	optional
only	PatchStructureQueryOnlyOptions	optional
removeEmptySubpatches	boolean	optional
includeUnsavedIndicator	boolean	optional

public PlatformConfig: * source

Properties:

Name	Type	Attribute	Description
usersettings	Object	optional
usersettings.settings	Object	optional
patch	Object
patch.settings	Object	optional
patch.ui	Object	optional
patch.settings.manualScreenshot	Boolean	optional
isTrustedPatch	Boolean	optional
patchConfig	Object	optional
patchConfig.prefixAssetPath	String	optional
urlCables	String	optional
urlSandbox	String	optional
previewMode	Boolean	optional
patchVersion	String	optional
socketcluster	Object	optional
isDevEnv	Boolean	optional
user	Object	optional
communityUrl	String	optional	used in electron, url to community cables.gl instance
paths	Object	optional	used in electron, local filesystem paths
currentPatchDir	String	optional	used in electron, directory of currently opened patch
description	String	optional

public PlatformFrontendOptions: * source

Properties:

Name	Type	Attribute	Description
showLocalOpDirButton	boolean	optional
opDeleteInEditor	boolean	optional
showExport	boolean	optional
showExportPatch	boolean	optional
showPatchBackups	boolean	optional
showMyLinks	boolean	optional
showAssetUpload	boolean	optional
showPatchSettings	boolean	optional
showPatchViewPage	boolean	optional
showChangeLogLink	boolean	optional
showBuildInfoMenuLink	boolean	optional
hasOpDirectories	boolean	optional
showWelcome	boolean	optional
showOpenPatch	boolean	optional

public PortChildren: {portOut: any, children: UiOp[]} source

public SpreadSheetOptions: * source

Properties:

Name	Type	Attribute	Description
title	string	optional
numColumns	number	optional
onchange	function	optional
colNames	string[]	optional
cells	[string[]]	optional

public SuggestionItem: * source

Properties:

Name	Type	Attribute	Description
name	String	optional
class	String	optional
classNames	Array	optional
id	Number	optional
rot	Number	optional	internal: do not set manually
top	Number	optional	internal: do not set manually
left	Number	optional	internal: do not set manually
shortName	String	optional	internal: do not set manually
classname	String	optional	class
p	Port	optional	port
op	Op	optional	op id
spacing	Number	optional	extra spacing
isBoundToVar	Boolean	optional
cb	Function	optional	[callback]
createSpOpPort	Boolean	optional

public TabOptions: import("./tab.js").TabOptions source

public TabOptions: * source

Properties:

Name	Type	Attribute	Description
name	String	optional
singleton	boolean	optional
closable	boolean	optional
hideToolbar	boolean	optional
showTitle	boolean	optional
padding	boolean	optional
tabPanel	TabPanel	optional
dataId	string	optional
icon	string	optional
infotext	string	optional

public TabPanelOptions: * source

Properties:

Name	Type	Attribute	Description
name	String	optional
closable	boolean	optional
noUserSetting	boolean	optional	does not store last opened tab in userSettings

public TlConfig: * source

Properties:

Name	Type	Attribute	Description
fps	Number
fadeInFrames	Boolean	optional
showBeats	Boolean	optional
displayUnits	String	optional
restrictToFrames	Boolean	optional

public TlTitleOptions: object source

Properties:

Name	Type	Attribute	Description
title	String	optional
port	Port	optional
port	Port	optional
animLine	TlAnimLine	optional

public User: * source

Properties:

Name	Type	Attribute	Description
username	string
id	string
usernameLowercase	boolean
supporterFeatures	string[]
isStaff	boolean
isAdmin	boolean
isSupporter	boolean
hasWriteRights	boolean

public VizLayerItem: * source

Properties:

Name	Type	Attribute	Description
posX	number
posY	number
screenPosX	number
screenPosY	number
op	UiOp
w	number
h	number

public VizLayerOptions: * source

Properties:

Name	Type	Attribute	Description
x	number
y	number
width	number
height	number
scale	number
useGl	boolean
vizLayer	number
pixelDensity	number

public VizTextOptions: * source

Properties:

Name	Type	Attribute	Description
showWhitespace	boolean
showLineNum	boolean
fontSize	number
zoomText	boolean
wrap	boolean
scroll	number
syntax	string
diagnostics	import("../api/opsserver.js").LinterDiag[]
highlightLines	Object

public cbData: * source

Properties:

Name	Type	Attribute	Description
opId	string	optional
portname	string	optional
opname	string	optional
name	string	optional

public theme_colors_html: * source

Properties:

Name	Type	Attribute	Description
text-color	Number[]

public theme_colors_namespaces: Object<string, Number[]> source

Properties:

Name	Type	Attribute	Description
unknown	Number[]

public theme_colors_objtypes: Object<string, Number[]> source

Properties:

Name	Type	Attribute	Description
default	Number[]

public theme_colors_patch: * source

Properties:

Name	Type	Attribute	Description
opBgRectSelected	Number[]
selected	Number[]		deprecated
selectedBorder	Number[]	optional
selectedCable	Number[]
patchSelectionArea	Number[]
opTitleExt	Number[]
background	Number[]
opBoundsRect	Number[]
opBgRect	Number[]
opErrorWarning	Number[]
opError	Number[]
opErrorHint	Number[]
opNotWorkingCross	Number[]
patchComment	Number[]

public theme_colors_timeline: * source

Properties:

Name	Type	Attribute	Description
background	Number[]
background_hover	Number[]
overview_background	Number[]
overview_bar	Number[]
cursor	Number[]
key_cliparea	Number[]
key_bezier	Number[]
key	Number[]
key_selected	Number[]
spline	Number[]
spline_hover	Number[]
spline_selectedkeys	Number[]
spline_outside	Number[]
spline_outside_hover	Number[]
spline_outside_selectedkeys	Number[]
key_readonly	Number[]
spline_readonly	Number[]
spline_outside_readonly	Number[]
ruler_frames	Number[]
ruler_background	Number[]
ruler_tick	Number[]
ruler_text	Number[]

public theme_colors_types: * source

Properties:

Name	Type	Attribute	Description
trigger	Number[]
trigger_inactive	Number[]
num	Number[]
num_inactive	Number[]
obj	Number[]
obj_inactive	Number[]
string	Number[]
string_inactive	Number[]
array	Number[]
array_inactive	Number[]
dynamic	Number[]

public theme_colors_vizlayer: * source

Properties:

Name	Type	Attribute	Description
colorText	string
colorBackground	string
colorLineNumbers	string

public theme_patch: * source

Properties:

Name	Type	Attribute	Description
selectedOpBorderX	number
selectedOpBorderY	number
cablesCurveY	number
cablesSubDivde	number
opStateIndicatorSize	number
fadeOutDistStart	number
fadeOutFadeDist	number
fadeOutFadeOpacity	number
cableButtonSize	number
cablesWidth	number