Project

Represents a project

Extends

• Entity

Constructors

new Project()

new Project(dart): Project

Parameters

Parameter	Type
dart	any

Returns

Project

Overrides

Entity . constructor

Source

src/entities.ts:355

Properties

Property	Modifier	Type	Inherited from
dart	public	any	Entity.dart
options	public	any	-

Accessors

author

get author(): User

Who created entity *

Returns

User

Source

src/entities.ts:125

---

children

get children(): Entity[]

Returns

Entity[]

Source

src/entities.ts:418

---

createdOn

get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Source

src/entities.ts:116

---

description

get description(): string

Project description

Returns

string

Source

src/entities.ts:382

---

entityType

get entityType(): string

Entity type name *

Returns

string

Source

src/entities.ts:128

---

friendlyName

get friendlyName(): string

Entity friendly name

set friendlyName(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:102

---

id

get id(): string

Entity ID (GUID)

set id(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:94

---

isDashboard

get isDashboard(): boolean

Returns

boolean

Source

src/entities.ts:396

---

isDirty

get isDirty(): boolean

Project changes flag

Returns

boolean

Source

src/entities.ts:387

---

isEmpty

get isEmpty(): boolean

Project is empty flag

Returns

boolean

Source

src/entities.ts:392

---

isLocal

get isLocal(): string

Returns

string

Source

src/entities.ts:377

---

isOnServer

get isOnServer(): string

Returns

string

Source

src/entities.ts:373

---

isPackage

get isPackage(): boolean

Returns

boolean

Source

src/entities.ts:400

---

links

get links(): Entity[]

Returns

Entity[]

Source

src/entities.ts:414

---

name

get name(): string

Entity short name

set name(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:106

---

nqName

get nqName(): string

Entity full-qualified name

Returns

string

Source

src/entities.ts:110

---

path

get path(): string

Entity path

Returns

string

Source

src/entities.ts:369

---

pictureUrl

get pictureUrl(): string

Returns

string

Source

src/entities.ts:365

---

updatedOn

get updatedOn(): null | Dayjs

Time when entity was updated *

Returns

null | Dayjs

Source

src/entities.ts:119

Methods

addChild()

addChild(entity): void

Parameters

Parameter	Type
entity	DataFrame | Entity

Returns

void

Source

src/entities.ts:428

---

addLink()

addLink(entity): void

Parameters

Parameter	Type
entity	DataFrame | Entity

Returns

void

Source

src/entities.ts:422

---

getProperties()

getProperties(): Promise<object>

Gets entity properties

Returns

Promise<object>

Inherited from

Entity . getProperties

Source

src/entities.ts:131

---

hasTag()

hasTag(tag): boolean

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . hasTag

Source

src/entities.ts:143

---

newId()

newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity . newId

Source

src/entities.ts:98

---

open()

open(options?): Promise <Project>

Opens the project in workspace

Parameters

Parameter	Type
options?	ProjectOpenOptions

Returns

Promise <Project>

Source

src/entities.ts:409

---

removeChild()

removeChild(entity): void

Parameters

Parameter	Type
entity	Entity

Returns

void

Source

src/entities.ts:438

---

removeLink()

removeLink(entity): void

Parameters

Parameter	Type
entity	Entity

Returns

void

Source

src/entities.ts:434

---

setProperties()

setProperties(props): Promise<any>

Sets entity properties

Parameters

Parameter	Type
props	object

Returns

Promise<any>

Inherited from

Entity . setProperties

Source

src/entities.ts:136

---

tag()

tag(tag): boolean

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . tag

Source

src/entities.ts:146

---

toMarkup()

toMarkup(): string

Returns

string

Source

src/entities.ts:404

---

toString()

toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity . toString

Source

src/entities.ts:141

---

unTag()

unTag(tag): boolean

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . unTag

Source

src/entities.ts:149

---

create()

static create(): Project

Returns

Project

Source

src/entities.ts:363