Skip to main content

Class: EntityMetaDartProxy

ui.EntityMetaDartProxy

Override the corresponding methods, and register an instance to let Datagrok know how to handle objects of the specified type.

isApplicable is used to associate an object with the handler. When handling an object x, the platform uses the first registered handler that claims that it is applicable to that object.

TODO: search, destructuring to properties

Example: https://public.datagrok.ai/js/samples/ui/handlers/handlers

Hierarchy

Constructors

constructor

new EntityMetaDartProxy(d)

Parameters

NameType
dany

Overrides

ObjectHandler.constructor

Defined in

ui.ts:1767

Properties

dart

dart: any

Defined in

ui.ts:1765

Accessors

name

get name(): string

Returns

string

Inherited from

ObjectHandler.name

Defined in

ui.ts:1643


type

get type(): string

Type of the object that this meta handles.

Returns

string

Overrides

ObjectHandler.type

Defined in

ui.ts:1772

Methods

getById

getById(id): Promise<any>

Parameters

NameType
idstring

Returns

Promise<any>

Inherited from

ObjectHandler.getById

Defined in

ui.ts:1647


getCanvasRenderer

getCanvasRenderer(): null | CanvasRenderer

Returns

null | CanvasRenderer

Inherited from

ObjectHandler.getCanvasRenderer

Defined in

ui.ts:1670


getCaption

getCaption(x): string

String representation of the [item], by default item.toString().

Parameters

NameTypeDescription
xanyitem

Returns

string

Overrides

ObjectHandler.getCaption

Defined in

ui.ts:1774


getGridCellRenderer

getGridCellRenderer(): null | GridCellRenderer

Returns

null | GridCellRenderer

Inherited from

ObjectHandler.getGridCellRenderer

Defined in

ui.ts:1675


init

init(): void

Gets called once upon the registration of meta export class.

Returns

void

Inherited from

ObjectHandler.init

Defined in

ui.ts:1715


isApplicable

isApplicable(x): boolean

Override this method to check whether this meta class should handle the specified object.

Parameters

NameTypeDescription
xanyspecified object.

Returns

boolean

Overrides

ObjectHandler.isApplicable

Defined in

ui.ts:1773


refresh

refresh(x): Promise<any>

Parameters

NameType
xany

Returns

Promise<any>

Inherited from

ObjectHandler.refresh

Defined in

ui.ts:1651


registerParamFunc

registerParamFunc(name, run): void

Registers a function that takes applicable objects as the only argument. It will be suggested to run in the context menu for that object, and also in the "Actions" pane on the context panel.

Example: https://public.datagrok.ai/js/samples/ui/docking/docking

Parameters

NameTypeDescription
namestringfunction name
run(param: any) => anya function that takes exactly one parameter

Returns

void

Inherited from

ObjectHandler.registerParamFunc

Defined in

ui.ts:1758


renderCard

renderCard(x, context?): HTMLDivElement

Renders card div for the item.

Parameters

NameTypeDefault value
xanyundefined
contextanynull

Returns

HTMLDivElement

Overrides

ObjectHandler.renderCard

Defined in

ui.ts:1779


renderIcon

renderIcon(x, context?): HTMLDivElement

Renders icon for the item.

Parameters

NameTypeDefault value
xanyundefined
contextanynull

Returns

HTMLDivElement

Overrides

ObjectHandler.renderIcon

Defined in

ui.ts:1776


renderMarkup

renderMarkup(x, context?): HTMLDivElement

Renders markup for the item.

Parameters

NameTypeDefault value
xanyundefined
contextanynull

Returns

HTMLDivElement

Overrides

ObjectHandler.renderMarkup

Defined in

ui.ts:1777


renderPreview

renderPreview(x, context?): Promise<View>

Renders preview list for the item.

Parameters

NameTypeDefault value
xanyundefined
contextanynull

Returns

Promise<View>

Inherited from

ObjectHandler.renderPreview

Defined in

ui.ts:1705


renderProperties

renderProperties(x, context?): HTMLDivElement

Renders properties list for the item.

Parameters

NameTypeDefault value
xanyundefined
contextanynull

Returns

HTMLDivElement

Overrides

ObjectHandler.renderProperties

Defined in

ui.ts:1780


renderTooltip

renderTooltip(x, context?): HTMLDivElement

Renders tooltip for the item.

Parameters

NameTypeDefault value
xanyundefined
contextanynull

Returns

HTMLDivElement

Overrides

ObjectHandler.renderTooltip

Defined in

ui.ts:1778


renderView

renderView(x, context?): HTMLDivElement

Renders view for the item.

Parameters

NameTypeDefault value
xanyundefined
contextanynull

Returns

HTMLDivElement

Overrides

ObjectHandler.renderView

Defined in

ui.ts:1781


toString

toString(): string

Returns

string

Inherited from

ObjectHandler.toString

Defined in

ui.ts:1645


forEntity

Static forEntity(object, context?): null | ObjectHandler

Parameters

NameTypeDefault value
objectobjectundefined
contextnull | objectnull

Returns

null | ObjectHandler

Inherited from

ObjectHandler.forEntity

Defined in

ui.ts:1733


forSemType

Static forSemType(semType): Promise<ObjectHandler[]>

Parameters

NameType
semTypestring

Returns

Promise<ObjectHandler[]>

Inherited from

ObjectHandler.forSemType

Defined in

ui.ts:1744


list

Static list(): ObjectHandler[]

Returns

ObjectHandler[]

Inherited from

ObjectHandler.list

Defined in

ui.ts:1725


onResolve

Static onResolve(observer): Subscription

Parameters

NameType
observerPartialObserver<ObjectHandlerResolutionArgs>

Returns

Subscription

Inherited from

ObjectHandler.onResolve

Defined in

ui.ts:1729


register

Static register(meta): void

Registers entity handler.

Parameters

NameType
metaObjectHandler

Returns

void

Inherited from

ObjectHandler.register

Defined in

ui.ts:1718