ViewLayout

Defined in: js-api/src/entities/view-layout.ts:15

Base class for system objects stored in the database in a structured manner. Contains base properties: id, name and path

Extends

• Entity

Constructors

Constructor

new ViewLayout(dart): ViewLayout

Defined in: js-api/src/entities/view-layout.ts:18

Parameters

Parameter	Type
dart	any

Returns

ViewLayout

Overrides

Entity.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
dart	public	any	Entity.dart	js-api/src/entities/entity.ts:19

Accessors

author

Get Signature

get author(): any

Defined in: js-api/src/entities/entity.ts:57

Who created entity *

Returns

any

Inherited from

Entity.author

---

boundColumnNames

Get Signature

get boundColumnNames(): string[]

Defined in: js-api/src/entities/view-layout.ts:64

Names of the columns the layout's viewers are bound to, read from its state the way the platform reads a viewer's settings: every …ColumnName and …ColumnNames setting, the Filters viewer's filters and the inner viewers of a trellis plot (a viewer whose package is not loaded, from its stored settings). Each name comes once, whatever its case. The grid binds none, since it shows whatever columns the table has. Known for any layout, one made with fromViewState too, unlike columns, which only a layout saved from a table view carries. Reading it creates no viewer.

Example

const layout = DG.ViewLayout.fromViewState(grok.shell.tv.saveLayout().viewState);
grok.shell.info(layout.boundColumnNames.join(', '));

See

https://public.datagrok.ai/js/samples/ui/views/layout-bound-columns

Returns

string[]

---

columns

Get Signature

get columns(): ColumnInfo[]

Defined in: js-api/src/entities/view-layout.ts:50

Returns

ColumnInfo[]

---

createdOn

Get Signature

get createdOn(): Dayjs

Defined in: js-api/src/entities/entity.ts:48

Time when entity was created *

Returns

Dayjs

Inherited from

Entity.createdOn

---

entityType

Get Signature

get entityType(): string

Defined in: js-api/src/entities/entity.ts:64

Entity type name *

Returns

string

Inherited from

Entity.entityType

---

friendlyName

Get Signature

get friendlyName(): string

Defined in: js-api/src/entities/entity.ts:34

Entity friendly name

Returns

string

Set Signature

set friendlyName(x): void

Defined in: js-api/src/entities/entity.ts:35

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.friendlyName

---

id

Get Signature

get id(): string

Defined in: js-api/src/entities/entity.ts:27

Entity ID (GUID)

Returns

string

Set Signature

set id(x): void

Defined in: js-api/src/entities/entity.ts:28

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.id

---

name

Get Signature

get name(): string

Defined in: js-api/src/entities/entity.ts:38

Entity short name

Returns

string

Set Signature

set name(x): void

Defined in: js-api/src/entities/entity.ts:39

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.name

---

nqName

Get Signature

get nqName(): string

Defined in: js-api/src/entities/entity.ts:42

Entity full-qualified name

Returns

string

Inherited from

Entity.nqName

---

path

Get Signature

get path(): string

Defined in: js-api/src/entities/entity.ts:45

Entity path

Returns

string

Inherited from

Entity.path

---

updatedOn

Get Signature

get updatedOn(): Dayjs | null

Defined in: js-api/src/entities/entity.ts:51

Time when entity was updated *

Returns

Dayjs | null

Inherited from

Entity.updatedOn

---

viewState

Get Signature

get viewState(): string

Defined in: js-api/src/entities/view-layout.ts:30

Returns

string

Set Signature

set viewState(state): void

Defined in: js-api/src/entities/view-layout.ts:34

Parameters

Parameter	Type
state	string

Returns

void

Methods

getProperties()

getProperties(): Promise<{[index: string]: any; }>

Defined in: js-api/src/entities/entity.ts:67

Gets entity properties

Returns

Promise<{[index: string]: any; }>

Inherited from

Entity.getProperties

---

getUserDataValue()

getUserDataValue(key): string

Defined in: js-api/src/entities/view-layout.ts:38

Parameters

Parameter	Type
key	string

Returns

string

---

hasTag()

hasTag(tag): boolean

Defined in: js-api/src/entities/entity.ts:79

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.hasTag

---

newId()

newId(): void

Defined in: js-api/src/entities/entity.ts:31

Generates new id for this entity.

Returns

void

Inherited from

Entity.newId

---

setProperties()

setProperties(props): Promise<any>

Defined in: js-api/src/entities/entity.ts:72

Sets entity properties

Parameters

Parameter	Type
props	{[index: string]: any; }

Returns

Promise<any>

Inherited from

Entity.setProperties

---

setUserDataValue()

setUserDataValue(key, value): any

Defined in: js-api/src/entities/view-layout.ts:42

Parameters

Parameter	Type
key	string
value	string

Returns

any

---

tag()

tag(tag): boolean

Defined in: js-api/src/entities/entity.ts:82

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.tag

---

toJson()

toJson(): string

Defined in: js-api/src/entities/view-layout.ts:46

Returns

string

---

toString()

toString(): string

Defined in: js-api/src/entities/entity.ts:77

Returns a string representing the object

Returns

string

Inherited from

Entity.toString

---

unTag()

unTag(tag): boolean

Defined in: js-api/src/entities/entity.ts:85

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.unTag

---

fromJson()

static fromJson(json): ViewLayout

Defined in: js-api/src/entities/view-layout.ts:22

Parameters

Parameter	Type
json	string

Returns

ViewLayout

---

fromViewState()

static fromViewState(state): ViewLayout

Defined in: js-api/src/entities/view-layout.ts:26

Parameters

Parameter	Type
state	string

Returns

ViewLayout