SpaceView

Defined in: src/views/space_view.ts:15

Hierarchical view of a Datagrok Space — the same widget the Browse tree opens when you click a Space (a Project where isSpace == true). Includes the search box, the "+" ribbon button to add a child space, and the card grid of children (subspaces, files, entities).

Extends

• CardView

Constructors

Constructor

new SpaceView(dart): SpaceView

Defined in: src/views/card_view.ts:23

Parameters

Parameter	Type
dart	any

Returns

SpaceView

Inherited from

CardView.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
_functions	protected	Func[]	[]	-	CardView._functions	src/widgets/base.ts:243
_name	protected	string	'New View'	-	CardView._name	src/views/view.ts:100
_properties	protected	Property[]	[]	-	CardView._properties	src/widgets/base.ts:242
_root	protected	HTMLElement	undefined	-	CardView._root	src/widgets/base.ts:241
dart	public	any	undefined	-	CardView.dart	src/views/card_view.ts:21
factory	public	Func | null	null	Constructor function. No parameters, returns [Widget].	CardView.factory	src/widgets/base.ts:239
isDetached	public	boolean	false	-	CardView.isDetached	src/widgets/base.ts:247
props	public	any	undefined	-	CardView.props	src/widgets/base.ts:244
subs	public	Subscription[]	undefined	-	CardView.subs	src/views/view.ts:47
temp	public	any	undefined	Contains auxiliary information	CardView.temp	src/views/view.ts:214
ALL_VIEW_TYPES	readonly	string[]	undefined	-	CardView.ALL_VIEW_TYPES	src/views/view.ts:366
APPS	readonly	"apps"	'apps'	-	CardView.APPS	src/views/view.ts:336
BROWSE	readonly	"browse"	'browse'	-	CardView.BROWSE	src/views/view.ts:363
DATA_CONNECTIONS	readonly	"connections"	'connections'	-	CardView.DATA_CONNECTIONS	src/views/view.ts:350
DATA_JOB_RUNS	readonly	"jobs"	'jobs'	-	CardView.DATA_JOB_RUNS	src/views/view.ts:351
DATA_QUERY_RUNS	readonly	"queryruns"	'queryruns'	-	CardView.DATA_QUERY_RUNS	src/views/view.ts:353
DATABASES	readonly	"databases"	'databases'	-	CardView.DATABASES	src/views/view.ts:346
DOCKERS	readonly	"dockers"	'dockers'	-	CardView.DOCKERS	src/views/view.ts:364
EMAILS	readonly	"emails"	'emails'	-	CardView.EMAILS	src/views/view.ts:354
FILES	readonly	"files"	'files'	-	CardView.FILES	src/views/view.ts:352
FORUM	readonly	"forum"	'forum'	-	CardView.FORUM	src/views/view.ts:341
FUNCTIONS	readonly	"functions"	'functions'	-	CardView.FUNCTIONS	src/views/view.ts:349
GROUPS	readonly	"groups"	'groups'	-	CardView.GROUPS	src/views/view.ts:355
HELP	readonly	"help"	'help'	-	CardView.HELP	src/views/view.ts:344
JS_EDITOR	readonly	"js"	'js'	-	CardView.JS_EDITOR	src/views/view.ts:362
MODELS	readonly	"models"	'models'	-	CardView.MODELS	src/views/view.ts:356
NOTEBOOKS	readonly	"notebooks"	'notebooks'	-	CardView.NOTEBOOKS	src/views/view.ts:343
OPEN_TEXT	readonly	"text"	'text'	-	CardView.OPEN_TEXT	src/views/view.ts:345
PACKAGE_REPOSITORIES	readonly	"repositories"	'repositories'	-	CardView.PACKAGE_REPOSITORIES	src/views/view.ts:361
PACKAGES	readonly	"packages"	'packages'	-	CardView.PACKAGES	src/views/view.ts:360
PROJECTS	readonly	"projects"	'projects'	-	CardView.PROJECTS	src/views/view.ts:342
QUERIES	readonly	"queries"	'queries'	-	CardView.QUERIES	src/views/view.ts:357
SCRIPT	readonly	"script"	'script'	-	CardView.SCRIPT	src/views/view.ts:339
SCRIPTS	readonly	"scripts"	'scripts'	-	CardView.SCRIPTS	src/views/view.ts:358
SETTINGS	readonly	"settings"	'settings'	-	CardView.SETTINGS	src/views/view.ts:337
SKETCH	readonly	"sketch"	'sketch'	-	CardView.SKETCH	src/views/view.ts:340
USERS	readonly	"users"	'users'	-	CardView.USERS	src/views/view.ts:359
VIEW_LAYOUTS	readonly	"layouts"	'layouts'	-	CardView.VIEW_LAYOUTS	src/views/view.ts:348
WEB_SERVICES	readonly	"webservices"	'webservices'	-	CardView.WEB_SERVICES	src/views/view.ts:347
WELCOME	readonly	"welcome"	'welcome'	-	CardView.WELCOME	src/views/view.ts:338

