CardView

Base view for working with a collection of objects that reside on the server. Typically, results are filtered by applying AND operation between two filters: permanentFilter (which is set programmatically and is not visible) and searchValue entered by the user.

More details on the smart search syntax: https://datagrok.ai/help/datagrok/smart-search

Extends

View

Extended by

Constructors

new CardView()

new CardView(dart): CardView

Parameters

Parameter	Type
`dart`	`any`

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from
`_name`	`protected`	`string`	`'New View'`	-	`View`.`_name`	`View`.`_name`
`_root`	`protected`	`HTMLElement`	`undefined`	-	`View`.`_root`	`View`.`_root`
`dart`	`public`	`any`	`undefined`	-	`View`.`dart`	`View`.`dart`
`subs`	`public`	`Subscription`[]	`undefined`	-	`View`.`subs`	`View`.`subs`
`temp`	`public`	`any`	`undefined`	Contains auxiliary information	`View`.`temp`	`View`.`temp`
`ALL_VIEW_TYPES`	`readonly`	`string`[]	`...`	-	`View`.`ALL_VIEW_TYPES`	`View`.`ALL_VIEW_TYPES`
`APPS`	`readonly`	`"apps"`	`'apps'`	-	`View`.`APPS`	`View`.`APPS`
`BROWSE`	`readonly`	`"browse"`	`'browse'`	-	`View`.`BROWSE`	`View`.`BROWSE`
`DATABASES`	`readonly`	`"databases"`	`'databases'`	-	`View`.`DATABASES`	`View`.`DATABASES`
`DATA_CONNECTIONS`	`readonly`	`"connections"`	`'connections'`	-	`View`.`DATA_CONNECTIONS`	`View`.`DATA_CONNECTIONS`
`DATA_JOB_RUNS`	`readonly`	`"jobs"`	`'jobs'`	-	`View`.`DATA_JOB_RUNS`	`View`.`DATA_JOB_RUNS`
`DATA_QUERY_RUNS`	`readonly`	`"queryruns"`	`'queryruns'`	-	`View`.`DATA_QUERY_RUNS`	`View`.`DATA_QUERY_RUNS`
`EMAILS`	`readonly`	`"emails"`	`'emails'`	-	`View`.`EMAILS`	`View`.`EMAILS`
`FILES`	`readonly`	`"files"`	`'files'`	-	`View`.`FILES`	`View`.`FILES`
`FORUM`	`readonly`	`"forum"`	`'forum'`	-	`View`.`FORUM`	`View`.`FORUM`
`FUNCTIONS`	`readonly`	`"functions"`	`'functions'`	-	`View`.`FUNCTIONS`	`View`.`FUNCTIONS`
`GROUPS`	`readonly`	`"groups"`	`'groups'`	-	`View`.`GROUPS`	`View`.`GROUPS`
`HELP`	`readonly`	`"help"`	`'help'`	-	`View`.`HELP`	`View`.`HELP`
`JS_EDITOR`	`readonly`	`"js"`	`'js'`	-	`View`.`JS_EDITOR`	`View`.`JS_EDITOR`
`MODELS`	`readonly`	`"models"`	`'models'`	-	`View`.`MODELS`	`View`.`MODELS`
`NOTEBOOKS`	`readonly`	`"notebooks"`	`'notebooks'`	-	`View`.`NOTEBOOKS`	`View`.`NOTEBOOKS`
`OPEN_TEXT`	`readonly`	`"text"`	`'text'`	-	`View`.`OPEN_TEXT`	`View`.`OPEN_TEXT`
`PACKAGES`	`readonly`	`"packages"`	`'packages'`	-	`View`.`PACKAGES`	`View`.`PACKAGES`
`PACKAGE_REPOSITORIES`	`readonly`	`"repositories"`	`'repositories'`	-	`View`.`PACKAGE_REPOSITORIES`	`View`.`PACKAGE_REPOSITORIES`
`PROJECTS`	`readonly`	`"projects"`	`'projects'`	-	`View`.`PROJECTS`	`View`.`PROJECTS`
`QUERIES`	`readonly`	`"queries"`	`'queries'`	-	`View`.`QUERIES`	`View`.`QUERIES`
`SCRIPT`	`readonly`	`"script"`	`'script'`	-	`View`.`SCRIPT`	`View`.`SCRIPT`
`SCRIPTS`	`readonly`	`"scripts"`	`'scripts'`	-	`View`.`SCRIPTS`	`View`.`SCRIPTS`
`SETTINGS`	`readonly`	`"settings"`	`'settings'`	-	`View`.`SETTINGS`	`View`.`SETTINGS`
`SKETCH`	`readonly`	`"sketch"`	`'sketch'`	-	`View`.`SKETCH`	`View`.`SKETCH`
`USERS`	`readonly`	`"users"`	`'users'`	-	`View`.`USERS`	`View`.`USERS`
`VIEW_LAYOUTS`	`readonly`	`"layouts"`	`'layouts'`	-	`View`.`VIEW_LAYOUTS`	`View`.`VIEW_LAYOUTS`
`WEB_SERVICES`	`readonly`	`"webservices"`	`'webservices'`	-	`View`.`WEB_SERVICES`	`View`.`WEB_SERVICES`
`WELCOME`	`readonly`	`"welcome"`	`'welcome'`	-	`View`.`WELCOME`	`View`.`WELCOME`

