ColumnGrid

Defined in: src/grid.ts:1385

Proxy class for the Dart-based column grid.

Extends

• Widget

Constructors

Constructor

new ColumnGrid(dart): ColumnGrid

Defined in: src/grid.ts:1386

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	src/widgets/base.ts:243
_properties	protected	Property[]	[]	-	Widget._properties	src/widgets/base.ts:242
_root	protected	HTMLElement	undefined	-	Widget._root	src/widgets/base.ts:241
dart	readonly	any	undefined	-	Widget.dart	src/grid.ts:1386
factory	public	Func | null	null	Constructor function. No parameters, returns [Widget].	Widget.factory	src/widgets/base.ts:239
isDetached	public	boolean	false	-	Widget.isDetached	src/widgets/base.ts:247
props	public	any	undefined	-	Widget.props	src/widgets/base.ts:244
subs	public	Subscription[]	undefined	-	Widget.subs	src/widgets/base.ts:245
temp	public	any	undefined	Contains auxiliary information	Widget.temp	src/widgets/base.ts:236

Accessors

children

Get Signature

get children(): Widget<any>[]

Defined in: src/widgets/base.ts:320

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Inherited from

Widget.children

---

currentColumn

Get Signature

get currentColumn(): Column

Defined in: src/grid.ts:1487

Returns

Column

---

dfColumns

Get Signature

get dfColumns(): DataFrame

Defined in: src/grid.ts:1446

Returns

DataFrame

---

dfSource

Get Signature

get dfSource(): DataFrame

Defined in: src/grid.ts:1447

Returns

DataFrame

---

filter

Get Signature

get filter(): (c) => boolean

Defined in: src/grid.ts:1452

Returns

(c) => boolean

Set Signature

set filter(f): void

Defined in: src/grid.ts:1453

Parameters

Parameter	Type
f	(c) => boolean

Returns

void

---

grid

Get Signature

get grid(): Grid

Defined in: src/grid.ts:1448

Returns

Grid

---

mouseOverColumn

Get Signature

get mouseOverColumn(): Column

Defined in: src/grid.ts:1488

Returns

Column

---

nameCol

Get Signature

get nameCol(): Column

Defined in: src/grid.ts:1449

Returns

Column

---

parent

Get Signature

get parent(): Widget<any> | null

Defined in: src/widgets/base.ts:317

Parent widget up the DOM tree, or null.

Returns

Widget<any> | null

Inherited from

Widget.parent

---

root

Get Signature

get root(): HTMLElement

Defined in: src/widgets/base.ts:324

Widget's visual root.

Returns

HTMLElement

Set Signature

set root(r): void

Defined in: src/widgets/base.ts:325

Parameters

Parameter	Type
r	HTMLElement

Returns

void

Inherited from

Widget.root

---

showSearch

Get Signature

get showSearch(): boolean

Defined in: src/grid.ts:1461

Returns

boolean

Set Signature

set showSearch(x): void

Defined in: src/grid.ts:1462

Parameters

Parameter	Type
x	boolean

Returns

void

---

type

Get Signature

get type(): string

Defined in: src/widgets/base.ts:233

Returns

string

Inherited from

Widget.type

---

typeNameCol

Get Signature

get typeNameCol(): Column

Defined in: src/grid.ts:1450

Returns

Column

Methods

addCheckedSelect()

addCheckedSelect(): void

Defined in: src/grid.ts:1455

Returns

void

---

addChecks()

addChecks(isChecked, addAdditionalChecks, additionalChecksName): void

Defined in: src/grid.ts:1490

Parameters

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

Returns

void

---

addColumnProperty()

addColumnProperty(p): Column

Defined in: src/grid.ts:1508

Parameters

Parameter	Type
p	Property

Returns

Column

---

addColumnSelectionControls()

addColumnSelectionControls(): void

Defined in: src/grid.ts:1466

Returns

void

---

addColumnStats()

addColumnStats(aggType): Column

Defined in: src/grid.ts:1507

Parameters

Parameter	Type
aggType	string

Returns

Column

---

apply()

apply(properties): Widget

Defined in: src/widgets/base.ts:284

Parameters

Parameter	Type	Description
properties	object	-

Returns

Widget

Inherited from

Widget.apply

---

checkAll()

checkAll(isChecked?): void

Defined in: src/grid.ts:1493

Parameters

Parameter	Type
isChecked?	boolean

Returns

void

---

close()

close(): void

Defined in: src/grid.ts:1464

Returns

void

---

columnsToDataFrame()

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

Defined in: src/grid.ts:1509

Parameters

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

Returns

void

---

detach()

detach(): void

Defined in: src/grid.ts:1465

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

---

filterColumns()

filterColumns(): void

