Skip to main content

BrowsePanel

Defined in: js-api/src/views/view.ts:740

JS wrapper for the widget implemented in Dart.

Extends​

Constructors​

Constructor​

new BrowsePanel(dart): BrowsePanel

Defined in: js-api/src/views/view.ts:741

Parameters​

ParameterType
dartany

Returns​

BrowsePanel

Overrides​

DartWidget.constructor

Properties​

PropertyModifierTypeDefault valueDescriptionInherited fromDefined in
_functionsprotectedFunc[][]-DartWidget._functionsjs-api/src/widgets/base.ts:218
_propertiesprotectedProperty[][]-DartWidget._propertiesjs-api/src/widgets/base.ts:217
_rootprotectedHTMLElementundefined-DartWidget._rootjs-api/src/u2core/component.ts:666
_u2readonlyComponentStateundefined-DartWidget._u2js-api/src/u2core/component.ts:119
componentMeta?publicComponentMetaBaseundefinedThe registry metadata of the tag that built this component, stamped by the spec renderer — the single source the introspection surface below is generated from.DartWidget.componentMetajs-api/src/u2core/component.ts:114
dartpublicanyundefined-DartWidget.dartjs-api/src/widgets/base.ts:223
factorypublicFunc | nullnullConstructor function. No parameters, returns [Widget].DartWidget.factoryjs-api/src/widgets/base.ts:215
isDetachedpublicbooleanfalseWhether detach has been called.DartWidget.isDetachedjs-api/src/widgets/base.ts:225
propspublicanyundefinedProperty bag over this widget's properties; read and write them by name.DartWidget.propsjs-api/src/widgets/base.ts:220
specProps?publicRecord<string, unknown>undefinedThe props the registry's create was handed, stamped alongside componentMeta: the last resort of the property read below, for a component that keeps a prop under another name or not at all (a create wrapping a bare element). Construction-time values — a live one always wins.DartWidget.specPropsjs-api/src/u2core/component.ts:118
subspublicSubscription[]undefinedSubscriptions cancelled when the widget is detached.DartWidget.subsjs-api/src/widgets/base.ts:222
temppublicanyundefinedContains auxiliary informationDartWidget.tempjs-api/src/widgets/base.ts:212
isRootstaticbooleanfalseA root has no owner by design (a dialog): built with none, it is not reported as owner-missing.DartWidget.isRootjs-api/src/u2core/component.ts:81

Accessors​

aiDescription​

Get Signature​

get aiDescription(): string | null

Defined in: js-api/src/widgets/base.ts:509

AI briefing of the underlying Dart widget.

Returns​

string | null

Set Signature​

set aiDescription(x): void

Defined in: js-api/src/widgets/base.ts:514

A short AI-facing briefing, seeded from the registry's usage or description.

Parameters​
ParameterType
xstring | null
Returns​

void

Inherited from​

DartWidget.aiDescription


ambientAdoption​

Get Signature​

get protected ambientAdoption(): boolean

Defined in: js-api/src/widgets/base.ts:278

A widget wrapper minted inside somebody's effect scope must not be auto-disposed with it.

Returns​

boolean

Inherited from​

DartWidget.ambientAdoption


children​

Get Signature​

get children(): Widget<any>[]

Defined in: js-api/src/widgets/base.ts:313

Parent widget up the DOM tree, or null.

Returns​

Widget<any>[]

Inherited from​

DartWidget.children


localTree​

Get Signature​

get localTree(): TreeViewGroup

Defined in: js-api/src/views/view.ts:745

Returns​

TreeViewGroup


mainTree​

Get Signature​

get mainTree(): TreeViewGroup

Defined in: js-api/src/views/view.ts:746

Returns​

TreeViewGroup


name​

Get Signature​

get name(): string | undefined

Defined in: js-api/src/u2core/component.ts:882