Accessors

basePath

Get Signature

get basePath(): string

Defined in: src/views/view.ts:125

Deprecated

use path instead

Returns

string

Set Signature

set basePath(s): void

Defined in: src/views/view.ts:126

Parameters

Parameter	Type
s	string

Returns

void

Inherited from

CardView.basePath

---

box

Get Signature

get box(): boolean

Defined in: src/views/view.ts:73

Returns

boolean

Set Signature

set box(b): void

Defined in: src/views/view.ts:74

Parameters

Parameter	Type
b	boolean

Returns

void

Inherited from

CardView.box

---

categoryFilters

Get Signature

get categoryFilters(): object

Defined in: src/views/card_view.ts:56

Category filter properties list

Returns

object

Set Signature

set categoryFilters(ff): void

Defined in: src/views/card_view.ts:57

Parameters

Parameter	Type
ff	{[property: string]: string; }

Returns

void

Inherited from

CardView.categoryFilters

---

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

CardView.children

---

closing

Get Signature

get closing(): boolean

Defined in: src/views/view.ts:143

Whether the view is currently closing.

Returns

boolean

Set Signature

set closing(c): void

Defined in: src/views/view.ts:144

Parameters

Parameter	Type
c	boolean

Returns

void

Inherited from

CardView.closing

---

description

Get Signature

get description(): string

Defined in: src/views/view.ts:279

View description. Used in UI and AI.

Returns

string

Set Signature

set description(s): void

Defined in: src/views/view.ts:280

Parameters

Parameter	Type
s	string

Returns

void

Inherited from

CardView.description

---

entity

Get Signature

get entity(): object | null

Defined in: src/views/view.ts:121

Returns

object | null

Set Signature

set entity(_e): void

Defined in: src/views/view.ts:122

Parameters

Parameter	Type
_e	object | null

Returns

void

Inherited from

CardView.entity

---

filters

Get Signature

get filters(): object

Defined in: src/views/card_view.ts:60

Text filter properties list

Returns

object

Set Signature

set filters(ff): void

Defined in: src/views/card_view.ts:61

Parameters

Parameter	Type
ff	{[property: string]: string; }

Returns

void

Inherited from

CardView.filters

---

helpUrl

Get Signature

get helpUrl(): string | null

Defined in: src/views/view.ts:283

Returns

string | null

View help URL.

Set Signature

set helpUrl(url): void

Defined in: src/views/view.ts:284

Parameters

Parameter	Type
url	string | null

Returns

void

View help URL.

Inherited from

CardView.helpUrl

---

hierarchy

Get Signature

get hierarchy(): string[]

Defined in: src/views/card_view.ts:64

Grouping properties list

Returns

string[]

Set Signature

set hierarchy(s): void

Defined in: src/views/card_view.ts:65

Parameters

Parameter	Type
s	string[]

Returns

void

Inherited from

CardView.hierarchy

---

hierarchyProperties

Get Signature

get hierarchyProperties(): object

Defined in: src/views/card_view.ts:68

All possible grouping properties list

Returns

object

Set Signature

set hierarchyProperties(s): void

Defined in: src/views/card_view.ts:69

Parameters

Parameter	Type
s	{[property: string]: string; }

Returns

void

Inherited from

CardView.hierarchyProperties

---

id

Get Signature

get id(): string

Defined in: src/views/view.ts:274

Returns

string

Inherited from

CardView.id

---

isPinned

Get Signature

get isPinned(): boolean

Defined in: src/views/view.ts:287

Returns

boolean

Whether the view is pinned. Pinned views are not closed when a new view is opened.

Inherited from

CardView.isPinned

---

meta

Get Signature

get meta(): ObjectHandler

Defined in: src/views/card_view.ts:39

