Skip to main content

Module: dg

Namespaces​

Enumerations​

Classes​

Interfaces​

References​

EntityMetaDartProxy​

Re-exports EntityMetaDartProxy

ObjectHandler​

Re-exports ObjectHandler

Type Aliases​

AggregationType​

Ƭ AggregationType: `${AGG}`

Property

Property

Property

Property

Property

Property

Defined in​

src/const.ts:539

ColorCodingType​

Ƭ ColorCodingType: `${COLOR_CODING_TYPE}`

Defined in​

src/const.ts:552

ColorType​

Ƭ ColorType: number

Defined in​

src/const.ts:551

ColumnAggregationType​

Ƭ ColumnAggregationType: `${AGG}` | `${STR_AGG}` | string

Defined in​

src/const.ts:540

ColumnType​

Ƭ ColumnType: `${COLUMN_TYPE}`

Defined in​

src/const.ts:543

CsvImportColumnOptions​

Ƭ CsvImportColumnOptions: Object

Type declaration​

NameType
namestring
semType?string
type?string

Defined in​

src/const.ts:557

CsvImportOptions​

Ƭ CsvImportOptions: Object

Type declaration​

NameType
columnFilterNames?string[]
columnFilterRegexp?string
columnImportOptions?CsvImportColumnOptions[]
decimalSeparator?string
delimiter?string
headerRow?boolean
maxRows?number
mergeDelimiters?boolean
nullStrings?string[]
rowFilterProb?number
rowFilterTop?number
thousandSeparator?string

Defined in​

src/const.ts:558

DemoDatasetName​

Ƭ DemoDatasetName: `${DEMO_DATASET}`

Defined in​

src/const.ts:554

DockType​

Ƭ DockType: `${DOCK_TYPE}`

Defined in​

src/const.ts:555

ElementOptions​

Ƭ ElementOptions: Object

Type declaration​

NameType
classes?string
id?string
onClick?(event: PointerEvent) => void
processNode?(node: HTMLElement) => void
style?object

Defined in​

src/const.ts:566

GridColumnTooltipType​

Ƭ GridColumnTooltipType: "Default" | "None" | "Form" | "Columns"

Defined in​

src/grid.ts:554

IndexPredicate​

Ƭ IndexPredicate: (ind: number) => boolean

Type declaration​

▸ (ind): boolean

Parameters​
NameType
indnumber
Returns​

boolean

Defined in​

src/const.ts:562

JoinType​

Ƭ JoinType: `${JOIN_TYPE}`

Defined in​

src/const.ts:542

LegendPosition​

Ƭ LegendPosition: `${LEGEND_POSITION}`

Defined in​

src/const.ts:556

LogMessage​

Ƭ LogMessage: Object

Type declaration​

NameType
levelLOG_LEVEL
messagestring
params?object
stackTrace?string
type?string

Defined in​

src/logger.ts:7

MarkerCodingType​

Ƭ MarkerCodingType: `${MARKER_TYPE}`

Defined in​

src/const.ts:553

ObjectType​

Ƭ ObjectType: string

Defined in​

src/const.ts:545

RangeSliderStyle​

Ƭ RangeSliderStyle: "barbell" | "lines" | "thin_barbell"

Defined in​

src/widgets.ts:18

ScriptLanguage​

Ƭ ScriptLanguage: `${SCRIPT_LANGUAGE}`

Defined in​

src/const.ts:564

SemType​

Ƭ SemType: string

Defined in​

src/const.ts:548

SimilarityMetric​

Ƭ SimilarityMetric: `${SIMILARITY_METRIC}`

Defined in​

src/const.ts:549

SliderOptions​

Ƭ SliderOptions: Object

Type declaration​

NameType
style?RangeSliderStyle

Defined in​

src/widgets.ts:20

StringPredicate​

Ƭ StringPredicate: (str: string) => boolean

Type declaration​

▸ (str): boolean

Parameters​
NameType
strstring
Returns​

boolean

Defined in​

src/const.ts:563

StructureFilterType​

Ƭ StructureFilterType: `${STRUCTURE_FILTER_TYPE}`

Defined in​

src/const.ts:550

SyncType​

Ƭ SyncType: `${SYNC_TYPE}`

Defined in​

src/const.ts:541

Type​

Ƭ Type: `${TYPE}`

Defined in​

src/const.ts:547

ViewerPropertyType​

Ƭ ViewerPropertyType: string

Defined in​

src/const.ts:546

ViewerType​

Ƭ ViewerType: `${VIEWER}` | string

Defined in​

src/const.ts:544

fileShares​

Ƭ fileShares: "S3"

Defined in​

src/widgets.ts:1742

Variables​

DEFAULT_SKETCHER​

• Const DEFAULT_SKETCHER: "OpenChemLib"

Defined in​

src/chem.ts:20

FLOAT_NULL​

• Const FLOAT_NULL: 2.6789344063684636e-34

Defined in​

src/const.ts:56

FUNC_TYPES​

