FileInfo

Defined in: js-api/src/entities/table-info.ts:65

Allows for files handling in JS-based info panels https://datagrok.ai/help/discover/info-panels

Extends

• Entity

Constructors

Constructor

new FileInfo(dart): FileInfo

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

Parameters

Parameter	Type
dart	any

Returns

FileInfo

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

---

connection

Get Signature

get connection(): DataConnection

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

The connection the file belongs to.

Returns

DataConnection

---

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

---

data

Get Signature

get data(): Uint8Array

Defined in: js-api/src/entities/table-info.ts:109

Returns

Uint8Array

---

entityType

Get Signature

get entityType(): string

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

Entity type name *

Returns

string

Inherited from

Entity.entityType

---

extension

Get Signature

get extension(): string

Defined in: js-api/src/entities/table-info.ts:84

Returns file extension, i.e. csv

Returns

string

---

fileName

Get Signature

get fileName(): string

Defined in: js-api/src/entities/table-info.ts:87

Returns file name, i.e. dmv_offices.csv

Returns

string

---

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

---

fullPath

Get Signature

get fullPath(): string

Defined in: js-api/src/entities/table-info.ts:78

Returns full path, i.e. Demo:TestJobs:Files:DemoFiles/geo/dmv_offices.csv

Returns

string

---

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

---

isDirectory

Get Signature

get isDirectory(): boolean

Defined in: js-api/src/entities/table-info.ts:96

Checks if directory

Returns

boolean

---

isFile

Get Signature

get isFile(): boolean

Defined in: js-api/src/entities/table-info.ts:93

Checks if file

Returns

boolean

---

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/table-info.ts:75

Returns path, i.e. geo/dmv_offices.csv

Returns

string

Overrides

Entity.path

---

updatedOn

Get Signature

get updatedOn(): Dayjs | null

Defined in: js-api/src/entities/table-info.ts:99

When the file was last modified.

Returns

Dayjs | null

Overrides

Entity.updatedOn

---

url

Get Signature

get url(): string

Defined in: js-api/src/entities/table-info.ts:90

Returns file URL

Returns

string

---

viewPath

Get Signature

get viewPath(): string

Defined in: js-api/src/entities/table-info.ts:81

Returns URL path, i.e. Demo.TestJobs.Files.DemoFiles/geo/dmv_offices.csv

Returns

string

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

---

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

---

readAsBytes()

readAsBytes(): Promise<Uint8Array<ArrayBufferLike>>

Defined in: js-api/src/entities/table-info.ts:117

Returns

Promise<Uint8Array<ArrayBufferLike>>

---

readAsString()

readAsString(): Promise<string>

Defined in: js-api/src/entities/table-info.ts:112

Reads the file content as text.

Returns

Promise<string>

---

save()

save(): Promise<FileInfo>

Defined in: js-api/src/entities/table-info.ts:122

Saves the file info on the server.

Returns

Promise<FileInfo>

---

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

---

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

---

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

---

fromBytes()

static fromBytes(path, data): FileInfo

Defined in: js-api/src/entities/table-info.ts:127

Creates a file info for [path] holding [data] in memory (not yet saved).

Parameters

Parameter	Type
path	string
data	Uint8Array

Returns

FileInfo

---

fromString()

static fromString(path, data): FileInfo

Defined in: js-api/src/entities/table-info.ts:134

Creates a file info for [path] holding [data] in memory (not yet saved).

Parameters

Parameter	Type
path	string
data	string

Returns

FileInfo