Object handler (instructions how to render, drag-and-drop, etc)

Returns

ObjectHandler

Set Signature

set meta(s): void

Defined in: src/views/card_view.ts:40

Parameters

Parameter	Type
s	ObjectHandler

Returns

void

Inherited from

CardView.meta

---

name

Get Signature

get name(): string

Defined in: src/views/view.ts:318

View name. It gets shown in the tab handle.

Returns

string

Set Signature

set name(s): void

Defined in: src/views/view.ts:323

Parameters

Parameter	Type
s	string

Returns

void

Inherited from

CardView.name

---

objectType

Get Signature

get objectType(): string

Defined in: src/views/card_view.ts:43

Semantic type of the items.

Returns

string

Set Signature

set objectType(s): void

Defined in: src/views/card_view.ts:44

Parameters

Parameter	Type
s	string

Returns

void

Inherited from

CardView.objectType

---

onCurrentObjectChanged

Get Signature

get onCurrentObjectChanged(): Observable<Entity>

Defined in: src/views/space_view.ts:31

Fires when the user selects a different item in the space's card grid.

Returns

Observable<Entity>

---

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

CardView.parent

---

parentCall

Get Signature

get parentCall(): FuncCall | undefined

Defined in: src/views/view.ts:112

Returns

FuncCall | undefined

Set Signature

set parentCall(s): void

Defined in: src/views/view.ts:113

Parameters

Parameter	Type
s	FuncCall | undefined

Returns

void

Inherited from

CardView.parentCall

---

parentView

Get Signature

get parentView(): ViewBase

Defined in: src/views/view.ts:115

Returns

ViewBase

Set Signature

set parentView(s): void

Defined in: src/views/view.ts:116

Parameters

Parameter	Type
s	ViewBase

Returns

void

Inherited from

CardView.parentView

---

path

Get Signature

get path(): string

Defined in: src/views/view.ts:170

View URI, relative to the view root

Returns

string

Set Signature

set path(s): void

Defined in: src/views/view.ts:171

Parameters

Parameter	Type
s	string

Returns

void

Inherited from

CardView.path

---

permanentFilter

Get Signature

get permanentFilter(): string

Defined in: src/views/card_view.ts:52

Programmatically defined invisible filter expression.

Returns

string

Set Signature

set permanentFilter(s): void

Defined in: src/views/card_view.ts:53

Parameters

Parameter	Type
s	string

Returns

void

Inherited from

CardView.permanentFilter

---

project

Get Signature

get project(): Project

Defined in: src/views/space_view.ts:22

The space (Project) being shown.

Returns

Project

---

renderMode

Get Signature

get renderMode(): RENDER_MODE

Defined in: src/views/card_view.ts:76

Render mode

Returns

RENDER_MODE

Set Signature

set renderMode(s): void

Defined in: src/views/card_view.ts:77

Parameters

Parameter	Type
s	RENDER_MODE

Returns

void

Inherited from

CardView.renderMode

---

ribbonMenu

Get Signature

get ribbonMenu(): Menu

Defined in: src/views/view.ts:135

View menu. Sample: https://public.datagrok.ai/js/samples/ui/views/ribbon

Returns

Menu

Set Signature

set ribbonMenu(menu): void

Defined in: src/views/view.ts:136

Parameters

Parameter	Type
menu	Menu

Returns

void

Inherited from

CardView.ribbonMenu

---

root

Get Signature

get root(): HTMLElement

Defined in: src/views/view.ts:266

Returns the content (visual root) of this view.

Returns

HTMLElement

Inherited from

CardView.root

---

searchFields

Get Signature

get searchFields(): string[]

Defined in: src/views/card_view.ts:46

Returns

string[]

Set Signature

set searchFields(s): void

Defined in: src/views/card_view.ts:47

Parameters

Parameter	Type
s	string[]

Returns

void

Inherited from

CardView.searchFields

---

searchValue

Get Signature

get searchValue(): string

Defined in: src/views/card_view.ts:35

User-specified filter expression.

Returns

string

Set Signature

set searchValue(s): void

Defined in: src/views/card_view.ts:36

Parameters

Parameter	Type
s	string

Returns

void

Inherited from

CardView.searchValue

---

showItemPreview

Get Signature

get showItemPreview(): boolean

Defined in: src/views/space_view.ts:27