Accessors

basePath

get basePath(): string

Deprecated

use path instead

set basePath(s): void

Parameters

Parameter	Type
`s`	`string`

Returns

string

Source

src/views/view.ts:131

box

get box(): boolean

set box(b): void

Parameters

Parameter	Type
`b`	`boolean`

Returns

boolean

Source

src/views/view.ts:77

get categoryFilters(): object

Category filter properties list

set categoryFilters(ff): void

Parameters

Parameter	Type
`ff`	`object`

Returns

object

Source

src/views/card_view.ts:56

closing

get closing(): boolean

Whether the view is currently closing.

set closing(c): void

Parameters

Parameter	Type
`c`	`boolean`

Returns

boolean

Source

src/views/view.ts:149

description

get description(): string

set description(s): void

Parameters

Parameter	Type
`s`	`string`

Returns

string

Source

src/views/view.ts:273

entity

get entity(): null | object

set entity(_e): void

Parameters

Parameter	Type
`_e`	`null` \| `object`

Returns

null | object

Source

src/views/view.ts:127

filters

get filters(): object

Text filter properties list

set filters(ff): void

Parameters

Parameter	Type
`ff`	`object`

Returns

object

Source

src/views/card_view.ts:60

helpUrl

get helpUrl(): null | string

set helpUrl(url): void

Parameters

Parameter	Type
`url`	`null` \| `string`

Returns

null | string

View help URL.

Source

src/views/view.ts:282

hierarchy

get hierarchy(): string[]

Grouping properties list

set hierarchy(s): void

Parameters

Parameter	Type
`s`	`string`[]

Returns

string[]

Source

src/views/card_view.ts:64

hierarchyProperties

get hierarchyProperties(): object

All possible grouping properties list

set hierarchyProperties(s): void

Parameters

Parameter	Type
`s`	`object`

Returns

object

Source

src/views/card_view.ts:68

id

get id(): string

Returns

string

Source

src/views/view.ts:269

Parameter	Type
`s`	`ObjectHandler`

name

get name(): string

View name. It gets shown in the tab handle.

set name(s): void

Parameters

Parameter	Type
`s`	`string`

Returns

string

Source

src/views/view.ts:315

objectType

get objectType(): string

Semantic type of the items.

set objectType(s): void

Parameters

Parameter	Type
`s`	`string`

Returns

string

Source

src/views/card_view.ts:43

parentCall

get parentCall(): undefined | FuncCall

set parentCall(s): void

Parameters

