ColumnGrid

Defined in: js-api/src/grid.ts:1413

Proxy class for the Dart-based column grid.

Extends

• Widget

Constructors

Constructor

new ColumnGrid(dart): ColumnGrid

Defined in: js-api/src/grid.ts:1414

Parameters

Parameter	Type
dart	any

Returns

ColumnGrid

Overrides

Widget.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
_functions	protected	Func[]	[]	-	Widget._functions	js-api/src/widgets/base.ts:214
_properties	protected	Property[]	[]	-	Widget._properties	js-api/src/widgets/base.ts:213
_root	protected	HTMLElement	undefined	-	Widget._root	js-api/src/u2core/component.ts:423
_u2	readonly	ComponentState	undefined	-	Widget._u2	js-api/src/u2core/component.ts:76
componentMeta?	public	ComponentMetaBase	undefined	The registry metadata of the tag that built this component, stamped by the spec renderer — the single source the introspection surface below is generated from.	Widget.componentMeta	js-api/src/u2core/component.ts:71
dart	readonly	any	undefined	-	Widget.dart	js-api/src/grid.ts:1414
factory	public	Func | null	null	Constructor function. No parameters, returns [Widget].	Widget.factory	js-api/src/widgets/base.ts:211
isDetached	public	boolean	false	-	Widget.isDetached	js-api/src/widgets/base.ts:218
props	public	any	undefined	-	Widget.props	js-api/src/widgets/base.ts:215
specProps?	public	Record<string, unknown>	undefined	The 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.	Widget.specProps	js-api/src/u2core/component.ts:75
subs	public	Subscription[]	undefined	-	Widget.subs	js-api/src/widgets/base.ts:216
temp	public	any	undefined	Contains auxiliary information	Widget.temp	js-api/src/widgets/base.ts:208

Accessors

aiDescription

Get Signature

get aiDescription(): string | null

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

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

Returns

string | null

Set Signature

set aiDescription(x): void

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

Parameters

Parameter	Type
x	string | null

Returns

void

Inherited from

Widget.aiDescription

---

ambientAdoption

Get Signature

get protected ambientAdoption(): boolean

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

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

Returns

boolean

Inherited from

Widget.ambientAdoption

---

children

Get Signature

get children(): Widget<any>[]

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

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Inherited from

Widget.children

---

currentColumn

Get Signature

get currentColumn(): Column

Defined in: js-api/src/grid.ts:1515

Returns

Column

---

dfColumns

Get Signature

get dfColumns(): DataFrame

Defined in: js-api/src/grid.ts:1474

Returns

DataFrame

---

dfSource

Get Signature

get dfSource(): DataFrame

Defined in: js-api/src/grid.ts:1475

Returns

DataFrame

---

filter

Get Signature

get filter(): (c) => boolean

Defined in: js-api/src/grid.ts:1480

Returns

(c) => boolean

Set Signature

set filter(f): void

Defined in: js-api/src/grid.ts:1481

Parameters

Parameter	Type
f	(c) => boolean

Returns

void

---

grid

Get Signature

get grid(): Grid

Defined in: js-api/src/grid.ts:1476

Returns

Grid

---

mouseOverColumn

Get Signature

get mouseOverColumn(): Column

Defined in: js-api/src/grid.ts:1516

Returns

Column

---

name

Get Signature

get name(): string | undefined

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

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).

Returns

string | undefined

Set Signature

set name(x): void

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

Parameters

Parameter	Type
x	string | undefined

Returns

void

Inherited from

Widget.name

---

nameCol

Get Signature

get nameCol(): Column

Defined in: js-api/src/grid.ts:1477

Returns

Column

---

parent

Get Signature

get parent(): Widget<any> | null

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

Parent widget up the DOM tree, or null.

Returns

Widget<any> | null

Inherited from

Widget.parent

---

propertyTarget

Get Signature

get propertyTarget(): unknown

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