Whether the in-view preview dock is shown when an item is selected. Set to false when you want to render the selected item's preview yourself by subscribing to onCurrentObjectChanged.

Returns

boolean

Set Signature

set showItemPreview(s): void

Defined in: src/views/space_view.ts:28

Parameters

Parameter	Type
s	boolean

Returns

void

---

showTree

Get Signature

get showTree(): boolean

Defined in: src/views/card_view.ts:72

Grouping mode on

Returns

boolean

Set Signature

set showTree(s): void

Defined in: src/views/card_view.ts:73

Parameters

Parameter	Type
s	boolean

Returns

void

Inherited from

CardView.showTree

---

statusBarPanels

Get Signature

get statusBarPanels(): HTMLDivElement[]

Defined in: src/views/view.ts:139

Status bar panels to be shown on the bottom

Returns

HTMLDivElement[]

Set Signature

set statusBarPanels(panels): void

Defined in: src/views/view.ts:140

Parameters

Parameter	Type
panels	HTMLDivElement[]

Returns

void

Inherited from

CardView.statusBarPanels

---

toolbox

Get Signature

get toolbox(): HTMLElement

Defined in: src/views/view.ts:130

View toolbox. Sample: https://public.datagrok.ai/js/samples/ui/views/toolbox

Returns

HTMLElement

Set Signature

set toolbox(x): void

Defined in: src/views/view.ts:131

Parameters

Parameter	Type
x	HTMLElement

Returns

void

Inherited from

CardView.toolbox

---

type

Get Signature

get type(): string

Defined in: src/views/view.ts:270

View type

Returns

string

Inherited from

CardView.type

Methods

_onAdded()

_onAdded(): void

Defined in: src/views/view.ts:331

Returns

void

Inherited from

CardView._onAdded

---

acceptsPath()

acceptsPath(_urlPath): boolean

Defined in: src/views/view.ts:178

Checks if URL path is acceptable. Override in subclasses.

Parameters

Parameter	Type
_urlPath	string

Returns

boolean

"true" if path is acceptable, "false" otherwise.

Inherited from

CardView.acceptsPath

---

append()

append(item): HTMLElement

Defined in: src/views/view.ts:183

Appends an item to this view. Use appendAll for appending multiple elements.

Parameters

Parameter	Type	Description
item	any	-

Returns

HTMLElement

Inherited from

CardView.append

---

appendAll()

appendAll(items): HTMLElement

Defined in: src/views/view.ts:190

Appends multiple elements this view. Use append for appending a single element.

Parameters

Parameter	Type	Description
items	HTMLElement[]	-

Returns

HTMLElement

Inherited from

CardView.appendAll

---

apply()

apply(properties): Widget

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

Parameters

Parameter	Type	Description
properties	object	-

Returns

Widget

Inherited from

CardView.apply

---

close()

close(): void

Defined in: src/views/view.ts:200

Closes this view.

Returns

void

Inherited from

CardView.close

---

detach()

detach(): void

Defined in: src/views/view.ts:195

Detaches this view.

Returns

void

Inherited from

CardView.detach

---

getDartProperties()

getDartProperties(): any[]

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

Returns

any[]

Inherited from

CardView.getDartProperties

---

getFunctions()

getFunctions(): Func[]

Defined in: src/views/view.ts:263

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

CardView.getFunctions

---

getIcon()

getIcon(): HTMLElement | null

Defined in: src/views/view.ts:159

Returns

HTMLElement | null

View icon. Override in subclasses.

Inherited from

CardView.getIcon

---

getInfo()

getInfo(): ViewLayout

Defined in: src/views/view.ts:312

Saves view as a ViewInfo. Only applicable to certain views, such as TableView.

Returns

ViewLayout

Inherited from

CardView.getInfo

---

getProperties()

getProperties(): Property[]

Defined in: src/views/view.ts:262

Returns all properties of this widget.

Returns

Property[]

Inherited from

CardView.getProperties

---

getRibbonPanels()

getRibbonPanels(): HTMLElement[][]

Defined in: src/views/view.ts:154

Returns

HTMLElement[][]

Inherited from

CardView.getRibbonPanels

---

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

CardView.getWidgetStatus

---

handlePath()

handlePath(_urlPath): void

Defined in: src/views/view.ts:174

Handles URL path. Override in subclasses.

Parameters

Parameter	Type
_urlPath	string

Returns

void

Inherited from

CardView.handlePath

---

loadLayout()