• Const FUNC_TYPES: Object

Type declaration​

NameTypeDescription
APPstringAn application that gets shown in the app store. Signature: app()
AUTOSTARTstringGets invoked at platform startup. Use it wisely as the whole package will get initialized. Signature: autostart()
CELL_RENDERERstringCreates a cell renderer that is used for rendering cells for specific semantic types. Semantic type is derived from the cellRenderer-<semType> tag. Signature: cellRenderer(): GridCellRenderer
CONVERTERstringConverts values. Has one input and one output
DASHBOARDstringMakes a widget appear on the welcome screen Signature: dashboard(): DG.Widget
FILE_EXPORTERstringExports a file. Gets added to the "export" menu at startup. Signature: fileExporter()
FILE_IMPORTERstringHandles custom file formats. The meta.ext parameter should contain a comma-separated list of extensions. Signature: fileImporter(x: string | TypedArray): DataFrame[]
FILE_VIEWERstringCreates a viewer (or editor) for a file with the specified extension. The extension is derived from the fileViewer-<extension> tag. Used in the file system browser. Signature: fileViewer(FileInfo): View
FUNCTION_ANALYSISstringFunction analysis. Examples: sensitivity analysis, parameter editor Func => View
INITstringGets invoked when the containing package is initialized Signature: init()
PACKAGE_SETTINGS_EDITORstringEdits package settings. Signature: packageSettingsEditor(): Widget
PANELstringContext-specific widget that appears on the context panel Signature: panel(x: any): Widget
SEM_TYPE_DETECTORstringSemantic type detector for a column. Gets invoked when a new dataframe is imported into the platform. Implementation should either set column.semType directly, or return the semantic type that will get assigned. Signature: semTypeDetector(Column): string

Defined in​

src/const.ts:290

INT_NULL​

• Const INT_NULL: -2147483648

Defined in​

src/const.ts:55

MapProxy​

• Const MapProxy: typeof __class

Proxies a Dart Map, API-compliant to ES 2015+

Defined in​

src/utils.ts:257

QNUM_EXACT​

• Const QNUM_EXACT: 2

Defined in​

src/dataframe.ts:2063

QNUM_GREATER​

• Const QNUM_GREATER: 3

Defined in​

src/dataframe.ts:2064

QNUM_LESS​

• Const QNUM_LESS: 1

Defined in​

src/dataframe.ts:2062

TAGS​

• Const TAGS: Object

Type declaration​

NameTypeDescription
ALLOW_RENAMEstring-
AUTO_CHOICESstringWhen set to 'true', switches the cell editor to a combo box that only allows to choose values from a list of already existing values in the column. Applicable for string columns only. See also [TAGS_CHOICES].
CELL_RENDERERstring-
CHEM{ SCAFFOLD: string = 'chem-scaffold' }-
CHEM.SCAFFOLDstring-
CHOICESstringJSON-encoded list of strings to be used in a cell editor. Applicable for string columns only.
COLOR_CODING_CATEGORICALstring-
COLOR_CODING_CONDITIONALstring-
COLOR_CODING_LINEARstring-
COLOR_CODING_SCHEME_MAXstring-
COLOR_CODING_SCHEME_MINstring-
COLOR_CODING_TYPEstring-
CUSTOM_FILTER_TYPEstringCustom filter type to be used by default for a column: "<PackageName>:<FilterType>". Takes precedence over [IGNORE_CUSTOM_FILTER]
DESCRIPTIONstring-
FORMATstringSet on a dataframe column; used to format column contents in grids, CSV export, passing to scripts
FORMULAstring-
FORMULA_LINESstring-
FRIENDLY_NAMEstring-
IDstring-
IGNORE_CUSTOM_FILTERstringBoolean flag to control custom filters visibility.
LAYOUT_IDstring-
MARKER_CODINGstring-
MULTI_VALUE_SEPARATORstringSeparator used to parse a cell value into multiple values for filter categories.
SEMTYPEstring-
SOURCE_PRECISIONstringWhen a dataframe is loaded from a CSV, the maximum number of significant digits in the fractional part for each numeric column is determined
STRUCTURE_FILTER_TYPEstringFilter type for molecular columns: "Sketch" | "Categorical". See [DG.STRUCTURE_FILTER_TYPE]
TOOLTIPstring-
UNITSstring-

Defined in​

src/const.ts:238

TYPES_SCALAR​

• Const TYPES_SCALAR: Set<TYPE>

Defined in​

src/const.ts:151

UNITS​

• Const UNITS: Object

Type declaration​

NameType
Molecule{ INCHI: string = 'inchi'; MOLBLOCK: string = 'molblock'; SMILES: string = 'smiles'; V3K_MOLBLOCK: string = 'v3Kmolblock' }
Molecule.INCHIstring
Molecule.MOLBLOCKstring
Molecule.SMILESstring
Molecule.V3K_MOLBLOCKstring

Defined in​

src/const.ts:204

WHITE_MOLBLOCK​

