ObjectHandler<T>

Defined in: ui.ts:1685

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

Extended by

• EntityMetaDartProxy

Type Parameters

Type Parameter	Default type
T	any

Constructors

Constructor

new ObjectHandler<T>(): ObjectHandler<T>

Returns

ObjectHandler<T>

Properties

Property	Type	Defined in
dart	any	ui.ts:1686

Accessors

helpUrl

Get Signature

get helpUrl(): string | null

Defined in: ui.ts:1693

URL of help page for the object that this meta handles.

Returns

string | null

---

markupRegexp

Get Signature

get markupRegexp(): string | null

Defined in: ui.ts:1790

Creates a regexp for detecting markup descriptions of an object

Returns

string | null

---

name

Get Signature

get name(): string

Defined in: ui.ts:1697

Returns

string

---

regexpExample

Get Signature

get regexpExample(): { example: string; nonVariablePart: string; regexpMarkup: string; } | null

Defined in: ui.ts:1706

Will be used by search providers to get suggestions (like chembl which has regexp matcher) For something like CHEMBL object handler, it should return: regexpMarkup: 'CHEMBL[0-9]+', example: 'CHEMBL1234', nonVariablePart: 'CHEMBL'

Returns

{ example: string; nonVariablePart: string; regexpMarkup: string; } | null

---

type

Get Signature

get type(): string

Defined in: ui.ts:1688

Type of the object that this meta handles.

Returns

string

Methods

fromMarkup()

fromMarkup(matches): any

Defined in: ui.ts:1785

Extract object from parsed markup description

Parameters

Parameter	Type
matches	string[]

Returns

any

---

getById()

getById(id): Promise<T | null>

Defined in: ui.ts:1710

Parameters

Parameter	Type
id	string

Returns

Promise<T | null>

---

getCanvasRenderer()

getCanvasRenderer(): CanvasRenderer | null

Defined in: ui.ts:1733

Returns

CanvasRenderer | null

---

getCaption()

getCaption(x): string

Defined in: ui.ts:1728

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

Parameters

Parameter	Type	Description
x	T	item

Returns

string

---

getGridCellRenderer()

getGridCellRenderer(): GridCellRenderer<any> | null

Defined in: ui.ts:1738

Returns

GridCellRenderer<any> | null

---

init()

init(): void

Defined in: ui.ts:1795

Gets called once upon the registration of meta export class.

Returns

void

---

isApplicable()

isApplicable(x): boolean

Defined in: ui.ts:1721

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

Parameters

Parameter	Type	Description
x	any	specified object.

Returns

boolean

---

refresh()

refresh(x): Promise<T>

Defined in: ui.ts:1714

Parameters

Parameter	Type
x	T

Returns

Promise<T>

---

registerParamFunc()

registerParamFunc(name, run): void

Defined in: ui.ts:1843

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

Parameter	Type	Description
name	string	function name
run	(param) => any	a function that takes exactly one parameter

Returns

void

---

renderCard()

renderCard(x, context?): HTMLElement

Defined in: ui.ts:1758

Renders card div for the item.

Parameters

Parameter	Type	Default value
x	T	undefined
context	any	null

Returns

HTMLElement

---

renderIcon()

renderIcon(x, context?): HTMLElement

Defined in: ui.ts:1743

Renders icon for the item.

Parameters

Parameter	Type	Default value
x	T	undefined
context	any	null

Returns

HTMLElement

---

renderMarkup()

renderMarkup(x, context?): HTMLElement

Defined in: ui.ts:1748

Renders markup for the item.

Parameters

Parameter	Type	Default value
x	T	undefined
context	any	null

Returns

HTMLElement

---

renderPreview()

renderPreview(x, params?, path?): Promise<View>

Defined in: ui.ts:1768

Renders preview list for the item.

Parameters

Parameter	Type
x	T
params?	any
path?	string

Returns

Promise<View>

---

renderProperties()

renderProperties(x, context?): HTMLElement

Defined in: ui.ts:1763

Renders properties list for the item.

Parameters

Parameter	Type	Default value
x	T	undefined
context	any	null

Returns

HTMLElement

---

renderTooltip()

renderTooltip(x, context?): HTMLElement

Defined in: ui.ts:1753

Renders tooltip for the item.

Parameters

Parameter	Type	Default value
x	T	undefined
context	any	null

Returns

HTMLElement

---

renderView()

renderView(x, context?): HTMLElement

Defined in: ui.ts:1775

Renders view for the item.

Parameters

Parameter	Type	Default value
x	T	undefined
context	any	null

Returns

HTMLElement

---

toMarkup()

toMarkup(T): string | null

Defined in: ui.ts:1780

Converts object to its markup description

Parameters

Parameter	Type
T	any

Returns

string | null

---

toString()

toString(): string

Defined in: ui.ts:1699

Returns

string

---

forEntity()

static forEntity(object, context?): ObjectHandler<any> | null

Defined in: ui.ts:1818

Parameters

Parameter	Type	Default value
object	any	undefined
context	any	null

Returns

ObjectHandler<any> | null

---

forSemType()

static forSemType(semType): Promise<ObjectHandler<any>[]>

Defined in: ui.ts:1829

Parameters

Parameter	Type
semType	string

Returns

Promise<ObjectHandler<any>[]>

---

list()

static list(): ObjectHandler<any>[]

Defined in: ui.ts:1810

All registered handlers

Returns

ObjectHandler<any>[]

---

onResolve()

static onResolve(observer): Subscription

Defined in: ui.ts:1814

Parameters

Parameter	Type
observer	PartialObserver<ObjectHandlerResolutionArgs>

Returns

Subscription

---

register()

static register(meta): void

Defined in: ui.ts:1798

Registers entity handler.

Parameters

Parameter	Type
meta	ObjectHandler

Returns

void