Parameter	Type
`s`	`undefined` \| `FuncCall`

Returns

undefined | FuncCall

Source

src/views/view.ts:118

parentView

get parentView(): ViewBase

set parentView(s): void

Parameters

Parameter	Type
`s`	`ViewBase`

Returns

ViewBase

Source

src/views/view.ts:121

path

get path(): string

View URI, relative to the view root

set path(s): void

Parameters

Parameter	Type
`s`	`string`

Returns

string

Source

src/views/view.ts:174

permanentFilter

get permanentFilter(): string

Programmatically defined invisible filter expression.

set permanentFilter(s): void

Parameters

Parameter	Type
`s`	`string`

Returns

string

Source

src/views/card_view.ts:52

renderMode

get renderMode(): RENDER_MODE

Render mode

set renderMode(s): void

Parameters

Parameter	Type
`s`	`RENDER_MODE`

Returns

RENDER_MODE

Source

src/views/card_view.ts:76

ribbonMenu

get ribbonMenu(): Menu

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

set ribbonMenu(menu): void

Parameters

Parameter	Type
`menu`	`Menu`

Returns

Menu

Source

src/views/view.ts:141

root

get root(): HTMLElement

Returns

HTMLElement

Source

src/views/view.ts:261

searchFields

get searchFields(): string[]

set searchFields(s): void

Parameters

Parameter	Type
`s`	`string`[]

Returns

string[]

Source

src/views/card_view.ts:46

searchValue

get searchValue(): string

User-specified filter expression.

set searchValue(s): void

Parameters

Parameter	Type
`s`	`string`

Returns

string

Source

src/views/card_view.ts:35

showTree

get showTree(): boolean

Grouping mode on

set showTree(s): void

Parameters

Parameter	Type
`s`	`boolean`

Returns

boolean

Source

src/views/card_view.ts:72

statusBarPanels

get statusBarPanels(): HTMLDivElement[]

Status bar panels to be shown on the bottom

set statusBarPanels(panels): void

Parameters

Parameter	Type
`panels`	`HTMLDivElement`[]

Returns

HTMLDivElement[]

Source

src/views/view.ts:145

toolbox

get toolbox(): HTMLElement

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

set toolbox(x): void

Parameters

Parameter	Type
`x`	`HTMLElement`

Returns

HTMLElement

Source

src/views/view.ts:136

type

get type(): string

View type

Returns

string

Source

src/views/view.ts:265

Methods

_onAdded()

_onAdded(): void

Returns

void

Inherited from

View . _onAdded

Source

src/views/view.ts:328

acceptsPath()

acceptsPath(_urlPath): boolean

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

View . acceptsPath

Source

src/views/view.ts:182

append()

append(item): HTMLElement

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

Parameters

Parameter	Type	Description
`item`	`any`

Returns

HTMLElement

Inherited from

View . append

Source

src/views/view.ts:187

appendAll()

appendAll(items): HTMLElement

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

Parameters

Parameter	Type	Description
`items`	`HTMLElement`[]

Returns

HTMLElement

Inherited from

View . appendAll

Source

src/views/view.ts:194

close()

close(): void

Closes this view.

Returns

void

Inherited from

View . close

Source

src/views/view.ts:204

detach()

detach(): void

Detaches this view.

Returns

void

Inherited from

View . detach

Source

src/views/view.ts:199

getIcon()

getIcon(): null | HTMLElement

Returns

null | HTMLElement

View icon. Override in subclasses.

Inherited from

View . getIcon

Source

src/views/view.ts:165

getInfo()

getInfo(): ViewLayout

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

Returns

ViewLayout

Inherited from

View . getInfo

Source

src/views/view.ts:308

getRibbonPanels()

getRibbonPanels(): HTMLElement[][]

Returns

HTMLElement[][]

Inherited from

View . getRibbonPanels

Source

src/views/view.ts:160

handlePath()

handlePath(_urlPath): void

Handles URL path. Override in subclasses.

