ObjectHandler

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

Constructors

new ObjectHandler()

new ObjectHandler(): ObjectHandler

Returns

ObjectHandler

Accessors

helpUrl

get helpUrl(): null | string

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

Returns

null | string

Source

ui.ts:1426

---

markupRegexp

get markupRegexp(): null | string

Creates a regexp for detecting markup descriptions of an object

Returns

null | string

Source

ui.ts:1512

---

name

get name(): string

Returns

string

Source

ui.ts:1430

---

type

get type(): string

Type of the object that this meta handles.

Returns

string

Source

ui.ts:1421

Methods

fromMarkup()

fromMarkup(matches): any

Extract object from parsed markup description

Parameters

Parameter	Type
matches	string[]

Returns

any

Source

ui.ts:1507

---

getById()

getById(id): Promise<any>

Parameters

Parameter	Type
id	string

Returns

Promise<any>

Source

ui.ts:1434

---

getCanvasRenderer()

getCanvasRenderer(): null | CanvasRenderer

Returns

null | CanvasRenderer

Source

ui.ts:1457

---

getCaption()

getCaption(x): string

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

Parameters

Parameter	Type	Description
x	any	item

Returns

string

Source

ui.ts:1452

---

getGridCellRenderer()

getGridCellRenderer(): null | GridCellRenderer

Returns

null | GridCellRenderer

Source

ui.ts:1462

---

init()

init(): void

Gets called once upon the registration of meta export class.

Returns

void

Source

ui.ts:1517

---

isApplicable()

isApplicable(x): boolean

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

Parameters

Parameter	Type	Description
x	any	specified object.

Returns

boolean

Source

ui.ts:1445

---

refresh()

refresh(x): Promise<any>

Parameters

Parameter	Type
x	any

Returns

Promise<any>

Source

ui.ts:1438

---

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

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

Returns

void

Source

ui.ts:1564

---

renderCard()

renderCard(x, context): HTMLElement

Renders card div for the item.

Parameters

Parameter	Type	Default value
x	any	undefined
context	any	null

Returns

HTMLElement

Source

ui.ts:1482

---

renderIcon()

renderIcon(x, context): HTMLElement

Renders icon for the item.

Parameters

Parameter	Type	Default value
x	any	undefined
context	any	null

Returns

HTMLElement

Source

ui.ts:1467

---

renderMarkup()

renderMarkup(x, context): HTMLElement

Renders markup for the item.

Parameters

Parameter	Type	Default value
x	any	undefined
context	any	null

Returns

HTMLElement

Source

ui.ts:1472

---

renderPreview()

renderPreview(x, context): Promise <View>

Renders preview list for the item.

Parameters

Parameter	Type	Default value
x	any	undefined
context	any	null

Returns

Promise <View>

Source

ui.ts:1492

---

renderProperties()

renderProperties(x, context): HTMLElement

Renders properties list for the item.

Parameters

Parameter	Type	Default value
x	any	undefined
context	any	null

Returns

HTMLElement

Source

ui.ts:1487

---

renderTooltip()

renderTooltip(x, context): HTMLElement

Renders tooltip for the item.

Parameters

Parameter	Type	Default value
x	any	undefined
context	any	null

Returns

HTMLElement

Source

ui.ts:1477

---

renderView()

renderView(x, context): HTMLElement

Renders view for the item.

Parameters

Parameter	Type	Default value
x	any	undefined
context	any	null

Returns

HTMLElement

Source

ui.ts:1497

---

toMarkup()

toMarkup(x): null | string

Converts object to its markup description

Parameters

Parameter	Type
x	any

Returns

null | string

Source

ui.ts:1502

---

toString()

toString(): string

Returns

string

Source

ui.ts:1432

---

forEntity()

static forEntity(object, context): null | ObjectHandler

Parameters

Parameter	Type	Default value
object	any	undefined
context	any	null

Returns

null | ObjectHandler

Source

ui.ts:1539

---

forSemType()

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

Parameters

Parameter	Type
semType	string

Returns

Promise <ObjectHandler[]>

Source

ui.ts:1550

---

list()

static list(): ObjectHandler[]

Returns

ObjectHandler[]

Source

ui.ts:1531

---

onResolve()

static onResolve(observer): Subscription

Parameters

Parameter	Type
observer	PartialObserver <ObjectHandlerResolutionArgs>

Returns

Subscription

Source

ui.ts:1535

---

register()

static register(meta): void

Registers entity handler.

Parameters

Parameter	Type
meta	ObjectHandler

Returns

void

Source

ui.ts:1520