• Const WHITE_MOLBLOCK: "\n Datagrok empty molecule\n\n 0 0 0 0 0 0 0 0 0 0999 V2000\nM END\n"

Defined in​

src/chem.ts:21

WHITE_MOLBLOCK_V_3000​

• Const WHITE_MOLBLOCK_V_3000: "Datagrok macromolecule handler\n0 0 0 0 0 0 999 V3000\nM V30 BEGIN CTAB\nM V30 COUNTS 0 0 0 0 0\nM V30 END CTAB\nM END\n$$$$"

Defined in​

src/chem.ts:27

Functions​

__obs​

▸ __obs(eventId, object?): Observable<any>

Parameters​

NameTypeDefault value
eventIdstringundefined
objectanynull

Returns​

Observable<any>

Defined in​

src/events.ts:17

_getIterator​

▸ _getIterator(dart): Object

Parameters​

NameType
dartany

Returns​

Object

NameType
next() => { done: boolean = false; value: any } | { done: boolean = true; value: undefined }

Defined in​

src/utils.ts:368

_identityInt32​

▸ _identityInt32(length): Int32Array

Parameters​

NameType
lengthnumber

Returns​

Int32Array

Defined in​

src/utils.ts:444

_isDartium​

▸ _isDartium(): boolean

Returns​

boolean

Defined in​

src/utils.ts:379

_options​

▸ _options(element, options): HTMLElement

Parameters​

NameType
elementHTMLElement
optionsany

Returns​

HTMLElement

Defined in​

src/utils.ts:606

_propsToDart​

▸ _propsToDart(s, cls): string

Converts entity properties between JavaScript and Dart. See also: include

Parameters​

NameType
sstring
clsstring

Returns​

string

Defined in​

src/utils.ts:628

_sub​

▸ _sub(dart): StreamSubscription

Parameters​

NameType
dartany

Returns​

StreamSubscription

Defined in​

src/events.ts:290

_toIterable​

▸ _toIterable(dart): Iterable<any>

Parameters​

NameType
dartany

Returns​

Iterable<any>

Defined in​

src/utils.ts:360

_toJson​

▸ _toJson(x): null | string

Parameters​

NameType
xany

Returns​

null | string

Defined in​

src/utils.ts:390

callFuncWithDartParameters​

▸ callFuncWithDartParameters<T>(f, params, dartResult): T

Type parameters​

Name
T

Parameters​

NameType
f(...params: any[]) => T
paramsobject
dartResultboolean

Returns​

T

Defined in​

src/functions.ts:285

debounce​

▸ debounce<T>(observable, milliseconds?): rxjs.Observable<T>

Type parameters​

Name
T

Parameters​

NameTypeDefault value
observableObservable<T>undefined
millisecondsnumber100

Returns​

rxjs.Observable<T>

Defined in​

src/events.ts:13

format​

▸ format(x, format?): string

Parameters​

NameType
xnumber
format?string

Returns​

string

Defined in​

src/utils.ts:675

identity​

▸ identity(length): Uint32Array

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

Parameters​

NameType
lengthnumber

Returns​

Uint32Array

Defined in​

src/utils.ts:400

observeStream​

▸ observeStream(dartStream): Observable<any>

Converts Dart stream to rxjs.Observable.

Parameters​

NameType
dartStreamany

Returns​

Observable<any>

Defined in​

src/events.ts:50

paramsToJs​

▸ paramsToJs(params): any

Converts list of Dart objects to JavaScript objects by calling toJs

Parameters​

NameType
paramsany

Returns​

any

  • list of JavaScript objects

Defined in​

src/wrappers_impl.ts:9

range​

▸ range(length): Generator<number, void, unknown>

Parameters​

NameType
lengthnumber

Returns​

Generator<number, void, unknown>

Defined in​

src/utils.ts:394

time​

▸ time(name, f): any

Times the execution of function f

Parameters​

NameTypeDescription
namestringa label for the execution time to display
fFunctionfunction with no parameters that will get measured

Returns​

any

  • a value which f returns

Defined in​

src/utils.ts:416

timeAsync​

▸ timeAsync(name, f): Promise<any>

Times the execution of asyncronous function f

Async

Parameters​

NameTypeDescription
namestringa label for the execution time to display
fFunctionasync function with no parameters that will get measured

Returns​

Promise<any>

  • a promise for the value which f returns

Defined in​

src/utils.ts:433

toDart​

▸ toDart(x): any

Extracts a Dart handle from the JavaScript wrapper. See also toJs

Parameters​

NameType
xany

Returns​

any

Defined in​

src/wrappers_impl.ts:72

toJs​

▸ toJs(dart, check?): any

Instantiates the corresponding JS handler for the Dart object [dart]. See also toDart

Parameters​

NameTypeDefault valueDescription
dartanyundefinedDart handle
checkbooleanfalsewhen true, throws an exception if the object can't be converted to JS.

Returns​

any

JavaScript wrapper for the Dart object

Defined in​

src/wrappers_impl.ts:29