A named control carries its name in the DOM: data-u2-name is the stable automation id selectors, tutorials and agents address the control by — the same attribute the spec renderer stamps on named nodes, so hand-built and spec-built UI share one selector vocabulary. Derived names (an input's label fallback) never stamp — see Component.deriveName.

Returns​

string | undefined

Set Signature​

set name(x): void

Defined in: js-api/src/u2core/component.ts:886

Unique within a spec: the anchor for selection, patches and automation. An accessor pair (not a field), so a platform descendant's own name accessors override it legally (TS2611).

Parameters​
ParameterType
xstring | undefined
Returns​

void

Inherited from​

ColumnGrid.name


parent​

Get Signature​

get parent(): Widget<any> | null

Defined in: js-api/src/widgets/base.ts:310

Parent widget up the DOM tree, or null.

Returns​

Widget<any> | null

Inherited from​

DartWidget.parent


propertyTarget​

Get Signature​

get propertyTarget(): unknown

Defined in: js-api/src/widgets/base.ts:502

The Dart handle: properties are read from and written to the Dart widget.

Returns​

unknown

Inherited from​

DartWidget.propertyTarget


propertyTier​

Get Signature​

get propertyTier(): boolean

Defined in: js-api/src/widgets/base.ts:282

Every property getProperties declares is a bind step, read and written on propertyTarget.

Returns​

boolean

Inherited from​

DartWidget.propertyTier


root​

Get Signature​

get root(): HTMLElement

Defined in: js-api/src/widgets/base.ts:500

Visual root of the Dart widget.

Returns​

HTMLElement

Inherited from​

DartWidget.root


rootId​

Get Signature​

get rootId(): string

Defined in: js-api/src/u2core/component.ts:704

Stable element id, minted (u2-<n>) on first ask unless the root has one: the anchor of for, aria-* and data-u2-owner-id references.

Returns​

string

Inherited from​

DartWidget.rootId


scope​

Get Signature​

get scope(): Scope

Defined in: js-api/src/u2core/component.ts:86

Minted on first use; assigned before _scopeMinted fires, so the hook's own this.scope.own(...) reads the stored scope instead of re-entering the mint. Lazy: counted and tracked only once it owns something, so a static control costs nothing.

Returns​

Scope

Inherited from​

DartWidget.scope


type​

Get Signature​

get type(): string

Defined in: js-api/src/widgets/base.ts:498

Type name the Dart widget reports.

Returns​

string

Inherited from​

DartWidget.type


visible​

Get Signature​

get visible(): boolean

Defined in: js-api/src/u2core/component.ts:694

Hidden ⇔ the root carries the hidden attribute.

Returns​

boolean

Set Signature​

set visible(x): void

Defined in: js-api/src/u2core/component.ts:698

Parameters​
ParameterType
xboolean
Returns​

void

Inherited from​

DartWidget.visible

Methods​

_notifyPropertyChange()​

protected _notifyPropertyChange(p): void

Defined in: js-api/src/widgets/base.ts:360

Notifies the property tier. Called from both the addProperty setter (overrides that skip super would otherwise lose props.x = writes) and onPropertyChanged (direct calls); the double notify collapses into one microtask refresh.

Parameters​

ParameterType
pProperty | null

Returns​

void

Inherited from​

DartWidget._notifyPropertyChange


_ownPropertyChanges()​

protected _ownPropertyChanges(): ObservableLike<PropertyChange>

Defined in: js-api/src/widgets/base.ts:365

Returns​

ObservableLike<PropertyChange>

Inherited from​

DartWidget._ownPropertyChanges


_scopeMinted()​

protected _scopeMinted(_scope): void

Defined in: js-api/src/widgets/base.ts:329

First-mint hook: a platform descendant wires its lifecycle here. Never fired for a scope provided to init — that path runs inside the constructor chain.

Parameters​

ParameterType
_scopeScope

Returns​

void

Inherited from​

DartWidget._scopeMinted


_wireDartLifecycle()​

protected _wireDartLifecycle(): void

Defined in: js-api/src/widgets/base.ts:345

Dart-owned lifecycle: the platform kill disposes the scope, and disposing the scope kills the widget through the kill-walk.

Returns​

void

Inherited from​

DartWidget._wireDartLifecycle


_wireJsLifecycle()​

protected _wireJsLifecycle(): void

Defined in: js-api/src/widgets/base.ts:336

JS-owned lifecycle: disposing the scope detaches the widget, and vice versa.

Returns​

void

Inherited from​

DartWidget._wireJsLifecycle


_wireLifecycle()​

protected _wireLifecycle(): void

Defined in: js-api/src/widgets/base.ts:503

Returns​

void

Inherited from​

DartWidget._wireLifecycle


accessibleLabel()​

protected accessibleLabel(): string | undefined

Defined in: js-api/src/u2core/component.ts:762

The accessible name: aria-label, then the aria-labelledby texts, then this control's own data-u2-part="label" element, then — for a root that is a button — its own text.

Returns​

string | undefined

Inherited from​

DartWidget.accessibleLabel


addProperty()​

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

Defined in: js-api/src/widgets/base.ts:388

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

Parameters​

ParameterTypeDefault valueDescription
propertyNamestringundefined-
propertyType"string" | "bigint" | "object" | "map" | "file" | "bool" | "int" | "double" | "byte_array" | "datetime" | "qnum" | "dataframe" | "num" | "string_list" | "dataframe_list" | "cell" | "column" | "column_list" | "graphics" | "blob" | "tablerowfiltercall" | "colfiltercall" | "bitset" | "dynamic" | "viewer" | "list" | "semantic_value" | "func" | "funccall" | "property" | "categorical" | "numerical" | "GridCellRenderArgs" | "element" | "view" | "TableView" | "User" | "Menu" | "Project" | "event_data" | "progressindicator" | "Credentials" | "ScriptEnvironment" | "Notebook"undefined-
defaultValueanynull-
optionsobject & IProperty | nullnull-

Returns​

any

See​

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

options.get/options.set override how the property reads/writes (instead of the default fieldName field access); the change notification (onPropertyChanged) always fires on write, and a {get}-only options yields a custom read with the default fieldName write.

Inherited from​

DartWidget.addProperty


addStatusProvider()​

addStatusProvider(name, provider): void

Defined in: js-api/src/widgets/base.ts:468

Adds live parts, hit areas and readings to this widget's status. Providers run in registration order on every read; an existing name is replaced in place, and later providers override earlier entries. Coordinates use the widget's own hit-area system. Detaching the widget removes all providers. A subclass that overrides getWidgetStatus composes with super.getWidgetStatus().

Parameters​

ParameterTypeDescription
namestringStable name of the component contributing the status.
providerStatusProviderComputes the contribution each time the status is requested.

Returns​

void

Example​

widget.addStatusProvider('selection', () => ({values: {'selected rows': table.selection.trueCount}}));
console.log(widget.getWidgetStatus().values?.['selected rows']);
widget.removeStatusProvider('selection');
see samples/grid/custom-renderer-status

Inherited from​

DartWidget.addStatusProvider


apply()​

apply(properties): Widget

Defined in: js-api/src/widgets/base.ts:267

Sets each key of properties as the property of that name; returns this widget.

Parameters​

ParameterType
propertiesobject

Returns​

Widget

Inherited from​

DartWidget.apply


bindItemTooltip()​

bindItemTooltip(content, el): void

Defined in: js-api/src/views/view.ts:747

Parameters​

ParameterType
contentstring | Element | (() => string | Element)
elElement

Returns​

void


bindProps()​

bindProps(): BindProp[]

Defined in: js-api/src/u2core/component.ts:492

The signal-backed subset of the meta props — what a binding picker offers on a named node — plus, under propertyTier, every declared property. Allocates no signal.

Returns​

BindProp[]

Inherited from​

DartWidget.bindProps


bindStep()​

bindStep(name): Signal<unknown> | BindSource | null

Defined in: js-api/src/u2core/component.ts:481

One binding step (DD5): a meta-declared prop's same-named Signal member — a named node is a bind source, generated off componentMeta the way getProperties is — then, under propertyTier, a cached signal over the declared property. '' answers the default binding: the component's own value signal, where one exists.

Parameters​

ParameterType
namestring

Returns​

Signal<unknown> | BindSource | null

Inherited from​

DartWidget.bindStep


deriveName()​

protected deriveName(x): void

Defined in: js-api/src/u2core/component.ts:109

Sets the introspection/form key without claiming an automation id — the label-fallback path: a caption is not a stable identity, so it never reaches data-u2-name.

Parameters​

ParameterType
xstring | undefined

Returns​

void

Inherited from​

DartWidget.deriveName


detach()​

detach(): void

Defined in: js-api/src/widgets/base.ts:317

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​

DartWidget.detach


dispose()​

dispose(): void

Defined in: js-api/src/u2core/component.ts:687

Disposes the control; disposed by hand, it also leaves the page — a dead control left on show looks alive. One its owner disposes leaves the DOM to whoever holds it: a region swapping its content, a spec re-rendering.

Returns​

void

Inherited from​

DartWidget.dispose


effect()​

effect(fn): this

Defined in: js-api/src/u2core/component.ts:260

Runs fn now and on every change of the signals it reads, until this component is disposed. Called while a row of each() or an effect run is being built, it belongs on a control built there (input.effect(...)) — on a longer-lived one it piles up with every rebuild, and u2 warns.

Parameters​

ParameterType
fn() => void

Returns​

this

Inherited from​

DartWidget.effect


expandPath()​

expandPath(path): Promise<void>

Defined in: js-api/src/views/view.ts:749

Expands the groups along a slash-separated path of node texts (Platform/Domains/northwind) and selects the node at its end; a path the tree does not hold is ignored.

Parameters​

ParameterType
pathstring

Returns​

Promise<void>


fireEvent()​

protected fireEvent(eventId, args?): void

Defined in: js-api/src/u2core/component.ts:636

Every matching listener runs inside one batch; a throwing one is reported to this component's scope and does not stop the rest.

Parameters​

ParameterType
eventIdstring
args?unknown

Returns​

void

Inherited from​

DartWidget.fireEvent


getDartProperties()​

getDartProperties(): any[]

Defined in: js-api/src/widgets/base.ts:296

Dart handles of the properties that have one.

Returns​

any[]

Inherited from​

DartWidget.getDartProperties


getFunctions()​

getFunctions(): Func[]

Defined in: js-api/src/widgets/base.ts:507

Functions applicable to the Dart widget, as the context menu and the AI assistant see them.

Returns​

Func[]

Inherited from​

DartWidget.getFunctions


getItems()​

getItems(_opts?): IItemsState | undefined

Defined in: js-api/src/u2core/component.ts:737

Items of a collection-like control; undefined for other kinds. list holds the first ITEMS_CAP unless all.

Parameters​

ParameterType
_opts?{ all?: boolean; }
_opts.all?boolean

Returns​

IItemsState | undefined

Inherited from​

DartWidget.getItems


getProperties()​

getProperties(): Property[]

Defined in: js-api/src/widgets/base.ts:505

Properties of the Dart widget.

Returns​

Property[]

Inherited from​

DartWidget.getProperties


getState()​

getState(): IControlState

Defined in: js-api/src/u2core/component.ts:713

The state block generic tests read (DG.U2.state). This base reads the DOM — kind, name, accessible name, aria-disabled, hidden, focus, aria-busy — plus getItems; a subclass adds what the DOM cannot say and spreads super.getState(). Synchronous, side-effect free, never cached.

Returns​

IControlState

Inherited from​

DartWidget.getState


getWidgetStatus()​

getWidgetStatus(): IWidgetStatus

Defined in: js-api/src/widgets/base.ts:432

Returns the widget's runtime structure for automated testing and introspection; state is read off the DOM (kind, label, enabled, visible, focused …), then merged with what providers contribute.

Returns​

IWidgetStatus

Inherited from​

DartWidget.getWidgetStatus


link(name, source, twoWay): void

Defined in: js-api/src/u2core/component.ts:453

Keeps this component's name step and source equal, echo-suppressed by value; the reverse direction only where twoWay. A component that took source as its own signal needs no link and gets none; a read-only step cannot follow anything and gets none either.

Parameters​

ParameterType
namestring
sourceSignal<unknown>
twoWayboolean

Returns​

void

Inherited from​

DartWidget.link


on()​

on(eventId, handler): () => void

Defined in: js-api/src/u2core/component.ts:623

Subscribes handler to onEvent(eventId); it gets the payload and this component. Owned by the ambient scope when there is one (the subscriber's), else by this component; runs as Scope.bind runs a handler. Answers the unsubscribe.

Parameters​

ParameterType
eventIdstring
handler(arg, source) => void

Returns​

() => void

Inherited from​

DartWidget.on


onEvent()​

onEvent(eventId?): Observable<any>

Defined in: js-api/src/widgets/base.ts:522

The platform's events of that id only: the u2 + DOM merge of Widget.onEvent would mint a scope, and register a Dart cleanup, for every toJs wrapper subscribed through.

Parameters​

ParameterTypeDefault value
eventIdstring | nullnull

Returns​

Observable<any>

Inherited from​

DartWidget.onEvent


onFrameAttached()​

onFrameAttached(dataFrame): void

Defined in: js-api/src/widgets/base.ts:304

Called when a DataFrame is attached; override to bind data.

Parameters​

ParameterType
dataFrameDataFrame

Returns​

void

Inherited from​

DartWidget.onFrameAttached


onPropertyChanged()​

onPropertyChanged(property): void

Defined in: js-api/src/widgets/base.ts:293

Gets called when viewer's property is changed.

Parameters​

ParameterTypeDescription
propertyProperty | nullor null, if multiple properties were changed.

Returns​

void

Inherited from​

DartWidget.onPropertyChanged


own()​

own(dispose): this

Defined in: js-api/src/u2core/component.ts:267

Registers a cleanup that runs when this component is disposed.

Parameters​

ParameterType
dispose() => void

Returns​

this

Inherited from​

DartWidget.own


propertyChanges()​

protected propertyChanges(): ObservableLike<PropertyChange>

Defined in: js-api/src/widgets/base.ts:375

What refreshes the property tier's cached signals from outside: null where nothing announces a change (one-way).

Returns​

ObservableLike<PropertyChange>

Inherited from​

DartWidget.propertyChanges


registerFunction()​

protected registerFunction(f): void

Defined in: js-api/src/u2core/component.ts:616

Parameters​

ParameterType
fFuncLike

Returns​

void

Inherited from​

DartWidget.registerFunction


removeStatusProvider()​

removeStatusProvider(name): void

Defined in: js-api/src/widgets/base.ts:477

Removes the status contribution registered under name; an absent name is a no-op.

Parameters​

ParameterTypeDescription
namestringThe name passed to addStatusProvider.

Returns​

void

Example​

widget.removeStatusProvider('selection');
see samples/grid/custom-renderer-status

Inherited from​

DartWidget.removeStatusProvider


revealItem()​

revealItem(keyOrLabel): Promise<HTMLElement | null>

Defined in: js-api/src/u2core/component.ts:746

Brings the item into view and resolves to its element, or null when none matches: the exact key (data-u2-item) first, then the label, trimmed and case-insensitive. Several label matches reject, naming the candidates. This base searches the rendered [data-u2-item] elements under the root and in the popups it owns; a virtual or collapsible control overrides it to scroll or expand first.

Parameters​

ParameterType
keyOrLabelstring

Returns​

Promise<HTMLElement | null>

Inherited from​

DartWidget.revealItem


runInScope()​

runInScope<T>(fn): T

Defined in: js-api/src/u2core/component.ts:253

Runs fn with this component's scope ambient: what it builds is owned by this component.

Type Parameters​

Type Parameter
T

Parameters​

ParameterType
fn() => T

Returns​

T

Deprecated​

Use the owner verb build(fn) (OwnerVerbs.build): this.build(fn), dialog.build(fn).

Inherited from​

DartWidget.runInScope


sourceRowsChanged()​

sourceRowsChanged(): void

Defined in: js-api/src/widgets/base.ts:301

Called when the rows the widget shows change; override to refresh.

Returns​

void

Inherited from​

DartWidget.sourceRowsChanged


sub()​

sub(subscription): void

Defined in: js-api/src/widgets/base.ts:261

Registers a subscription to an external event.

Parameters​

ParameterType
subscriptionSubscription

Returns​

void

Inherited from​

DartWidget.sub


subscribe()​

subscribe<T>(source, handler): () => void

Defined in: js-api/src/u2core/component.ts:1040

Subscribes handler to source until this owner is disposed. See Scope.subscribe.

Type Parameters​

Type Parameter
T

Parameters​

ParameterType
sourceObservableLike<T>
handler(value) => void

Returns​

() => void

Inherited from​

OwnerVerbs.subscribe


task()​

task<R>(fn, options?): TaskRun

Defined in: js-api/src/u2core/component.ts:1038

Async work owned here. See Scope.task.

Type Parameters​

Type Parameter
R

Parameters​

ParameterType
fn(t) => R | PromiseLike<R>
options?TaskOptions

Returns​

TaskRun

Inherited from​

OwnerVerbs.task


toDart()​

toDart(): any

Defined in: js-api/src/widgets/base.ts:254

The Dart handle of this widget, created on first use.

Returns​

any

Inherited from​

DartWidget.toDart


_isPlain()​

protected static _isPlain(x): x is Record<string, unknown>

Defined in: js-api/src/u2core/component.ts:244

Parameters​

ParameterType
xunknown

Returns​

x is Record<string, unknown>

Inherited from​

DartWidget._isPlain


build()​

Call Signature​

static build(builder, options?): Control

Defined in: js-api/src/u2core/component.ts:943

The function component component makes, under its old name.

Parameters​
ParameterType
builder(self) => BuiltRoot
options?ControlBuildOptions
Returns​

Control

Deprecated​

Use component: one spelling, apart from an owner's build(fn).

Inherited from​

DartWidget.build

Call Signature​

static build<R>(builder, options?): never

Defined in: js-api/src/u2core/component.ts:944

The function component component makes, under its old name.

Type Parameters​
Type Parameter
R extends BuiltHandle
Parameters​
ParameterType
builder(self) => R
options?ControlBuildOptions
Returns​

never

Deprecated​

Use component: one spelling, apart from an owner's build(fn).

Inherited from​

DartWidget.build


find()​

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

Defined in: js-api/src/widgets/base.ts:243

Finds existing widget from its visual root.

Parameters​

ParameterType
rootElement

Returns​

Widget<any> | null

Inherited from​

DartWidget.find


forElement()​

static forElement(el): Control | undefined

Defined in: js-api/src/u2core/component.ts:904

The nearest control owning el — the DOM → component door for tooling, automation and inspectors (the u2 counterpart of the platform's Widget.find): the nearest root at or above el, else, inside a popup portaled to the body, the popup's owner (data-u2-owner-id). Best-effort: the last control constructed on (or assigned) a root wins it. The root carries the control under Symbol.for('u2.control'), so every engine copy on the page answers alike.

Parameters​

ParameterType
elElement | null

Returns​

Control | undefined

Inherited from​

DartWidget.forElement


fromRoot()​

static fromRoot(root): Widget

Defined in: js-api/src/widgets/base.ts:483

Creates a new widget from the root element.

Parameters​

ParameterType
rootHTMLElement

Returns​

Widget

Inherited from​

DartWidget.fromRoot


getAll()​

static getAll(): Widget<any>[]

Defined in: js-api/src/widgets/base.ts:238

Returns all currently active widgets.

Returns​

Widget<any>[]

Inherited from​

DartWidget.getAll


init()​

static init(self, scope?): void

Defined in: js-api/src/u2core/component.ts:126

Per-instance state, for a constructed component and for an adopted platform object alike.

Parameters​

ParameterType
selfComponent
scope?Scope

Returns​

void

Inherited from​

DartWidget.init


is()​

static is(x): x is Control

Defined in: js-api/src/u2core/component.ts:915

Structural probe by methods only — never .scope: the accessor mints.

Parameters​

ParameterType
xunknown

Returns​

x is Control

Inherited from​

DartWidget.is


jsonValue()​

static jsonValue(x, depth?): JsonValue | undefined

Defined in: js-api/src/u2core/component.ts:826

The JSON-safe projection behind IControlState.value: a Date → its ISO string, an object with a string name (an entity, a column) → the name, arrays and sets element-wise, plain objects key-wise (depth 4), a signal → its current value; functions and elements → undefined; anything else → String(x).

Parameters​

ParameterTypeDefault value
xunknownundefined
depthnumber0

Returns​

JsonValue | undefined

Inherited from​

DartWidget.jsonValue


labelOf()​

protected static labelOf(el): string | undefined

Defined in: js-api/src/u2core/component.ts:775

aria-label, else the joined texts of the aria-labelledby elements; undefined when neither names el.

Parameters​

ParameterType
elElement

Returns​

string | undefined

Inherited from​

DartWidget.labelOf


registerCleanup()​

static registerCleanup(element, cleanup): void

Defined in: js-api/src/widgets/base.ts:249

Registers a cleanup function to run when [element] is killed — i.e. when its host view or pane closes. Also marks the element so the kill-walk can find it.

Parameters​

ParameterType
elementElement
cleanupCallback

Returns​

void

Inherited from​

DartWidget.registerCleanup


sameValue()​

static sameValue(a, b): boolean

Defined in: js-api/src/u2core/component.ts:232

The equality the property tier and link suppress echoes by: Object.is, arrays element-wise, plain objects key-wise (recursive), everything else by identity.

Parameters​

ParameterType
aunknown
bunknown

Returns​

boolean

Inherited from​

DartWidget.sameValue


text()​

protected static text(el): string

Defined in: js-api/src/u2core/component.ts:789

The text the user reads: trimmed, single-spaced.

Parameters​

ParameterType
elElement

Returns​

string

Inherited from​

DartWidget.text