What this component's properties are read from and written to — prop.get(target) / prop.set(target, v): the component itself, unless an adoption says otherwise.

Returns

unknown

Inherited from

Widget.propertyTarget

---

propertyTier

Get Signature

get propertyTier(): boolean

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

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

Returns

boolean

Inherited from

Widget.propertyTier

---

root

Get Signature

get root(): HTMLElement

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

Returns

HTMLElement

Set Signature

set root(x): void

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

Parameters

Parameter	Type
x	HTMLElement

Returns

void

Inherited from

Widget.root

---

scope

Get Signature

get scope(): Scope

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

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.

Returns

Scope

Inherited from

Widget.scope

---

showSearch

Get Signature

get showSearch(): boolean

Defined in: js-api/src/grid.ts:1489

Returns

boolean

Set Signature

set showSearch(x): void

Defined in: js-api/src/grid.ts:1490

Parameters

Parameter	Type
x	boolean

Returns

void

---

type

Get Signature

get type(): string

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

Returns

string

Inherited from

Widget.type

---

typeNameCol

Get Signature

get typeNameCol(): Column

Defined in: js-api/src/grid.ts:1478

Returns

Column

Methods

_notifyPropertyChange()

protected _notifyPropertyChange(p): void

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

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

Parameter	Type
p	Property | null

Returns

void

Inherited from

Widget._notifyPropertyChange

---

_ownPropertyChanges()

protected _ownPropertyChanges(): ObservableLike<PropertyChange>

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

Returns

ObservableLike<PropertyChange>

Inherited from

Widget._ownPropertyChanges

---

_scopeMinted()

protected _scopeMinted(_scope): void

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

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

Parameter	Type
_scope	Scope

Returns

void

Inherited from

Widget._scopeMinted

---

_wireDartLifecycle()

protected _wireDartLifecycle(): void

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

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

Returns

void

Inherited from

Widget._wireDartLifecycle

---

_wireJsLifecycle()

protected _wireJsLifecycle(): void

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

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

Returns

void

Inherited from

Widget._wireJsLifecycle

---

_wireLifecycle()

protected _wireLifecycle(): void

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

Returns

void

Inherited from

Widget._wireLifecycle

---

addCheckedSelect()

addCheckedSelect(): void

Defined in: js-api/src/grid.ts:1483

Returns

void

---

addChecks()

addChecks(isChecked, addAdditionalChecks, additionalChecksName): void

Defined in: js-api/src/grid.ts:1518

Parameters

Parameter	Type
isChecked	(colName) => boolean
addAdditionalChecks	(colName) => boolean
additionalChecksName	string

Returns

void

---

addColumnProperty()

addColumnProperty(p): Column

Defined in: js-api/src/grid.ts:1536

Parameters

Parameter	Type
p	Property

Returns

Column

---

addColumnSelectionControls()

addColumnSelectionControls(): void

Defined in: js-api/src/grid.ts:1494

Returns

void

---

addColumnStats()

addColumnStats(aggType): Column

Defined in: js-api/src/grid.ts:1535

Parameters

Parameter	Type
aggType	string

Returns

Column

---

apply()

apply(properties): Widget

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

Parameters

Parameter	Type	Description
properties	object	-

Returns

Widget

Inherited from

Widget.apply

---

bindProps()

bindProps(): BindProp[]

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

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

Widget.bindProps

---

bindStep()

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

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

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

Parameter	Type
name	string

Returns

BindSource | Signal<unknown> | null

Inherited from

Widget.bindStep

---

checkAll()

checkAll(isChecked?): void

Defined in: js-api/src/grid.ts:1521

Parameters

Parameter	Type
isChecked?	boolean

Returns

void

---

close()

close(): void

Defined in: js-api/src/grid.ts:1492

Returns

void

---

columnsToDataFrame()

columnsToDataFrame(columnsOrder?, addServiceColumns?, serviceColsTagName?): void

