ColumnGrid

Proxy class for the Dart-based column grid.

Extends

• Widget

Constructors

new ColumnGrid()

new ColumnGrid(dart): ColumnGrid

Parameters

Parameter	Type
dart	any

Returns

ColumnGrid

Overrides

Widget . constructor

Source

src/grid.ts:1383

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	readonly	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:293

---

currentColumn

get currentColumn(): Column<any, any>

Returns

Column<any, any>

Source

src/grid.ts:1485

---

dfColumns

get dfColumns(): DataFrame

Returns

DataFrame

Source

src/grid.ts:1443

---

dfSource

get dfSource(): DataFrame

Returns

DataFrame

Source

src/grid.ts:1444

---

filter

get filter(): (c) => boolean

set filter(f): void

Parameters

Parameter	Type
f	(c) => boolean

Returns

Function

Parameters

Parameter	Type
c	Column<any, any>

Returns

boolean

Source

src/grid.ts:1450

---

grid

get grid(): Grid

Returns

Grid

Source

src/grid.ts:1446

---

gridSource

get gridSource(): Grid

Returns

Grid

Source

src/grid.ts:1445

---

mouseOverColumn

get mouseOverColumn(): Column<any, any>

Returns

Column<any, any>

Source

src/grid.ts:1486

---

nameCol

get nameCol(): Column<any, any>

Returns

Column<any, any>

Source

src/grid.ts:1447

---

parent

get parent(): null | Widget<any>

Parent widget up the DOM tree, or null.

Returns

null | Widget<any>

Source

src/widgets.ts:290

---

root

get root(): HTMLElement

Widget's visual root.

set root(r): void

Parameters

Parameter	Type
r	HTMLElement

Returns

HTMLElement

Source

src/widgets.ts:297

---

showSearch

get showSearch(): boolean

set showSearch(x): void

Parameters

Parameter	Type
x	boolean

Returns

boolean

Source

src/grid.ts:1459

---

type

get type(): string

Returns

string

Source

src/widgets.ts:206

---

typeNameCol

get typeNameCol(): Column<any, any>

Returns

Column<any, any>

Source

src/grid.ts:1448

Methods

addCheckedSelect()

addCheckedSelect(): void

Returns

void

Source

src/grid.ts:1453

---

addChecks()

addChecks(isChecked, addAdditionalChecks, additionalChecksName): void

Parameters

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

Returns

void

Source

src/grid.ts:1488

---

addColumnProperty()

addColumnProperty(p): Column<any, any>

Parameters

Parameter	Type
p	Property

Returns

Column<any, any>

Source

src/grid.ts:1506

---

addColumnSelectionControls()

addColumnSelectionControls(): void

Returns

void

Source

src/grid.ts:1464

---

addColumnStats()

addColumnStats(aggType): Column<any, any>

Parameters

Parameter	Type
aggType	string

Returns

Column<any, any>

Source

src/grid.ts:1505

---

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:318

---

apply()

apply(properties): Widget<any>

Parameters

Parameter	Type	Description
properties	object

Returns

Widget<any>

Inherited from

Widget . apply

Source

src/widgets.ts:257

---

checkAll()

checkAll(isChecked?): void

Parameters

Parameter	Type
isChecked?	boolean

Returns

void

Source

src/grid.ts:1491

---

close()

close(): void

Returns

void

Source

src/grid.ts:1462

---

columnsToDataFrame()

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

Parameters

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

Returns

void

Source

src/grid.ts:1507

---

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

Overrides

Widget . detach

Source

src/grid.ts:1463

---

filterColumns()

filterColumns(): void

Returns

void

Source

src/grid.ts:1454

---

getAdditionalCheckedColumnNames()

getAdditionalCheckedColumnNames(): string[]

Returns

string[]

Source

src/grid.ts:1499

---

getAdditionalCheckedColumns()

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

Returns

Column<any, any>[]

Source

src/grid.ts:1498

---

getAdditionalCheckedIndexes()

getAdditionalCheckedIndexes(): number[]

Returns

number[]

Source

src/grid.ts:1497

---

getCheckedColumnNames()

getCheckedColumnNames(): string[]

Returns

string[]

Source

src/grid.ts:1495

---

getCheckedColumns()

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

Returns

Column<any, any>[]

Source

src/grid.ts:1494

---

getCheckedIndexes()

getCheckedIndexes(): number[]

Returns

number[]

Source

src/grid.ts:1493

---

getCol()

