ViewLayout

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

Extends

• Entity

Constructors

new ViewLayout()

new ViewLayout(dart): ViewLayout

Parameters

Parameter	Type
dart	any

Returns

ViewLayout

Overrides

Entity . constructor

Constructs

ViewLayout

Source

src/entities.ts:1859

Properties

Property	Modifier	Type	Inherited from
dart	public	any	Entity.dart

Accessors

author

get author(): User

Who created entity *

Returns

User

Source

src/entities.ts:124

---

columns

get columns(): ColumnInfo[]

Returns

ColumnInfo[]

Source

src/entities.ts:1891

---

createdOn

get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Source

src/entities.ts:115

---

friendlyName

get friendlyName(): string

Entity friendly name

set friendlyName(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:101

---

id

get id(): string

Entity ID (GUID)

set id(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:93

---

name

get name(): string

Entity short name

set name(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:105

---

nqName

get nqName(): string

Entity full-qualified name

Returns

string

Source

src/entities.ts:109

---

path

get path(): string

Entity path

Returns

string

Source

src/entities.ts:112

---

updatedOn

get updatedOn(): null | Dayjs

Time when entity was updated *

Returns

null | Dayjs

Source

src/entities.ts:118

---

viewState

get viewState(): string

set viewState(state): void

Parameters

Parameter	Type
state	string

Returns

string

Source

src/entities.ts:1871

Methods

getProperties()

getProperties(): Promise<object>

Gets entity properties

Returns

Promise<object>

Inherited from

Entity . getProperties

Source

src/entities.ts:127

---

getUserDataValue()

getUserDataValue(key): string

Parameters

Parameter	Type
key	string

Returns

string

Source

src/entities.ts:1879

---

hasTag()

hasTag(tag): boolean

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . hasTag

Source

src/entities.ts:139

---

newId()

newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity . newId

Source

src/entities.ts:97

---

setProperties()

setProperties(props): Promise<any>

Sets entity properties

Parameters

Parameter	Type
props	object

Returns

Promise<any>

Inherited from

Entity . setProperties

Source

src/entities.ts:132

---

setUserDataValue()

setUserDataValue(key, value): any

Parameters

Parameter	Type
key	string
value	string

Returns

any

Source

src/entities.ts:1883

---

tag()

tag(tag): boolean

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . tag

Source

src/entities.ts:142

---

toJson()

toJson(): string

Returns

string

Source

src/entities.ts:1887

---

toString()

toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity . toString

Source

src/entities.ts:137

---

unTag()

unTag(tag): boolean

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . unTag

Source

src/entities.ts:145

---

fromJson()

static fromJson(json): ViewLayout

Parameters

Parameter	Type
json	string

Returns

ViewLayout

Source

src/entities.ts:1863

---

fromViewState()

static fromViewState(state): ViewLayout

Parameters

Parameter	Type
state	string

Returns

ViewLayout

Source

src/entities.ts:1867