Defined in: js-api/src/grid.ts:1537

Parameters

Parameter	Type
columnsOrder?	Column<any, any>[]
addServiceColumns?	boolean
serviceColsTagName?	string

Returns

void

---

detach()

detach(): void

Defined in: js-api/src/grid.ts:1493

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

Overrides

Widget.detach

---

dispose()

dispose(): void

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

On a never-engaged wrapper the getter mints here and _scopeMinted wires the lifecycle (own(kill) + the platform cleanup for Dart-owned), so dispose still kills it; re-entry from the kill cleanup is a no-op via the scope's disposed flag.

Returns

void

Inherited from

Widget.dispose

---

effect()

effect(fn): this

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

Parameters

Parameter	Type
fn	() => void

Returns

this

Inherited from

Widget.effect

---

filterColumns()

filterColumns(): void

Defined in: js-api/src/grid.ts:1484

Returns

void

---

fireEvent()

protected fireEvent(eventId, args?): void

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

Parameters

Parameter	Type
eventId	string
args?	unknown

Returns

void

Inherited from

Widget.fireEvent

---

getAdditionalCheckedColumnNames()

getAdditionalCheckedColumnNames(): string[]

Defined in: js-api/src/grid.ts:1529

Returns

string[]

---

getAdditionalCheckedColumns()

getAdditionalCheckedColumns(): Column<any, any>[]

Defined in: js-api/src/grid.ts:1528

Returns

Column<any, any>[]

---

getAdditionalCheckedIndexes()

getAdditionalCheckedIndexes(): number[]

Defined in: js-api/src/grid.ts:1527

Returns

number[]

---

getCheckedColumnNames()

getCheckedColumnNames(): string[]

Defined in: js-api/src/grid.ts:1525

Returns

string[]

---

getCheckedColumns()

getCheckedColumns(): Column<any, any>[]

Defined in: js-api/src/grid.ts:1524

Returns

Column<any, any>[]

---

getCheckedIndexes()

getCheckedIndexes(): number[]

Defined in: js-api/src/grid.ts:1523

Returns

number[]

---

getCol()

getCol(row): Column

Defined in: js-api/src/grid.ts:1514

Parameters

Parameter	Type
row	number

Returns

Column

---

getDartProperties()

getDartProperties(): any[]

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

Returns

any[]

Inherited from

Widget.getDartProperties

---

getFunctions()

getFunctions(): Func[]

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

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

---

getProperties()

getProperties(): Property[]

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

Returns all properties of this widget: the meta-generated ones plus addProperty's.

Returns

Property[]

Inherited from

Widget.getProperties

---

getRow()

getRow(col): number

Defined in: js-api/src/grid.ts:1513

Parameters

Parameter	Type
col	Column

Returns

number

---

getSelectedColumns()

getSelectedColumns(): Column<any, any>[]

Defined in: js-api/src/grid.ts:1531

Returns

Column<any, any>[]

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

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

Returns the widget's runtime structure for automated testing and introspection.

Returns

IWidgetStatus

Inherited from

Widget.getWidgetStatus

---

indexes()

indexes(rows): number[]

Defined in: js-api/src/grid.ts:1534

Parameters

Parameter	Type
rows	string

Returns

number[]

---

init()

init(dfSource, filter?, syncSelections?, order?, addServiceColumns?): void

Defined in: js-api/src/grid.ts:1500

Parameters

Parameter	Type
dfSource	DataFrame
filter?	(c) => boolean
syncSelections?	boolean
order?	Column<any, any>[]
addServiceColumns?	boolean

Returns

void

---

initColumnDragDrop()

initColumnDragDrop(): void

Defined in: js-api/src/grid.ts:1499

Returns

void

---

initColumnManager()

initColumnManager(dfSource, filter?): void

Defined in: js-api/src/grid.ts:1509

Parameters

