Skip to main content

dg

Index

Namespaces

NamespaceDescription
HtmlUtilsHtml-related utilities
Paint-
TestAutotest-related helpers
chemCheminformatics-related routines
ml-
xEXPERIMENTAL - USE AT YOUR OWN RISK - API might change

Enumerations

EnumerationDescription
AGG-
ArrowType-
AxisTickmarksMode-
AxisType-
COLOR_CODING_TYPE-
COLUMN_TYPE-
CardValueSourceType-
CorrelationType-
DEMO_DATASET-
DOCK_TYPE-
FILTER_TYPE-
FUNC_OPTIONSCommonly used options on the function level
FlexExtendedPosition-
FlexPosition-
GRID_COLUMN_TAGS-
GridColorCodingType-
JOIN_TYPE-
LEGEND_POSITION-
LINE_CHART_SERIES_TYPE-
LINK_CLICK_BEHAVIOR-
LOG_LEVEL-
LineInterpolationMode-
MARKER_TYPE-
NAMED_VALIDATORS-
PERMISSION-
RENDER_MODE-
RowGroupAction-
RowSet-
SCRIPT_LANGUAGE-
SEMTYPE-
SIMILARITY_METRIC-
STATS-
STAT_COUNTS-
STRUCTURE_FILTER_TYPE-
STR_AGG-
SYNC_TYPE-
ShapeType-
TYPE-
TextInterpretationMode-
TextOrientation-
USER_STATUS-
VIEWER-
VIEWER_PROPERTY_TYPE-
VIEW_TYPE-
VerticalAlignType-
VisibilityMode-

Classes