getCol(row): Column<any, any>

Parameters

Parameter	Type
row	number

Returns

Column<any, any>

Source

src/grid.ts:1484

---

getDartProperties()

getDartProperties(): any[]

Returns

any[]

Inherited from

Widget . getDartProperties

Source

src/widgets.ts:278

---

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:272

---

getProperties()

getProperties(): Property[]

Returns all properties of this widget.

Returns

Property[]

Inherited from

Widget . getProperties

Source

src/widgets.ts:268

---

getRow()

getRow(col): number

Parameters

Parameter	Type
col	Column<any, any>

Returns

number

Source

src/grid.ts:1483

---

getSelectedColumns()

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

Returns

Column<any, any>[]

Source

src/grid.ts:1501

---

indexes()

indexes(rows): number[]

Parameters

Parameter	Type
rows	string

Returns

number[]

Source

src/grid.ts:1504

---

init()

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

Parameters

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

Returns

void

Source

src/grid.ts:1470

---

initColumnDragDrop()

initColumnDragDrop(): void

Returns

void

Source

src/grid.ts:1469

---

initColumnManager()

initColumnManager(dfSource, filter?): void

Parameters

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

Returns

void

Source

src/grid.ts:1479

---

initColumnSelector()

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

Parameters

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

Returns

void

Source

src/grid.ts:1475

---

initColumnTooltips()

initColumnTooltips(): void

Returns

void

Source

src/grid.ts:1468

---

initContextMenu()

initContextMenu(): void

Returns

void

Source

src/grid.ts:1478

---

initGrayedOutColumnStyle()

initGrayedOutColumnStyle(): void

Returns

void

Source

src/grid.ts:1466

---

initTypeColoring()

initTypeColoring(): void

Returns

void

Source

src/grid.ts:1467

---

onFrameAttached()

onFrameAttached(dataFrame): void

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

Widget . onFrameAttached

Source

src/widgets.ts:284

---

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:276

---

passesFilter()

passesFilter(col, columnName?): boolean

Parameters

Parameter	Type
col	Column<any, any>
columnName?	string

Returns

boolean

Source

src/grid.ts:1456

---

refreshStats()

refreshStats(): void

Returns

void

Source

src/grid.ts:1457

---

setSelectedColumns()

setSelectedColumns(columnIds): void

Parameters

Parameter	Type
columnIds	any[]

Returns

void

Source

src/grid.ts:1502

---

shouldShowColumnTooltip()

shouldShowColumnTooltip(col): boolean

Parameters

Parameter	Type
col	Column<any, any>

Returns

boolean

Source

src/grid.ts:1455

---

sourceRowsChanged()

sourceRowsChanged(): void

Returns

void

Inherited from

Widget . sourceRowsChanged

Source

src/widgets.ts:282

---

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:250

---

toDart()

toDart(): any

Returns

any

Inherited from

Widget . toDart

Source

src/widgets.ts:242

---

columnManager()

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

Creates a new column manager grid.

Parameters

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

Returns

ColumnGrid

Source

src/grid.ts:1398

---

columnReorderManagerDialog()

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

Creates a new column reorder manager grid.

Parameters

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

Returns

ColumnGrid

Source

src/grid.ts:1403

---

columnSelector()

static columnSelector(dfSource, options?): ColumnGrid

Creates a new column selector grid.

Parameters

Parameter	Type
dfSource	DataFrame
options?	object
options.checkAll?	boolean
options.filter?	(c) => boolean
options.isChecked?	(c) => boolean

Returns

ColumnGrid

Source

src/grid.ts:1435

---

create()

static create(options?): ColumnGrid

Creates a new grid.

Parameters

Parameter	Type
options?	object
options.filter?	(c) => boolean
options.gridOptions?	object
options.isColGrayedOut?	(input) => any
options.showMenuIcon?	boolean

Returns

ColumnGrid

Source

src/grid.ts:1388

---

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:238

---

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:341

---

getAll()

static getAll(): Widget<any>[]

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Widget . getAll

Source

src/widgets.ts:233

---

popup()

static popup(dfSource, options?): ColumnGrid

Creates a new popup grid.

Parameters

Parameter	Type
dfSource	DataFrame
options?	object
options.addEmpty?	boolean
options.filter?	(c) => boolean
options.grayedOutColsMode?	boolean
options.serviceColsTagName?	string
options.widgetMode?	boolean

Returns

ColumnGrid

Source

src/grid.ts:1423