Parameter	Type
dfSource	DataFrame
filter?	(c) => boolean

Returns

void

---

initColumnSelector()

initColumnSelector(dfSource, checkAll?, filter?): void

Defined in: js-api/src/grid.ts:1505

Parameters

Parameter	Type
dfSource	DataFrame
checkAll?	boolean
filter?	(c) => boolean

Returns

void

---

initColumnTooltips()

initColumnTooltips(): void

Defined in: js-api/src/grid.ts:1498

Returns

void

---

initContextMenu()

initContextMenu(): void

Defined in: js-api/src/grid.ts:1508

Returns

void

---

initGrayedOutColumnStyle()

initGrayedOutColumnStyle(): void

Defined in: js-api/src/grid.ts:1496

Returns

void

---

initTypeColoring()

initTypeColoring(): void

Defined in: js-api/src/grid.ts:1497

Returns

void

---

link()

link(name, source, twoWay): void

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

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

Parameter	Type
name	string
source	Signal<unknown>
twoWay	boolean

Returns

void

Inherited from

Widget.link

---

onEvent()

onEvent(eventId?): Observable<any>

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

Observes events with the specified eventId. Override in subclasses to provide actual events.

Parameters

Parameter	Type	Default value
eventId	string | null	null

Returns

Observable<any>

Inherited from

Widget.onEvent

---

onFrameAttached()

onFrameAttached(dataFrame): void

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

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

Widget.onFrameAttached

---

onPropertyChanged()

onPropertyChanged(property): void

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

Gets called when viewer's property is changed.

Parameters

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

Returns

void

Inherited from

Widget.onPropertyChanged

---

own()

own(dispose): this

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

Parameters

Parameter	Type
dispose	() => void

Returns

this

Inherited from

Widget.own

---

passesFilter()

passesFilter(col, columnName?): boolean

Defined in: js-api/src/grid.ts:1486

Parameters

Parameter	Type
col	Column
columnName?	string

Returns

boolean

---

propertyChanges()

protected propertyChanges(): ObservableLike<PropertyChange>

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

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

Returns

ObservableLike<PropertyChange>

Inherited from

Widget.propertyChanges

---

refreshStats()

refreshStats(): void

Defined in: js-api/src/grid.ts:1487

Returns

void

---

registerFunction()

protected registerFunction(f): void

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

Parameters

Parameter	Type
f	FuncLike

Returns

void

Inherited from

Widget.registerFunction

---

run()

run<T>(fn): T

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

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
fn	() => T

Returns

T

Inherited from

Widget.run

---

setSelectedColumns()

setSelectedColumns(columnIds): void

Defined in: js-api/src/grid.ts:1532

Parameters

Parameter	Type
columnIds	any[]

Returns

void

---

shouldShowColumnTooltip()

shouldShowColumnTooltip(col): boolean

Defined in: js-api/src/grid.ts:1485

Parameters

Parameter	Type
col	Column

Returns

boolean

---

sourceRowsChanged()

sourceRowsChanged(): void

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

Returns

void

Inherited from

Widget.sourceRowsChanged

---

sub()

sub(subscription): void

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

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription	-

Returns

void

Inherited from

Widget.sub

---

toDart()

toDart(): any

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

Returns

any

Inherited from

Widget.toDart

---

build()

static build(builder): Control

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

Builds a control out of plain elements: builder runs with the new control's scope ambient, so signal bindings and nested components inside it are owned by the result. The ambient scope only spans the synchronous part of builder — components constructed after an await inside it are adopted by nobody and must be disposed by hand, or constructed before the first await.

Parameters

Parameter	Type
builder	() => HTMLElement | (string | HTMLElement | Control)[]

Returns

Control

Inherited from

Widget.build

---

columnManager()

static columnManager(dfSource?, filter?, gridOptions?): ColumnGrid

Defined in: js-api/src/grid.ts:1429

Creates a new column manager grid.

