abstract FuncCallEditor

Base class for widgets or views that serve as editors for FuncCall. Extend it and use it in editor functions. Editor functions should return an implementation of this class for the platform to handle validation correctly. An editor function can be attached to another function using the editor tag: editor: Plugin:EditorFuncName.

Extends

• Widget

Constructors

new FuncCallEditor()

new FuncCallEditor(widgetRoot): FuncCallEditor

Parameters

Parameter	Type
widgetRoot	HTMLElement

Returns

FuncCallEditor

Inherited from

Widget . constructor

Constructs

Widget and initializes its root.

Source

src/widgets.ts:219

Properties

Property	Modifier	Type	Default value	Description	Inherited from
_functions	protected	Func[]	[]	-	Widget._functions
_properties	protected	Property[]	[]	-	Widget._properties
_root	protected	HTMLElement	undefined	-	Widget._root
dart	public	any	undefined	-	Widget.dart
factory	public	null | Func	null	Constructor function. No parameters, returns [Widget].	Widget.factory
isDetached	public	boolean	false	-	Widget.isDetached
props	public	any	undefined	-	Widget.props
subs	public	Subscription[]	undefined	-	Widget.subs
temp	public	any	undefined	Contains auxiliary information	Widget.temp

Accessors

children

get children(): Widget<any>[]

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Source

src/widgets.ts:289

---

isValid

get abstract isValid(): boolean

Returns

boolean

Source

src/widgets.ts:357

---

onInputChanged

get abstract onInputChanged(): Observable<any>

Returns

Observable<any>

Source

src/widgets.ts:358

---

parent

get parent(): null | Widget<any>

Parent widget up the DOM tree, or null.

Returns

null | Widget<any>

Source

src/widgets.ts:286

---

root

get root(): HTMLElement

Widget's visual root.

set root(r): void

Parameters

Parameter	Type
r	HTMLElement

Returns

HTMLElement

Source

src/widgets.ts:293

---

type

get type(): string

Returns

string

Source

src/widgets.ts:202

Methods

addProperty()

private addProperty(propertyName, propertyType, defaultValue, options): any

Registers an property with the specified type, name, and defaultValue.

Parameters

Parameter	Type	Default value	Description
propertyName	string	undefined
propertyType	"string" | "bigint" | "object" | "map" | "file" | "view" | "blob" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe" | "num" | "string_list" | "dataframe_list" | "cell" | "column" | "column_list" | "graphics" | "tablerowfiltercall" | "colfiltercall" | "bitset" | "dynamic" | "viewer" | "list" | "semantic_value" | "func" | "funccall" | "property" | "categorical" | "numerical" | "GridCellRenderArgs" | "element" | "TableView" | "User" | "Menu" | "Project" | "event_data" | "progressindicator" | "Credentials" | "ScriptEnvironment" | "Notebook"	undefined
defaultValue	any	null
options	null | object & IProperty	null

Returns

any

Inherited from

Widget . addProperty

See

Registered property gets added to properties. Returns default value, thus allowing to combine registering a property with the initialization

Source

src/widgets.ts:314

---

apply()

apply(properties): Widget<any>

Parameters

Parameter	Type	Description
properties	object

Returns

Widget<any>

Inherited from

Widget . apply

Source

src/widgets.ts:253

---

detach()

detach(): void

Gets called when a widget is detached and will no longer be used. Typically used for unsubscribing from events. Be sure to call super.detach() if this method is overridden.

Returns

void

Inherited from

Widget . detach

Source

src/widgets.ts:298

---

getDartProperties()

getDartProperties(): any[]

Returns

any[]

Inherited from

Widget . getDartProperties

Source

src/widgets.ts:274

---

getFunctions()

getFunctions(): Func[]

Functions that are applicable to this particular widget. Used in the UI to display context actions, and for the AI integrations.

Returns

Func[]

Inherited from

Widget . getFunctions

Source

src/widgets.ts:268

---

getProperties()

getProperties(): Property[]

Returns all properties of this widget.

Returns

Property[]

Inherited from

Widget . getProperties

Source

src/widgets.ts:264

---

inputFor()?

optional inputFor(propertyName): InputBase<any>

Parameters

Parameter	Type
propertyName	string

Returns

InputBase<any>

Source

src/widgets.ts:360

---

onFrameAttached()

onFrameAttached(dataFrame): void

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

Widget . onFrameAttached

Source

src/widgets.ts:280

---

onPropertyChanged()

onPropertyChanged(property): void

Gets called when viewer's property is changed.

Parameters

Parameter	Type	Description
property	null | Property	or null, if multiple properties were changed.

Returns

void

Inherited from

Widget . onPropertyChanged

Source

src/widgets.ts:272

---

sourceRowsChanged()

sourceRowsChanged(): void

Returns

void

Inherited from

Widget . sourceRowsChanged

Source

src/widgets.ts:278

---

sub()

sub(subscription): void

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription

Returns

void

Inherited from

Widget . sub

Source

src/widgets.ts:246

---

toDart()

toDart(): any

Returns

any

Inherited from

Widget . toDart

Source

src/widgets.ts:238

---

find()

static find(root): null | Widget<any>

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

null | Widget<any>

Inherited from

Widget . find

Source

src/widgets.ts:234

---

fromRoot()

static fromRoot(root): Widget<any>

Creates a new widget from the root element.

Parameters

Parameter	Type
root	HTMLElement

Returns

Widget<any>

Inherited from

Widget . fromRoot

Source

src/widgets.ts:337

---

getAll()

static getAll(): Widget<any>[]

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Widget . getAll

Source

src/widgets.ts:229