Parameters

Parameter	Type
`_urlPath`	`string`

Returns

void

Inherited from

View . handlePath

Source

src/views/view.ts:178

loadLayout()

loadLayout(layout, pickupColumnTags?): void

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

View . loadLayout

Source

src/views/view.ts:293

loadStateMap()

loadStateMap(_stateMap): void

Loads view state map. Override in subclasses.

Parameters

Parameter	Type
`_stateMap`	`object`

Returns

void

Inherited from

View . loadStateMap

Source

src/views/view.ts:171

refresh()

refresh(): void

Returns

void

Source

src/views/card_view.ts:79

repaint()

repaint(): void

Returns

void

Source

src/views/card_view.ts:80

saveLayout()

saveLayout(): ViewLayout

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

Returns

ViewLayout

Inherited from

View . saveLayout

Source

src/views/view.ts:301

saveStateMap()

saveStateMap(): null | object

Returns

null | object

Viewer state map. Override in subclasses.

Inherited from

View . saveStateMap

Source

src/views/view.ts:168

setRibbonPanels()

setRibbonPanels(panels, clear): void

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

View . setRibbonPanels

Source

src/views/view.ts:156

create()

static create(options?): CardView

Creates a new CardView object with the specified options.

Parameters

Parameter	Type
`options`?	`any`

Returns

CardView

Overrides

View . create

Source

src/views/card_view.ts:28

createByType()

static createByType(viewType, options?): View

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

View . createByType

Source

src/views/view.ts:257

forObject()

static forObject(x): null | View

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

Parameters

Parameter	Type
`x`	`any`

Returns

null | View

Inherited from

View . forObject

Source

src/views/view.ts:236

fromDart()

static fromDart(dart): View | TableView

Parameters

Parameter	Type
`dart`	`any`

Returns

View | TableView

Inherited from

View . fromDart

Source

src/views/view.ts:227

fromRoot()

static fromRoot(root): View

Parameters

Parameter	Type
`root`	`HTMLElement`

Returns

View

Inherited from

View . fromRoot

Source

src/views/view.ts:240

CardView

Extends​

Extended by​

Constructors​

new CardView()​

Parameters​

Returns​

Overrides​

Source​

Properties​

Accessors​

basePath​

Deprecated​

Parameters​

Returns​

Source​

box​

Parameters​

Returns​

Source​

categoryFilters​

Parameters​

Returns​

Source​

closing​

Parameters​

Returns​

Source​

description​

Parameters​

Returns​

Source​

entity​

Parameters​

Returns​

Source​

filters​

Parameters​

Returns​

Source​

helpUrl​

Parameters​

Returns​

Source​

hierarchy​

Parameters​

Returns​

Source​

hierarchyProperties​

Parameters​

Returns​

Source​

id​

Returns​

Source​

meta​

Parameters​

Returns​

Source​

name​

Parameters​

Returns​

Source​

objectType​

Parameters​

Returns​

Source​

parentCall​

Parameters​

Returns​

Source​

parentView​

Parameters​

Returns​

Source​

path​

Parameters​

Returns​

Source​

permanentFilter​

Extends

Extended by

Constructors

new CardView()

Parameters

Returns

Overrides

Source

Properties

Accessors

basePath

Deprecated

Parameters

Returns

Source

box

Parameters

Returns

Source

categoryFilters

Parameters

Returns

Source

closing

Parameters

Returns

Source

description

Parameters

Returns

Source

entity

Parameters

Returns

Source

filters

Parameters

Returns

Source

helpUrl

Parameters

Returns

Source

hierarchy

Parameters

Returns

Source

hierarchyProperties

Parameters

Returns

Source

id

Returns

Source

meta

Parameters

Returns

Source

name

Parameters

Returns

Source

objectType

Parameters

Returns

Source

parentCall

Parameters

Returns

Source

parentView

Parameters

Returns

Source

path

Parameters

Returns

Source

permanentFilter

Parameters