ClassDescription
AccordionAccordion control with collapsible/expandable panes.
AccordionPaneA pane in the Accordion control.
AdminDataSource-
BalloonBalloon-style visual notifications.
BarChartViewerRepresents a viewer.
BigIntColumnStrongly-typed column.
BitSetEfficient bit storage and manipulation.
BoxPlotRepresents a viewer.
Breadcrumbs-
BrowseViewA view is typically docked in the main document area of the Grok platform.
CalendarViewerRepresents a viewer.
CanvasRenderer-
CardViewBase view for working with a collection of objects that reside on the server.
CellRepresents a table cell.
ChoiceInputInput control base. Could be used for editing Property values as well.
ClientCacheClient caching service that caches results of function invocations and stores
CodeEditorClass for code input editor.
CodeInputInput control base. Could be used for editing Property values as well.
ColorColor-related routines.
ColumnStrongly-typed column.
ColumnColorHelper-
ColumnComboBoxA combo box with columns as item.
ColumnDialogHelper-
ColumnInfo-
ColumnListColumns in a [DataFrame].
ColumnMarkerHelper-
ColumnMetaHelper-
ColumnsArgs-
Completer-
ComponentBuildInfo-
Context-
CorrelationPlotRepresents a viewer.
CredentialsRepresents connection credentials
CredentialsDataSourceFunctionality for handling credentials collection from server and working with credentials remote endpoint
CustomCardViewBase view for working with a collection of objects that reside on the server.
DapiExposes Datagrok's server-side functionality.
DartListA proxy to a Dart List<T>.
DartWidgetBase class for controls that have a visual root and a set of properties.
DartWrapper-
DataCreating, loading, querying, manipulating, joining tables.
DataConnectionRepresents a data connection
DataConnectionsDataSourceFunctionality for handling connections collection from server and working with credentials remote endpoint
DataFrameDataFrame is a high-performance, easy to use tabular structure with
DataFrameColumnStrongly-typed column.
DataFrameDialogHelper-
DataFrameFormulaLinesHelperFormulaLinesHelper provides methods for working with Formula Lines.
DataFrameMetaHelper-
DataFramePlotHelper-
DataJobRepresents a data job
DataQueryRepresents a data query
DataSourceType-
DateInputInput control base. Could be used for editing Property values as well.
DateTimeColumnStrongly-typed column.
Db-
DemoDatasetsProvides convenient access to demo datasets.
Detector-
DialogA non-modal dialog.
DockContainerRepresents a dockable window.
DockManagerWindow docking manager.
DockNodeDock node.
DockViewA view is typically docked in the main document area of the Grok platform.
DockerContainerBase class for system objects stored in the database in a structured manner.
DockerContainersDataSourceFunctionality to work with Docker containers.
DockerDataSource-
DockerImageBase class for system objects stored in the database in a structured manner.
DockerImagesDataSourceFunctionality to work with Docker images. See also DockerContainersDataSource.
DropDown-
EntitiesDataSourceFunctionality for handling entities collection from server
EntityBase class for system objects stored in the database in a structured manner.
EntityPropertyStrongly-typed property associated with an object.
EntityType-
EventBusCentral event hub.
EventData-
EventsGlobal platform events.
FileInfo-
FileSource-
FilesProvides convenient file shares access *
FilesViewFile browser view. Contains the file tree, search panel and preview components.
FilesWidgetFile browser widget
FilterBase class for DataFrame-bound filtering controls.
FilterGroupRepresents a group of filters that are located together.
FloatColumnStrongly-typed column.
FormRepresents a form that can be user-designed or edited.
FormViewerDataFrame-bound viewer that contains Form
FormulaLinesHelperFormulaLinesHelper provides methods for working with Formula Lines.
FuncRepresents a function
FuncCallRepresents a function call
FuncCallParamRepresents a parameter of a function.
FuncOptions-
FuncParamOptions-
FuncsDataSourceFunctionality for handling functions collection from server
FunctionsGrok functions
FunctionsWidgetBase class for controls that have a visual root and a set of properties.
GridHigh-performance, flexible spreadsheet control
GridCellRepresents a grid cell
GridCellRenderArgsGrid cell rendering args.
GridCellRenderer-
GridCellRendererProxyProxy class for the Dart-based grid cell renderers.
GridCellStyleRepresents grid cell style.
GridCellStyleEx-
GridColumnRepresents a grid column
GridColumnListRepresents grid columns.
Group-
GroupByBuilderFluid API for building an aggregation query against a DataFrame.
GroupsDataSourceFunctionality for handling groups collection from server
HistogramViewerRepresents a viewer.
HistoryEntry-
HtmlTableBase class for controls that have a visual root and a set of properties.
HttpDataSourceCommon functionality for handling collections of entities stored on the server.
InputBaseInput control base. Could be used for editing Property values as well.
InputFormA form with multiple inputs inside
InputType-
JsInputBaseBase class for JS value editors
JsViewerSubclass JsViewer to implement a DataFrame-bound Datagrok viewer in JavaScript.
LayoutsDataSourceFunctionality for handling layouts collection from server
LegendColumn legend for viewers
LineChartViewerRepresents a viewer.
LogEventBase class for system objects stored in the database in a structured manner.
LogEventParameterBase class for system objects stored in the database in a structured manner.
LogEventParameterValueBase class for system objects stored in the database in a structured manner.
LogEventTypeBase class for system objects stored in the database in a structured manner.
Logger-
LruCacheLeast recently used cache.
MarkdownInputInput control base. Could be used for editing Property values as well.
MenuMenu (either top menu or popup menu).
ModelRepresents a predictive model
MultiViewSubclass ViewBase to implement a Datagrok view in JavaScript.
Notebook-
ObjectColumnStrongly-typed column.
ObjectPropertyBag-
PackageRepresents a package, which is a unit of distribution of content in the Datagrok platform.
PackageLogger-
PcPlotRepresents a viewer.
PermissionsDataSource-
PieChartViewerRepresents a viewer.
PivotViewerRepresents a viewer.
PointRepresents a point.
ProgressIndicator-
ProjectRepresents a project
ProjectsDataSourceFunctionality for working with remote projects
ProjectsViewProjects view
PropertyStrongly-typed property associated with an object.
PropertyGridBase class for controls that have a visual root and a set of properties.
QnumA set of static methods for working with qualified numbers.
RangeSliderA slider that lets user control both min and max values.
RectRepresents a rectangle.
RowRepresents a row. Allows for quick property access like "row.height".
RowGroup-
RowListRepresents rows of the [DataFrame].
RowMatcherRow matcher.
ScatterPlotViewer2D scatter plot
Schema-
Script-
ScriptEnvironmentRepresents a script environment
ScriptViewScript view
ScriptsViewScripts view
SearchResult-
SemanticValue-
SettingsUser-specific platform settings.
ShellGrok visual shell, use it to get access to top-level views, tables, methods, etc.
ShellContextPanelRepresents context panel that shows properties for the current object
ShellHelpPanelRepresents help panel that shows help for the current object and is toggleable
StatsRepresents basic descriptive statistics calculated for a Column.
StickyMetaAPI for Sticky meta. Allows attaching arbitrary metadata on custom entities.
StreamSubscriptionSubscription to an event stream. Call [cancel] to stop listening.
StringUtils-
TabControlTab control that hosts panes inside. See also TabPane
TabPaneRepresents a pane of either TabControl or Accordion
TableInfo-
TableQueryRepresents a table query
TableQueryBuilderTable query builder that works with database tables
TableViewA View that is associated with a DataFrame and exposes
TablesDataSourceFunctionality for working with remote tables
TagEditor-
TagElement-
Tags-
TagsInputInput control base. Could be used for editing Property values as well.
TaskBarProgressIndicator-
ToolboxPage-
TreeViewGroupTree view node.
TreeViewNodeTree view node.
TypeAheadInput control base. Could be used for editing Property values as well.
TypedEventArgs-
UsageType-
UserRepresents a user of the Datagrok platform.
UserDataStorage-
UserReportBase class for system objects stored in the database in a structured manner.
UserReportsDataSourceCommon functionality for handling collections of entities stored on the server.
UserReportsRuleBase class for system objects stored in the database in a structured manner.
UserReportsRulesDataSourceCommon functionality for handling collections of entities stored on the server.
UserSessionRepresents a user session in the Datagrok platform.
UsersDataSourceFunctionality for handling Users collection from server and working with Users remote endpoint
Utils-
ValueMatcherValue matcher.
ViewA view is typically docked in the main document area of the Grok platform.
ViewBaseSubclass ViewBase to implement a Datagrok view in JavaScript.
ViewInfoBase class for system objects stored in the database in a structured manner.
ViewLayoutBase class for system objects stored in the database in a structured manner.
ViewerRepresents a viewer.
ViewerEvent-
ViewerFormulaLinesHelperFormulaLinesHelper provides methods for working with Formula Lines.
ViewerMetaHelper-
ViewsDataSourceFunctionality for handling views information from server
VirtualViewRepresents a virtual view, where visual elements are created only when user
WidgetBase class for controls that have a visual root and a set of properties.
WindowsControls tool windows visibility
WizardEXPERIMENTAL - USE AT YOUR OWN RISK - API might change