Defined in: src/grid.ts:1456

Returns

void

---

getAdditionalCheckedColumnNames()

getAdditionalCheckedColumnNames(): string[]

Defined in: src/grid.ts:1501

Returns

string[]

---

getAdditionalCheckedColumns()

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

Defined in: src/grid.ts:1500

Returns

Column<any, any>[]

---

getAdditionalCheckedIndexes()

getAdditionalCheckedIndexes(): number[]

Defined in: src/grid.ts:1499

Returns

number[]

---

getCheckedColumnNames()

getCheckedColumnNames(): string[]

Defined in: src/grid.ts:1497

Returns

string[]

---

getCheckedColumns()

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

Defined in: src/grid.ts:1496

Returns

Column<any, any>[]

---

getCheckedIndexes()

getCheckedIndexes(): number[]

Defined in: src/grid.ts:1495

Returns

number[]

---

getCol()

getCol(row): Column

Defined in: src/grid.ts:1486

Parameters

Parameter	Type
row	number

Returns

Column

---

getDartProperties()

getDartProperties(): any[]

Defined in: src/widgets/base.ts:305

Returns

any[]

Inherited from

Widget.getDartProperties

---

getFunctions()

getFunctions(): Func[]

Defined in: src/widgets/base.ts:299

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: src/widgets/base.ts:295

Returns all properties of this widget.

Returns

Property[]

Inherited from

Widget.getProperties

---

getRow()

getRow(col): number

Defined in: src/grid.ts:1485

Parameters

Parameter	Type
col	Column

Returns

number

---

getSelectedColumns()

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

Defined in: src/grid.ts:1503

Returns

Column<any, any>[]

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

Defined in: src/widgets/base.ts:371

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

Returns

IWidgetStatus

Inherited from

Widget.getWidgetStatus

---

indexes()

indexes(rows): number[]

Defined in: src/grid.ts:1506

Parameters

Parameter	Type
rows	string

Returns

number[]

---

init()

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

Defined in: src/grid.ts:1472

Parameters

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

Returns

void

---

initColumnDragDrop()

initColumnDragDrop(): void

Defined in: src/grid.ts:1471

Returns

void

---

initColumnManager()

initColumnManager(dfSource, filter?): void

Defined in: src/grid.ts:1481

Parameters

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

Returns

void

---

initColumnSelector()

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

Defined in: src/grid.ts:1477

Parameters

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

Returns

void

---

initColumnTooltips()

initColumnTooltips(): void

Defined in: src/grid.ts:1470

Returns

void

---

initContextMenu()

initContextMenu(): void

Defined in: src/grid.ts:1480

Returns

void

---

initGrayedOutColumnStyle()

initGrayedOutColumnStyle(): void

Defined in: src/grid.ts:1468

Returns

void

---

initTypeColoring()

initTypeColoring(): void

Defined in: src/grid.ts:1469

Returns

void

---

onEvent()

onEvent(eventId?): Observable<any>

Defined in: src/widgets/base.ts:368

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: src/widgets/base.ts:311

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

Widget.onFrameAttached

---

onPropertyChanged()

onPropertyChanged(property): void

Defined in: src/widgets/base.ts:303

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

---

passesFilter()

passesFilter(col, columnName?): boolean

Defined in: src/grid.ts:1458

Parameters

Parameter	Type
col	Column
columnName?	string

Returns

boolean

---

refreshStats()

refreshStats(): void

Defined in: src/grid.ts:1459

Returns

void

---

setSelectedColumns()

setSelectedColumns(columnIds): void

Defined in: src/grid.ts:1504

Parameters

Parameter	Type
columnIds	any[]

Returns

void

---

shouldShowColumnTooltip()

shouldShowColumnTooltip(col): boolean

Defined in: src/grid.ts:1457

Parameters

Parameter	Type
col	Column

Returns

boolean

---

sourceRowsChanged()

sourceRowsChanged(): void

Defined in: src/widgets/base.ts:309

Returns

void

Inherited from

Widget.sourceRowsChanged

---

sub()

sub(subscription): void

Defined in: src/widgets/base.ts:277

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription	-

Returns

void

Inherited from

Widget.sub

---

toDart()

toDart(): any

Defined in: src/widgets/base.ts:269

Returns

any

Inherited from

Widget.toDart

---

columnManager()

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

Defined in: src/grid.ts:1401

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: src/grid.ts:1406

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: src/grid.ts:1438

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: src/grid.ts:1391

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: src/widgets/base.ts:265

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: src/widgets/base.ts:374

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: src/widgets/base.ts:260

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Widget.getAll

---

popup()

static popup(dfSource, options?): ColumnGrid

Defined in: src/grid.ts:1426

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