Module: dg
Namespaces
Enumerations
- AGG
- COLOR_CODING_TYPE
- COLUMN_TYPE
- DEMO_DATASET
- DOCK_TYPE
- FILTER_TYPE
- FUNC_OPTIONS
- GRID_COLUMN_TAGS
- JOIN_TYPE
- LEGEND_POSITION
- LINE_CHART_SERIES_TYPE
- LOG_LEVEL
- MARKER_TYPE
- NAMED_VALIDATORS
- PERMISSION
- RENDER_MODE
- SCRIPT_LANGUAGE
- SEMTYPE
- SIMILARITY_METRIC
- STATS
- STAT_COUNTS
- STRUCTURE_FILTER_TYPE
- STR_AGG
- SYNC_TYPE
- TYPE
- USER_STATUS
- VIEWER
- VIEWER_PROPERTY_TYPE
- VIEW_TYPE
Classes
- Accordion
- AccordionPane
- AdminDataSource
- Balloon
- BigIntColumn
- BitSet
- Breadcrumbs
- CanvasRenderer
- CardView
- Cell
- ChoiceInput
- ClientCache
- Color
- Column
- ColumnColorHelper
- ColumnComboBox
- ColumnDialogHelper
- ColumnInfo
- ColumnList
- ColumnMarkerHelper
- ColumnMetaHelper
- ColumnsArgs
- Context
- Credentials
- CredentialsDataSource
- CustomCardView
- Dapi
- DartList
- DartWidget
- Data
- DataConnection
- DataConnectionsDataSource
- DataFrame
- DataFrameDialogHelper
- DataFrameFormulaLinesHelper
- DataFrameMetaHelper
- DataFramePlotHelper
- DataJob
- DataQuery
- DateInput
- DateTimeColumn
- Db
- DemoDatasets
- Detector
- Dialog
- DockContainer
- DockManager
- DockNode
- DockView
- DockerContainer
- DockerContainersDataSource
- DockerDataSource
- DockerImage
- DockerImagesDataSource
- DropDown
- EntitiesDataSource
- Entity
- EventBus
- EventData
- Events
- FileInfo
- FileSource
- Files
- FilesView
- FilesWidget
- Filter
- FilterGroup
- Form
- FormViewer
- FormulaLinesHelper
- Func
- FuncCall
- FuncCallParam
- FuncOptions
- FuncParamOptions
- FuncsDataSource
- Functions
- Grid
- GridCell
- GridCellRenderArgs
- GridCellRenderer
- GridCellRendererProxy
- GridCellStyle
- GridCellStyleEx
- GridColumn
- GridColumnList
- Group
- GroupByBuilder
- GroupsDataSource
- HistoryEntry
- HtmlTable
- HttpDataSource
- InputBase
- JsInputBase
- JsViewer
- LayoutsDataSource
- Legend
- LineChartViewer
- LogEvent
- LogEventParameter
- LogEventParameterValue
- LogEventType
- Logger
- LruCache
- Menu
- Model
- MultiView
- Notebook
- ObjectColumn
- ObjectPropertyBag
- Package
- PackageLogger
- PermissionsDataSource
- Point
- ProgressIndicator
- Project
- ProjectsDataSource
- ProjectsView
- Property
- PropertyGrid
- Qnum
- RangeSlider
- Rect
- Row
- RowGroup
- RowList
- RowMatcher
- ScatterPlotViewer
- Script
- ScriptEnvironment
- ScriptView
- ScriptsView
- SearchResult
- SemanticValue
- Settings
- Shell
- ShellContextPanel
- ShellHelpPanel
- Stats
- StepEditor
- StreamSubscription
- StringUtils
- TabControl
- TabPane
- TableInfo
- TableQuery
- TableQueryBuilder
- TableView
- TablesDataSource
- TagEditor
- TagElement
- Tags
- TagsInput
- TaskBarProgressIndicator
- ToolboxPage
- TreeViewGroup
- TreeViewNode
- TypeAhead
- TypedEventArgs
- User
- UserDataStorage
- UserSession
- UsersDataSource
- Utils
- ValueMatcher
- View
- ViewBase
- ViewLayout
- Viewer
- ViewerFormulaLinesHelper
- ViewerMetaHelper
- VirtualView
- Widget
- Windows
- Wizard
Interfaces
- ColumnCsvExportOptions
- ColumnsCsvExportOptions
- CsvExportOptions
- FilterState
- FormulaLine
- FormulaLineMeta
- GridCellArgs
- IBarChartLookSettings
- IBoxPlotLookSettings
- ICalendarLookSettings
- ICardLookSettings
- ICorrelationPlotLookSettings
- IDensityPlotLookSettings
- IFiltersLookSettings
- IFormLookSettings
- IFunctionCallOptions
- IFunctionRegistrationData
- IGridLookSettings
- IHistogramLookSettings
- ILineChartLookSettings
- IMapViewerLookSettings
- IMarkupViewerLookSettings
- IMatrixPlotLookSettings
- IMenuItemOptions
- IMenuItemsOptions
- INetworkDiagramLookSettings
- IPcPlotLookSettings
- IPieChartLookSettings
- IPivotViewerLookSettings
- IPoint
- IScatterPlot3dLookSettings
- IScatterPlotLookSettings
- IShowMenuOptions
- IStatsViewerLookSettings
- ITileViewerLookSettings
- ITreeMapLookSettings
- ITrellisPlotLookSettings
- IViewStateApplicationOptions
- MapChangeArgs
- MultiViewOptions
- ProjectOpenOptions
- PropertyOptions
- SemTypeInfo
- ServiceInfo
- ViewArgs
- ViewerArgs
- WizardPage
References
EntityMetaDartProxy
Re-exports EntityMetaDartProxy
ObjectHandler
Re-exports ObjectHandler
Type Aliases
AggregationType
Ƭ AggregationType: `${AGG}`
Property
Property
Property
Property
Property
Property
Defined in
ColorCodingType
Ƭ ColorCodingType: `${COLOR_CODING_TYPE}`
Defined in
ColorType
Ƭ ColorType: number
Defined in
ColumnAggregationType
Ƭ ColumnAggregationType: `${AGG}` | `${STR_AGG}` | string
Defined in
ColumnType
Ƭ ColumnType: `${COLUMN_TYPE}`
Defined in
CsvImportColumnOptions
Ƭ CsvImportColumnOptions: Object
Type declaration
Name | Type |
---|---|
name | string |
semType? | string |
type? | string |
Defined in
CsvImportOptions
Ƭ CsvImportOptions: Object
Type declaration
Name | Type |
---|---|
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
DemoDatasetName
Ƭ DemoDatasetName: `${DEMO_DATASET}`
Defined in
DockType
Ƭ DockType: `${DOCK_TYPE}`
Defined in
ElementOptions
Ƭ ElementOptions: Object
Type declaration
Name | Type |
---|---|
classes? | string |
id? | string |
onClick? | (event : PointerEvent ) => void |
processNode? | (node : HTMLElement ) => void |
style? | object |
Defined in
GridColumnTooltipType
Ƭ GridColumnTooltipType: "Default"
| "None"
| "Form"
| "Columns"
Defined in
HorzAlign
Ƭ HorzAlign: "right"
| "center"
| "left"
Defined in
IndexPredicate
Ƭ IndexPredicate: (ind
: number
) => boolean
Type declaration
▸ (ind
): boolean
Parameters
Name | Type |
---|---|
ind | number |
Returns
boolean
Defined in
JoinType
Ƭ JoinType: `${JOIN_TYPE}`
Defined in
LegendPosition
Ƭ LegendPosition: `${LEGEND_POSITION}`
Defined in
LogMessage
Ƭ LogMessage: Object
Type declaration
Name | Type |
---|---|
level | LOG_LEVEL |
message | string |
params? | object |
stackTrace? | string |
type? | string |
Defined in
MarkerCodingType
Ƭ MarkerCodingType: `${MARKER_TYPE}`
Defined in
ObjectType
Ƭ ObjectType: string
Defined in
RangeSliderStyle
Ƭ RangeSliderStyle: "barbell"
| "lines"
| "thin_barbell"
Defined in
ScriptLanguage
Ƭ ScriptLanguage: `${SCRIPT_LANGUAGE}`
Defined in
SemType
Ƭ SemType: string
Defined in
SimilarityMetric
Ƭ SimilarityMetric: `${SIMILARITY_METRIC}`
Defined in
SliderOptions
Ƭ SliderOptions: Object
Type declaration
Name | Type |
---|---|
style? | RangeSliderStyle |
Defined in
StringPredicate
Ƭ StringPredicate: (str
: string
) => boolean
Type declaration
▸ (str
): boolean
Parameters
Name | Type |
---|---|
str | string |
Returns
boolean
Defined in
StructureFilterType
Ƭ StructureFilterType: `${STRUCTURE_FILTER_TYPE}`
Defined in
SyncType
Ƭ SyncType: `${SYNC_TYPE}`
Defined in
Type
Ƭ Type: `${TYPE}`
Defined in
TypeAheadConfig
Ƭ TypeAheadConfig: Omit
<typeaheadConfig
<Dictionary
>, "input"
| "className"
>
Defined in
VertAlign
Ƭ VertAlign: "top"
| "center"
| "bottom"
Defined in
ViewerPropertyType
Ƭ ViewerPropertyType: string
Defined in
ViewerType
Ƭ ViewerType: `${VIEWER}` | string
Defined in
fileShares
Ƭ fileShares: "S3"
Defined in
Variables
DEFAULT_SKETCHER
• Const
DEFAULT_SKETCHER: "OpenChemLib"
Defined in
FLOAT_NULL
• Const
FLOAT_NULL: 2.6789344063684636e-34
Defined in
FUNC_TYPES
• Const
FUNC_TYPES: Object
Type declaration
Name | Type | Description |
---|---|---|
APP | string | An application that gets shown in the app store. Signature: app() |
AUTOSTART | string | Gets invoked at platform startup. Use it wisely as the whole package will get initialized. Signature: autostart() |
CELL_RENDERER | string | Creates 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 |
CONVERTER | string | Converts values. Has one input and one output |
DASHBOARD | string | Makes a widget appear on the welcome screen Signature: dashboard(): DG.Widget |
FILE_EXPORTER | string | Exports a file. Gets added to the "export" menu at startup. Signature: fileExporter() |
FILE_IMPORTER | string | Handles custom file formats. The meta.ext parameter should contain a comma-separated list of extensions. Signature: fileImporter(x: string | TypedArray): DataFrame[] |
FILE_VIEWER | string | Creates 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_ANALYSIS | string | Function analysis. Examples: sensitivity analysis, parameter editor Func => View |
INIT | string | Gets invoked when the containing package is initialized Signature: init() |
PACKAGE_SETTINGS_EDITOR | string | Edits package settings. Signature: packageSettingsEditor(): Widget |
PANEL | string | Context-specific widget that appears on the context panel Signature: panel(x: any): Widget |
SEM_TYPE_DETECTOR | string | Semantic 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
INT_NULL
• Const
INT_NULL: -2147483648
Defined in
InputType
• Const
InputType: Object
Type declaration
Name | Type |
---|---|
BigInt | string |
Bool | string |
Choice | string |
Color | string |
Column | string |
Date | string |
Float | string |
Int | string |
List | string |
Map | string |
MultiChoice | string |
QNum | string |
Radio | string |
Slider | string |
Table | string |
Text | string |
TextArea | string |
Defined in
MapProxy
• Const
MapProxy: typeof __class
Proxies a Dart Map, API-compliant to ES 2015+
Defined in
QNUM_EXACT
• Const
QNUM_EXACT: 2
Defined in
QNUM_GREATER
• Const
QNUM_GREATER: 3
Defined in
QNUM_LESS
• Const
QNUM_LESS: 1
Defined in
TAGS
• Const
TAGS: Object
Type declaration
Name | Type | Description |
---|---|---|
ALLOW_RENAME | string | - |
AUTO_CHOICES | string | When 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_RENDERER | string | - |
CHEM | { SCAFFOLD : string = 'chem-scaffold' } | - |
CHEM.SCAFFOLD | string | - |
CHOICES | string | JSON-encoded list of strings to be used in a cell editor. Applicable for string columns only. |
COLOR_CODING_CATEGORICAL | string | - |
COLOR_CODING_CONDITIONAL | string | - |
COLOR_CODING_LINEAR | string | - |
COLOR_CODING_SCHEME_MAX | string | - |
COLOR_CODING_SCHEME_MIN | string | - |
COLOR_CODING_TYPE | string | - |
CUSTOM_FILTER_TYPE | string | Custom filter type to be used by default for a column: "<PackageName>:<FilterType>". Takes precedence over [IGNORE_CUSTOM_FILTER] |
DESCRIPTION | string | - |
FORMAT | string | Set on a dataframe column; used to format column contents in grids, CSV export, passing to scripts |
FORMULA | string | - |
FORMULA_LINES | string | - |
FRIENDLY_NAME | string | - |
ID | string | - |
IGNORE_CUSTOM_FILTER | string | Boolean flag to control custom filters visibility. |
LAYOUT_ID | string | - |
LINK_CLICK_BEHAVIOR | string | - |
MARKER_CODING | string | - |
MULTI_VALUE_SEPARATOR | string | Separator used to parse a cell value into multiple values for filter categories. |
SEMTYPE | string | - |
SOURCE_PRECISION | string | When 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_TYPE | string | Filter type for molecular columns: "Sketch" | "Categorical". See [DG.STRUCTURE_FILTER_TYPE] |
TOOLTIP | string | - |
UNITS | string | - |
Defined in
TYPES_SCALAR
• Const
TYPES_SCALAR: Set
<TYPE
>
Defined in
UNITS
• Const
UNITS: Object
Type declaration
Name | Type |
---|---|
Molecule | { INCHI : string = 'inchi'; MOLBLOCK : string = 'molblock'; SMILES : string = 'smiles'; V3K_MOLBLOCK : string = 'v3Kmolblock' } |
Molecule.INCHI | string |
Molecule.MOLBLOCK | string |
Molecule.SMILES | string |
Molecule.V3K_MOLBLOCK | string |
Defined in
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
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
Functions
__obs
▸ __obs(eventId
, object?
): Observable
<any
>
Parameters
Name | Type | Default value |
---|---|---|
eventId | string | undefined |
object | any | null |
Returns
Observable
<any
>
Defined in
_getIterator
▸ _getIterator(dart
): Object
Parameters
Name | Type |
---|---|
dart | any |
Returns
Object
Name | Type |
---|---|
next | () => { done : boolean = false; value : any } | { done : boolean = true; value? : undefined } |
Defined in
_identityInt32
▸ _identityInt32(length
): Int32Array
Parameters
Name | Type |
---|---|
length | number |
Returns
Int32Array
Defined in
_isDartium
▸ _isDartium(): boolean
Returns
boolean
Defined in
_options
▸ _options(element
, options
): HTMLElement
Parameters
Name | Type |
---|---|
element | HTMLElement |
options | any |
Returns
HTMLElement
Defined in
_propsToDart
▸ _propsToDart(s
, cls
): string
Converts entity properties between JavaScript and Dart. See also: include
Parameters
Name | Type |
---|---|
s | string |
cls | string |
Returns
string
Defined in
_sub
▸ _sub(dart
): StreamSubscription
Parameters
Name | Type |
---|---|
dart | any |
Returns
Defined in
_toIterable
▸ _toIterable(dart
): Iterable
<any
>
Parameters
Name | Type |
---|---|
dart | any |
Returns
Iterable
<any
>
Defined in
_toJson
▸ _toJson(x
): null
| string
Parameters
Name | Type |
---|---|
x | any |
Returns
null
| string
Defined in
callFuncWithDartParameters
▸ callFuncWithDartParameters<T
>(f
, params
, dartResult
): T
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
f | (...params : any []) => T |
params | object |
dartResult | boolean |
Returns
T
Defined in
debounce
▸ debounce<T
>(observable
, milliseconds?
): rxjs.Observable
<T
>
Type parameters
Name |
---|
T |
Parameters
Name | Type | Default value |
---|---|---|
observable | Observable <T > | undefined |
milliseconds | number | 100 |
Returns
rxjs.Observable
<T
>
Defined in
format
▸ format(x
, format?
): string
Parameters
Name | Type |
---|---|
x | number |
format? | string |
Returns
string
Defined in
histogram
▸ histogram(col
, bitset
, flag
, options?
): Int32List
Parameters
Name | Type |
---|---|
col | any |
bitset | any |
flag | boolean |
options? | Object |
options.bins? | number |
options.logScale? | boolean |
Returns
Int32List
Defined in
identity
▸ identity(length
): Uint32Array
Returns an 'identity' array where the element in idx-th position is equals to idx.
Parameters
Name | Type |
---|---|
length | number |
Returns
Uint32Array
Defined in
observeStream
▸ observeStream(dartStream
): Observable
<any
>
Converts Dart stream to rxjs.Observable.
Parameters
Name | Type |
---|---|
dartStream | any |
Returns
Observable
<any
>
Defined in
paramsToJs
▸ paramsToJs(params
): any
Converts list of Dart objects to JavaScript objects by calling toJs
Parameters
Name | Type |
---|---|
params | any |
Returns
any
- list of JavaScript objects
Defined in
range
▸ range(length
): Generator
<number
, void
, unknown
>
Parameters
Name | Type |
---|---|
length | number |
Returns
Generator
<number
, void
, unknown
>
Defined in
renderMultipleHistograms
▸ renderMultipleHistograms(g
, bounds
, histograms
, options?
): any
Parameters
Name | Type |
---|---|
g | CanvasRenderingContext2D |
bounds | any |
histograms | Int32List [] |
options? | Object |
options.categoryColumn? | any |
options.colors? | number [] |
options.fill? | boolean |
options.localMaximum? | boolean |
options.markerSize? | number |
options.maxBin? | number |
options.minBin? | number |
options.normalize? | boolean |
options.tension? | number |
Returns
any
Defined in
time
▸ time(name
, f
): any
Times the execution of function f
Parameters
Name | Type | Description |
---|---|---|
name | string | a label for the execution time to display |
f | Function | function with no parameters that will get measured |
Returns
any
- a value which f returns
Defined in
timeAsync
▸ timeAsync(name
, f
): Promise
<any
>
Times the execution of asyncronous function f
Async
Parameters
Name | Type | Description |
---|---|---|
name | string | a label for the execution time to display |
f | Function | async function with no parameters that will get measured |
Returns
Promise
<any
>
- a promise for the value which f returns
Defined in
toDart
▸ toDart(x
): any
Extracts a Dart handle from the JavaScript wrapper. See also toJs
Parameters
Name | Type |
---|---|
x | any |
Returns
any
Defined in
toJs
▸ toJs(dart
, check?
): any
Instantiates the corresponding JS handler for the Dart object [dart]. See also toDart
Parameters
Name | Type | Default value | Description |
---|---|---|---|
dart | any | undefined | Dart handle |
check | boolean | false | when true, throws an exception if the object can't be converted to JS. |
Returns
any
JavaScript wrapper for the Dart object