Utils

Defined in: js-api/src/utils.ts:174

Constructors

Constructor

new Utils(): Utils

Returns

Utils

Methods

createResultsCsv()

static createResultsCsv(resultDF?): string

Defined in: js-api/src/utils.ts:400

Internal

Parameters

Parameter	Type
resultDF?	DataFrame

Returns

string

---

detectColumnHierarchy()

static detectColumnHierarchy(columns, maxDepth?): string[]

Defined in: js-api/src/utils.ts:395

Detects natural hierarchy in the list of categorical columns based on their values. Mind that the function can be n^2 in the worst case scenario, although in most cases, it is quite fast as it exits early if missmatch is found.

Parameters

Parameter	Type	Default value	Description
columns	Column<any, any>[]	undefined	List of columns to detect hierarchy in.
maxDepth	number	3	Maximum depth of the hierarchy to detect.

Returns

string[]

---

download()

static download(filename, content, contentType?): void

Defined in: js-api/src/utils.ts:239

Downloads the specified content locally

Parameters

Parameter	Type
filename	string
content	BlobPart
contentType?	string

Returns

void

---

executeTests()

static executeTests(testsParams, stopOnFail?): Promise<any>

Defined in: js-api/src/utils.ts:299

Internal

Runs the specified package tests and aggregates their results (used by the test runner).

Parameters

Parameter	Type
testsParams	object[]
stopOnFail?	boolean

Returns

Promise<any>

---

firstOrNull()

static firstOrNull<T>(iterable): T | null

Defined in: js-api/src/utils.ts:176

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
iterable	Iterable<T>

Returns

T | null

---

formatDuration()

static formatDuration(seconds): string

Defined in: js-api/src/utils.ts:416

Formats a duration in seconds as a compact human string: 45s, 3m 12s, 2h 5m.

Parameters

Parameter	Type
seconds	number

Returns

string

---

getJsonValueType()

static getJsonValueType(x): "string" | "bigint" | "object" | "bool" | "int" | "double" | "byte_array" | "datetime" | "qnum" | "dataframe" | null

Defined in: js-api/src/utils.ts:269

Parameters

Parameter	Type
x	any

Returns

"string" | "bigint" | "object" | "bool" | "int" | "double" | "byte_array" | "datetime" | "qnum" | "dataframe" | null

---

identity()

static identity(length): Uint32Array<ArrayBuffer>

Defined in: js-api/src/utils.ts:182

Returns an 'identity' array where the element in idx-th position is equals to idx.

Parameters

Parameter	Type
length	number

Returns

Uint32Array<ArrayBuffer>

---

isEmpty()

static isEmpty(s?): boolean

Defined in: js-api/src/utils.ts:204

Parameters

Parameter	Type
s?	string

Returns

boolean

---

jsonToColumns()

static jsonToColumns(column): void

Defined in: js-api/src/utils.ts:283

Expands a column of JSON strings into multiple columns, one per unique key

Parameters

Parameter	Type
column	Column<string>

Returns

void

---

loadJsCss()

static loadJsCss(files): Promise<null>

Defined in: js-api/src/utils.ts:252

Loads the specified common libraries, if they were not loaded already. Use it in plugins when a big JS dependency is used infrequently, such as exporting to Excel, or showing a 3d structure. Example: loadJsCss(['common/exceljs.min.js', 'common/exceljs.min.css'])

Parameters

Parameter	Type
files	string[]

Returns

Promise<null>

---

nullIfEmpty()

static nullIfEmpty(s?): string | null | undefined

Defined in: js-api/src/utils.ts:208

Parameters

Parameter	Type
s?	string

Returns

string | null | undefined

---

openFile()

static openFile(options): void

Defined in: js-api/src/utils.ts:213

Shows "Open File" dialog, and lets you process the result.

Parameters

Parameter	Type
options	{ accept: string; open: (file) => void; }
options.accept	string
options.open	(file) => void

Returns

void

---

openFileBytes()

static openFileBytes(options): void

Defined in: js-api/src/utils.ts:225

Shows "Open File" dialog, and lets you process the result.

Parameters

Parameter	Type
options	{ accept: string; open: (bytes) => void; }
options.accept	string
options.open	(bytes) => void

Returns

void

---

random()

static random<T>(items): T

Defined in: js-api/src/utils.ts:190

Returns random element from the array. Useful for demo data, tests, etc.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
items	T[]

Returns

T

---

randomString()

static randomString(length): string

Defined in: js-api/src/utils.ts:427

Parameters

Parameter	Type
length	number

Returns

string

---

replaceAll()

static replaceAll(string, search, replace): string

Defined in: js-api/src/utils.ts:200

Parameters

Parameter	Type
string	string
search	string
replace	string

Returns

string

---

streamToObservable()

static streamToObservable<T>(dartStream): Observable<T>

Defined in: js-api/src/utils.ts:256

Type Parameters

Type Parameter	Default type
T	any

Parameters

Parameter	Type
dartStream	any

Returns

Observable<T>

---

uuid4()

static uuid4(): string

Defined in: js-api/src/utils.ts:196

A random v4 UUID. Unlike crypto.randomUUID() this also works outside a secure context — a stand served over plain HTTP on a hostname has no randomUUID.

Returns

string