VisualDbQueryEditor
JS wrapper for the widget implemented in Dart.
Extends
Constructors
new VisualDbQueryEditor()
new VisualDbQueryEditor(
dart):VisualDbQueryEditor
Parameters
| Parameter | Type |
|---|---|
dart | any |
Returns
Overrides
Source
Properties
| Property | Modifier | Type | Default value | Description | Inherited from |
|---|---|---|---|---|---|
_functions | protected | Func[] | [] | - | DartWidget._functions |
_properties | protected | Property[] | [] | - | DartWidget._properties |
_root | protected | HTMLElement | undefined | - | DartWidget._root |
dart | public | any | undefined | - | DartWidget.dart |
factory | public | null | Func | null | Constructor function. No parameters, returns [Widget]. | DartWidget.factory |
isDetached | public | boolean | false | - | DartWidget.isDetached |
props | public | any | undefined | - | DartWidget.props |
subs | public | Subscription[] | undefined | - | DartWidget.subs |
temp | public | any | undefined | Contains auxiliary information | DartWidget.temp |
Accessors
aggregateTag
getaggregateTag():TagEditor
Returns
Source
children
getchildren():Widget<any>[]
Parent widget up the DOM tree, or null.
Returns
Widget<any>[]
Source
grid
getgrid():Grid
Returns
Source
groupByTag
getgroupByTag():TagEditor
Returns
Source
havingTag
gethavingTag():TagEditor
Returns
Source
inputSchemas
getinputSchemas():object
Returns
object
Source
mainTag
getmainTag():TagEditor
Returns
Source
orderTag
getorderTag():TagEditor
Returns
Source
parent
getparent():null|Widget<any>
Parent widget up the DOM tree, or null.
Returns
null | Widget<any>
Source
pivotTag
getpivotTag():TagEditor
Returns
Source
query
getquery():TableQuery
Returns
Source
root
getroot():HTMLElement
Widget's visual root.
Returns
HTMLElement
Source
showAddToWorkspaceBtn
setshowAddToWorkspaceBtn(show):void
Parameters
| Parameter | Type |
|---|---|
show | boolean |
Source
type
gettype():string
Returns
string
Source
whereTag
getwhereTag():TagEditor
Returns
Source
Methods
addProperty()
privateaddProperty(propertyName,propertyType,defaultValue,options):any
Registers an property with the specified type, name, and defaultValue.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
propertyName | string | undefined | |
propertyType | "string" | "bigint" | "object" | "map" | "file" | "view" | "blob" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe" | "num" | "string_list" | "dataframe_list" | "cell" | "column" | "column_list" | "graphics" | "tablerowfiltercall" | "colfiltercall" | "bitset" | "dynamic" | "viewer" | "list" | "semantic_value" | "func" | "funccall" | "property" | "categorical" | "numerical" | "GridCellRenderArgs" | "element" | "TableView" | "User" | "Menu" | "Project" | "event_data" | "progressindicator" | "Credentials" | "ScriptEnvironment" | "Notebook" | undefined | |
defaultValue | any | null | |
options | null | object & IProperty | null |
Returns
any
Inherited from
See
Registered property gets added to properties. Returns default value, thus allowing to combine registering a property with the initialization
Source
apply()
apply(
properties):Widget<any>
Parameters
| Parameter | Type | Description |
|---|---|---|
properties | object |
Returns
Widget<any>
Inherited from
Source
detach()
detach():
void
Gets called when a widget is detached and will no longer be used. Typically used for unsubscribing from events. Be sure to call super.detach() if this method is overridden.
Returns
void
Inherited from
Source
getDartProperties()
getDartProperties():
any[]
Returns
any[]
Inherited from
DartWidget . getDartProperties
Source
getFunctions()
getFunctions():
Func[]
Functions that are applicable to this particular widget. Used in the UI to display context actions, and for the AI integrations.
Returns
Func[]
Inherited from
Source
getProperties()
getProperties():
Property[]
Returns all properties of this widget.
Returns
Property[]
Inherited from
Source
getTableInfoByName()
getTableInfoByName(
name):TableInfo
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
Source
getTableInfoName()
getTableInfoName(
table):string
Parameters
| Parameter | Type |
|---|---|
table | TableInfo |
Returns
string
Source
isInit()
isInit():
Promise<void>
Returns
Promise<void>
Source
onFrameAttached()
onFrameAttached(
dataFrame):void
Parameters
| Parameter | Type |
|---|---|
dataFrame | DataFrame |
Returns
void
Inherited from
Source
onPropertyChanged()
onPropertyChanged(
property):void
Gets called when viewer's property is changed.
Parameters
| Parameter | Type | Description |
|---|---|---|
property | null | Property | or null, if multiple properties were changed. |
Returns
void
Inherited from
DartWidget . onPropertyChanged
Source
refreshQuery()
refreshQuery():
void
Returns
void
Source
sourceRowsChanged()
sourceRowsChanged():
void
Returns
void
Inherited from
DartWidget . sourceRowsChanged
Source
sub()
sub(
subscription):void
Registers a subscription to an external event.
Parameters
| Parameter | Type | Description |
|---|---|---|
subscription | Subscription |
Returns
void
Inherited from
Source
toDart()
toDart():
any
Returns
any
Inherited from
Source
find()
staticfind(root):null|Widget<any>
Finds existing widget from its visual root.
Parameters
| Parameter | Type |
|---|---|
root | Element |
Returns
null | Widget<any>
Inherited from
Source
fromDbTable()
staticfromDbTable(table):VisualDbQueryEditor
Parameters
| Parameter | Type |
|---|---|
table | TableInfo |
Returns
Source
fromQuery()
staticfromQuery(query):VisualDbQueryEditor
Parameters
| Parameter | Type |
|---|---|
query | TableQuery |
Returns
Source
fromRoot()
staticfromRoot(root):Widget<any>
Creates a new widget from the root element.
Parameters
| Parameter | Type |
|---|---|
root | HTMLElement |
Returns
Widget<any>
Inherited from
Source
getAll()
staticgetAll():Widget<any>[]
Returns all currently active widgets.
Returns
Widget<any>[]