loadLayout(layout, pickupColumnTags?): void

Defined in: src/views/view.ts:297

Loads previously saved view layout. Only applicable to certain views, such as TableView. See also saveLayout

Parameters

Parameter	Type
layout	ViewLayout
pickupColumnTags?	boolean

Returns

void

Inherited from

CardView.loadLayout

---

loadStateMap()

loadStateMap(_stateMap): void

Defined in: src/views/view.ts:167

Loads view state map. Override in subclasses.

Parameters

Parameter	Type
_stateMap	object

Returns

void

Inherited from

CardView.loadStateMap

---

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

CardView.onEvent

---

onFrameAttached()

onFrameAttached(dataFrame): void

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

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

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

CardView.onPropertyChanged

---

pin()

pin(): void

Defined in: src/views/view.ts:290

Pins the view. Pinned views are not closed when a new view is opened.

Returns

void

Inherited from

CardView.pin

---

refresh()

refresh(): void

Defined in: src/views/card_view.ts:79

Returns

void

Inherited from

CardView.refresh

---

repaint()

repaint(): void

Defined in: src/views/card_view.ts:80

Returns

void

Inherited from

CardView.repaint

---

saveLayout()

saveLayout(options?): ViewLayout

Defined in: src/views/view.ts:305

Saves view layout as a string. Only applicable to certain views, such as TableView. See also loadLayout

Parameters

Parameter	Type
options?	{ saveWithData?: boolean; }
options.saveWithData?	boolean

Returns

ViewLayout

Inherited from

CardView.saveLayout

---

saveStateMap()

saveStateMap(): object | null

Defined in: src/views/view.ts:164

Returns

object | null

Viewer state map. Override in subclasses.

Inherited from

CardView.saveStateMap

---

setIcon()

setIcon(icon): void

Defined in: src/views/view.ts:161

Parameters

Parameter	Type
icon	HTMLElement

Returns

void

Inherited from

CardView.setIcon

---

setRibbonPanels()

setRibbonPanels(panels, clear?): void

Defined in: src/views/view.ts:150

Sets custom view panels on the ribbon.

Parameters

Parameter	Type	Default value	Description
panels	HTMLElement[][]	undefined	-
clear	boolean	true	Clear all previous before setup Sample: https://public.datagrok.ai/js/samples/ui/views/ribbon

Returns

void

Inherited from

CardView.setRibbonPanels

---

sourceRowsChanged()

sourceRowsChanged(): void

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

Returns

void

Inherited from

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

CardView.sub

---

toDart()

toDart(): any

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

Returns

any

Inherited from

CardView.toDart

---

create()

static create(options?): CardView

Defined in: src/views/card_view.ts:28

Creates a new CardView object with the specified options.

Parameters

Parameter	Type
options?	any

Returns

CardView

Inherited from

CardView.create

---

createByType()

static createByType(viewType, options?): View

Defined in: src/views/view.ts:254

Creates one of the standard views based on the view type (such as 'functions')

Parameters

Parameter	Type
viewType	string
options?	any

Returns

View

Inherited from

CardView.createByType

---

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

CardView.find

---

forObject()

static forObject(x): View | null

Defined in: src/views/view.ts:232

Creates a view for the specified object, if it is registered, or null otherwise.

Parameters

Parameter	Type
x	any

Returns

View | null

Inherited from

CardView.forObject

---

forProject()

static forProject(project): SpaceView

Defined in: src/views/space_view.ts:17

Builds the view bound to the given space.

Parameters

Parameter	Type
project	Project

Returns

SpaceView

---

fromDart()

static fromDart(dart): TableView | View

Defined in: src/views/view.ts:223

Parameters

Parameter	Type
dart	any

Returns

TableView | View

Inherited from

CardView.fromDart

---

fromRoot()

static fromRoot(root): View

Defined in: src/views/view.ts:237

Creates and returns a view with the specified element inside.

Parameters

Parameter	Type
root	HTMLElement

Returns

View

Inherited from

CardView.fromRoot

---

fromViewAsync()

static fromViewAsync(getViewAsync, ribbon?): any

Defined in: src/views/view.ts:258

Parameters

Parameter	Type	Default value
getViewAsync	() => Promise<View>	undefined
ribbon	boolean	true

Returns

any

Inherited from

CardView.fromViewAsync

---

getAll()

static getAll(): Widget<any>[]

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

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

CardView.getAll