Interfaces

InterfaceDescription
ColumnsFormatCsvExportOptionsColumn name -> format
CsvExportOptionsCsv export options to be used in DataFrame.toCsv
DataConnectionCachePropertiesRepresents connection cache properties
DataConnectionPropertiesRepresents data connection properties. It can have variable number of parameters depending on DataSourceType.
DataFrameArgs-
DatabaseConnectionPropertiesRepresents basic properties of database connection. The list of parameters is not complete. You can find all
EmailRepresents message that can be sent over the network using the configured SMTP service
FilterState-
FormulaLineFormulaLine available parameters.
FormulaLineMetaFormulaLine meta information.
FuncRoleDescription-
GridCellArgs-
IBarChartSettings-
IBoxPlotSettings-
ICalendarSettings-
ICardSettings-
ICorrelationPlotSettings-
IDensityPlotSettings-
IFiltersSettings-
IFormSettings-
IFunctionCallOptions-
IFunctionRegistrationData-
IGridCellStyle-
IGridSettings-
IHistogramSettings-
ILineChartSettings-
IMapViewerSettings-
IMarkupViewerSettings-
IMatrixPlotSettings-
IMenuItemOptions-
IMenuItemsOptionsSee Menu.items
INetworkDiagramSettings-
IPcPlotSettings-
IPieChartSettings-
IPivotViewerSettings-
IPoint-
IScatterPlot3dSettings-
IScatterPlotSettings-
IShowMenuOptions-
ISparklinesSettings-
IStatsViewerSettings-
ISummarySettings-
ITileViewerSettings-
ITreeMapSettings-
ITrellisPlotSettings-
IViewStateApplicationOptions-
InputArgs-
MapChangeArgs-
MultiViewOptions-
ProjectOpenOptions-
PropertyOptions-
SemTypeInfoMetadata associated with the semantic type.
ServiceInfo-
ViewArgs-
ViewerArgs-
WizardPageEXPERIMENTAL - USE AT YOUR OWN RISK - API might change

Type Aliases

Type aliasDescription
AggregationType-
CategoryDataArgs-
CodeConfig-
ColorCodingType-
ColorType-
ColumnAggregationType-
ColumnType-
CorrPlotCellArgs-
CsvImportColumnOptions-
CsvImportOptions-
DemoDatasetName-
DockType-
ElementOptions-
GridColumnTooltipType-
HorzAlign-
ICodeEditorOptions-
IndexPredicate-
JoinType-
LegendPosition-
LineChartLineArgs-
LogMessage-
MarkerCodingType-
ObjectType-
RangeSliderStyle-
RowDataArgs-
ScriptLanguage-
SemType-
SimilarityMetric-
SliderOptions-
StringPredicate-
StructureFilterType-
SyncType-
TagsInputConfig-
Type-
TypeAheadConfig-
VertAlign-
ViewType-
ViewerPropertyType-
ViewerType-
fileShares-

Variables

VariableDescription
DEFAULT_SKETCHER-
FLOAT_NULL-
FUNC_TYPES-
INT_NULL-
MapProxyProxies a Dart Map, API-compliant to ES 2015+
QNUM_EXACT-
QNUM_GREATER-
QNUM_LESS-
TAGS-
TYPES_SCALAR-
UNITS-
WHITE_MOLBLOCK-
WHITE_MOLBLOCK_V_3000-
functionRoles-

Functions

FunctionDescription
__obs-
_getIterator-
_identityInt32-
_isDartium-
_options-
_propsToDartConverts entity properties between JavaScript and Dart.
_sub-
_toIterable-
_toJson-
callFuncWithDartParameters-
debounce-
delay-
format-
histogram-
identityReturns an 'identity' array where the element in idx-th position is equals to idx.
observeStreamConverts Dart stream to rxjs.Observable.
paramsToJsConverts list of Dart objects to JavaScript objects by calling toJs
range-
renderMultipleHistograms-
timeTimes the execution of function f
timeAsyncTimes the execution of asyncronous function f
toDartExtracts a Dart handle from the JavaScript wrapper. See also toJs
toJsInstantiates the corresponding JS handler for the Dart object [dart]. See also toDart

References

EntityMetaDartProxy

Re-exports EntityMetaDartProxy


ObjectHandler

Re-exports ObjectHandler