Class: FilesWidget

dg.FilesWidget

File browser widget

Hierarchy

• DartWidget

  ↳ FilesWidget

Constructors

constructor

• new FilesWidget(dart)

Parameters

Name	Type
dart	any

Inherited from

DartWidget.constructor

Defined in

src/widgets.ts:427

Properties

_properties

• Protected _properties: Property[]

Inherited from

DartWidget._properties

Defined in

src/widgets.ts:178

---

_root

• Protected _root: HTMLElement

Inherited from

DartWidget._root

Defined in

src/widgets.ts:177

---

dart

• dart: any

Inherited from

DartWidget.dart

Defined in

src/widgets.ts:181

---

factory

• factory: null | Func = null

Constructor function. No parameters, returns [Widget].

Inherited from

DartWidget.factory

Defined in

src/widgets.ts:175

---

isDetached

• isDetached: boolean = false

Inherited from

DartWidget.isDetached

Defined in

src/widgets.ts:182

---

props

• props: any

Inherited from

DartWidget.props

Defined in

src/widgets.ts:179

---

subs

• subs: Subscription[]

Inherited from

DartWidget.subs

Defined in

src/widgets.ts:180

---

temp

• temp: any

Contains auxiliary information

Inherited from

DartWidget.temp

Defined in

src/widgets.ts:172

Accessors

root

• get root(): HTMLElement

Widget's visual root.

Returns

HTMLElement

Inherited from

DartWidget.root

Defined in

src/widgets.ts:437

---

type

• get type(): string

Returns

string

Inherited from

DartWidget.type

Defined in

src/widgets.ts:433

Methods

addProperty

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

Registers an property with the specified type, name, and defaultValue. Registered property gets added to {@see properties}. Returns default value, thus allowing to combine registering a property with the initialization

Parameters

Name	Type	Default value
propertyName	string	undefined
propertyType	"string" | "bigint" | "object" | "map" | "file" | "view" | "element" | "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" | "TableView" | "User" | "Menu" | "Project" | "event_data" | "progressindicator" | "Credentials" | "ScriptEnvironment" | "Notebook"	undefined
defaultValue	any	null
options	null | { [key: string]: any; } & PropertyOptions	null

Returns

any

Inherited from

DartWidget.addProperty

Defined in

src/widgets.ts:280

---

apply

▸ apply(properties): Widget<any>

Parameters

Name	Type
properties	object

Returns

Widget<any>

Inherited from

DartWidget.apply

Defined in

src/widgets.ts:230

---

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

DartWidget.detach

Defined in

src/widgets.ts:264

---

getDartProperties

▸ getDartProperties(): any[]

Returns

any[]

Inherited from

DartWidget.getDartProperties

Defined in

src/widgets.ts:246

---

getProperties

▸ getProperties(): Property[]

Returns

Property[]

Inherited from

DartWidget.getProperties

Defined in

src/widgets.ts:441

---

onFrameAttached

▸ onFrameAttached(dataFrame): void

Parameters

Name	Type
dataFrame	DataFrame

Returns

void

Inherited from

DartWidget.onFrameAttached

Defined in

src/widgets.ts:252

---

onPropertyChanged

▸ onPropertyChanged(property): void

Gets called when viewer's property is changed.

Parameters

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

Returns

void

Inherited from

DartWidget.onPropertyChanged

Defined in

src/widgets.ts:244

---

sourceRowsChanged

▸ sourceRowsChanged(): void

Returns

void

Inherited from

DartWidget.sourceRowsChanged

Defined in

src/widgets.ts:250

---

sub

▸ sub(subscription): void

Registers a subscription to an external event.

Parameters

Name	Type
subscription	Subscription

Returns

void

Inherited from

DartWidget.sub

Defined in

src/widgets.ts:223

---

toDart

▸ toDart(): any

Returns

any

Inherited from

DartWidget.toDart

Defined in

src/widgets.ts:215

---

create

▸ Static create(params?): FilesWidget

Creates a [FilesWidget] and opens a directory, if [path] is specified. [path] accepts a full-qualified name (see [Entity.nqName]).

Parameters

Name	Type
params	Object
params.dataSourceFilter?	"S3"[]
params.path?	string

Returns

FilesWidget

Defined in

src/widgets.ts:1958

---

find

▸ Static find(root): null | Widget<any>

Finds existing widget from its visual root.

Parameters

Name	Type
root	Element

Returns

null | Widget<any>

Inherited from

DartWidget.find

Defined in

src/widgets.ts:211

---

fromRoot

▸ Static fromRoot(root): Widget<any>

Creates a new widget from the root element.

Parameters

Name	Type
root	HTMLElement

Returns

Widget<any>

Inherited from

DartWidget.fromRoot

Defined in

src/widgets.ts:303

---

getAll

▸ Static getAll(): Widget<any>[]

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

DartWidget.getAll

Defined in

src/widgets.ts:206