Class: Project

dg.Project

Represents a project

Hierarchy

• Entity

  ↳ Project

Constructors

constructor

• new Project(dart)

Parameters

Name	Type
dart	any

Overrides

Entity.constructor

Defined in

src/entities.ts:310

Properties

dart

• dart: any

Inherited from

Entity.dart

Defined in

src/entities.ts:67

---

options

• options: any

Defined in

src/entities.ts:316

Accessors

author

• get author(): User

Who created entity *

Returns

User

Inherited from

Entity.author

Defined in

src/entities.ts:104

---

children

• get children(): Entity[]

Returns

Entity[]

Defined in

src/entities.ts:365

---

createdOn

• get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Inherited from

Entity.createdOn

Defined in

src/entities.ts:98

---

description

• get description(): string

Project description

Returns

string

Defined in

src/entities.ts:337

---

friendlyName

• get friendlyName(): string

Entity friendly name

Returns

string

Inherited from

Entity.friendlyName

Defined in

src/entities.ts:84

• set friendlyName(x): void

Parameters

Name	Type
x	string

Returns

void

Inherited from

Entity.friendlyName

Defined in

src/entities.ts:85

---

id

• get id(): string

Entity ID (GUID)

Returns

string

Inherited from

Entity.id

Defined in

src/entities.ts:76

• set id(x): void

Parameters

Name	Type
x	string

Returns

void

Inherited from

Entity.id

Defined in

src/entities.ts:77

---

isDirty

• get isDirty(): boolean

Project changes flag

Returns

boolean

Defined in

src/entities.ts:342

---

isEmpty

• get isEmpty(): boolean

Project is empty flag

Returns

boolean

Defined in

src/entities.ts:347

---

isLocal

• get isLocal(): string

Returns

string

Defined in

src/entities.ts:332

---

isOnServer

• get isOnServer(): string

Returns

string

Defined in

src/entities.ts:328

---

links

• get links(): Entity[]

Returns

Entity[]

Defined in

src/entities.ts:361

---

name

• get name(): string

Entity short name

Returns

string

Inherited from

Entity.name

Defined in

src/entities.ts:88

• set name(x): void

Parameters

Name	Type
x	string

Returns

void

Inherited from

Entity.name

Defined in

src/entities.ts:89

---

nqName

• get nqName(): string

Entity full-qualified name

Returns

string

Inherited from

Entity.nqName

Defined in

src/entities.ts:92

---

path

• get path(): string

Entity path

Returns

string

Overrides

Entity.path

Defined in

src/entities.ts:324

---

pictureUrl

• get pictureUrl(): string

Returns

string

Defined in

src/entities.ts:320

---

updatedOn

• get updatedOn(): Dayjs

Time when entity was updated *

Returns

Dayjs

Inherited from

Entity.updatedOn

Defined in

src/entities.ts:101

Methods

addChild

▸ addChild(entity): void

Parameters

Name	Type
entity	Entity | DataFrame

Returns

void

Defined in

src/entities.ts:375

---

addLink

▸ addLink(entity): void

Parameters

Name	Type
entity	Entity | DataFrame

Returns

void

Defined in

src/entities.ts:369

---

getProperties

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

Gets entity properties

Returns

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

Inherited from

Entity.getProperties

Defined in

src/entities.ts:107

---

hasTag

▸ hasTag(tag): boolean

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

Entity.hasTag

Defined in

src/entities.ts:119

---

newId

▸ newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity.newId

Defined in

src/entities.ts:80

---

open

▸ open(options?): Promise<Project>

Opens the project in workspace

Parameters

Name	Type
options?	ProjectOpenOptions

Returns

Promise<Project>

Defined in

src/entities.ts:356

---

removeChild

▸ removeChild(entity): void

Parameters

Name	Type
entity	Entity

Returns

void

Defined in

src/entities.ts:385

---

removeLink

▸ removeLink(entity): void

Parameters

Name	Type
entity	Entity

Returns

void

Defined in

src/entities.ts:381

---

setProperties

▸ setProperties(props): Promise<any>

Sets entity properties

Parameters

Name	Type
props	Object

Returns

Promise<any>

Inherited from

Entity.setProperties

Defined in

src/entities.ts:112

---

tag

▸ tag(tag): boolean

Adds a specified tag

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

Entity.tag

Defined in

src/entities.ts:122

---

toMarkup

▸ toMarkup(): string

Returns

string

Defined in

src/entities.ts:351

---

toString

▸ toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity.toString

Defined in

src/entities.ts:117

---

unTag

▸ unTag(tag): boolean

Removes a specified tag

Parameters

Name	Type
tag	string

Returns

boolean

Inherited from

Entity.unTag

Defined in

src/entities.ts:125

---

create

▸ Static create(): Project

Returns

Project

Defined in

src/entities.ts:318