Parameters

Parameter	Type
dfSource?	DataFrame
filter?	(c) => boolean
gridOptions?	{[key: string]: any; }

Returns

ColumnGrid

---

columnReorderManagerDialog()

static columnReorderManagerDialog(df, title, options?): ColumnGrid

Defined in: js-api/src/grid.ts:1434

Creates a new column reorder manager grid.

Parameters

Parameter	Type
df	DataFrame
title	string
options?	{ addAdditionalChecks?: (colName, additionalColumnName?) => boolean; additionalChecksName?: string; addServiceColumns: boolean; applyOrder?: (cg) => void; applyVisibility?: (cg) => void; checks?: (colName) => boolean; dfSource?: Grid; filter?: (c) => boolean; gridOptions?: {[key: string]: any; }; order?: Column<any, any>[]; }
options.addAdditionalChecks?	(colName, additionalColumnName?) => boolean
options.additionalChecksName?	string
options.addServiceColumns?	boolean
options.applyOrder?	(cg) => void
options.applyVisibility?	(cg) => void
options.checks?	(colName) => boolean
options.dfSource?	Grid
options.filter?	(c) => boolean
options.gridOptions?	{[key: string]: any; }
options.order?	Column<any, any>[]

Returns

ColumnGrid

---

columnSelector()

static columnSelector(dfSource, options?): ColumnGrid

Defined in: js-api/src/grid.ts:1466

Creates a new column selector grid.

Parameters

Parameter	Type
dfSource	DataFrame
options?	{ checkAll?: boolean; filter?: (c) => boolean; isChecked?: (c) => boolean; }
options.checkAll?	boolean
options.filter?	(c) => boolean
options.isChecked?	(c) => boolean

Returns

ColumnGrid

---

create()

static create(options?): ColumnGrid

Defined in: js-api/src/grid.ts:1419

Creates a new grid.

Parameters

Parameter	Type
options?	{ filter: (c) => boolean; gridOptions: {[key: string]: any; }; isColGrayedOut: (input) => any; showMenuIcon: boolean; }
options.filter?	(c) => boolean
options.gridOptions?	{[key: string]: any; }
options.isColGrayedOut?	(input) => any
options.showMenuIcon?	boolean

Returns

ColumnGrid

---

find()

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

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

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

Widget<any> | null

Inherited from

Widget.find

---

fromRoot()

static fromRoot(root): Widget

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

Creates a new widget from the root element.

Parameters

Parameter	Type
root	HTMLElement

Returns

Widget

Inherited from

Widget.fromRoot

---

getAll()

static getAll(): Widget<any>[]

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

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Widget.getAll

---

init()

static init(self, scope?): void

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

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

Parameters

Parameter	Type
self	Component
scope?	Scope

Returns

void

Inherited from

Widget.init

---

is()

static is(x): x is Control

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

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

Parameters

Parameter	Type
x	unknown

Returns

x is Control

Inherited from

Widget.is

---

popup()

static popup(dfSource, options?): ColumnGrid

Defined in: js-api/src/grid.ts:1454

Creates a new popup grid.

Parameters

Parameter	Type
dfSource	DataFrame
options?	{ addEmpty?: boolean; filter?: (c) => boolean; grayedOutColsMode?: boolean; serviceColsTagName?: string; widgetMode?: boolean; }
options.addEmpty?	boolean
options.filter?	(c) => boolean
options.grayedOutColsMode?	boolean
options.serviceColsTagName?	string
options.widgetMode?	boolean

Returns

ColumnGrid

---

registerCleanup()

static registerCleanup(element, cleanup): void

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

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

Parameter	Type
element	Element
cleanup	Function

Returns

void

Inherited from

Widget.registerCleanup

---

sameValue()

static sameValue(a, b): boolean

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

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

Parameter	Type
a	unknown
b	unknown

Returns

boolean

Inherited from

Widget.sameValue