SketcherBase

Defined in: js-api/src/chem.ts:74

A common interface that all sketchers should implement

Extends

• Widget

Constructors

Constructor

new SketcherBase(): SketcherBase

Defined in: js-api/src/chem.ts:79

Returns

SketcherBase

Overrides

Widget.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
_functions	protected	Func[]	[]	-	Widget._functions	js-api/src/widgets/base.ts:277
_name	public	string	''	-	-	js-api/src/chem.ts:77
_properties	protected	Property[]	[]	-	Widget._properties	js-api/src/widgets/base.ts:276
_root	protected	HTMLElement	undefined	-	Widget._root	js-api/src/widgets/base.ts:275
dart	public	any	undefined	-	Widget.dart	js-api/src/widgets/base.ts:280
explicitMol?	public	{ notation: "smiles" | "molblock" | "smarts" | "molblockV3000"; value: string; } | null	null	This field is used in cases when smiles is set from column but actually molblock is set to keep same coordinates. When this happens and user copies over the smiles from sketche, the sketcher returns transformed smiles.	-	js-api/src/chem.ts:87
factory	public	Func | null	null	Constructor function. No parameters, returns [Widget].	Widget.factory	js-api/src/widgets/base.ts:273
host?	public	Sketcher	undefined	-	-	js-api/src/chem.ts:76
isDetached	public	boolean	false	-	Widget.isDetached	js-api/src/widgets/base.ts:281
onChanged	public	Subject<any>	undefined	-	-	js-api/src/chem.ts:75
props	public	any	undefined	-	Widget.props	js-api/src/widgets/base.ts:278
subs	public	Subscription[]	undefined	-	Widget.subs	js-api/src/widgets/base.ts:279
temp	public	any	undefined	Contains auxiliary information	Widget.temp	js-api/src/widgets/base.ts:270

Accessors

aiDescription

Get Signature

get aiDescription(): string | null

Defined in: js-api/src/widgets/base.ts:340

A short AI-facing briefing: what this widget is, what its functions do, and how the assistant should approach it (e.g. which getFunctions entries to call first). Shown to the AI assistant as part of the workspace context.

Returns

string | null

Set Signature

set aiDescription(x): void

Defined in: js-api/src/widgets/base.ts:341

Parameters

Parameter	Type
x	string | null

Returns

void

Inherited from

Widget.aiDescription

---

children

Get Signature

get children(): Widget<any>[]

Defined in: js-api/src/widgets/base.ts:362

Parent widget up the DOM tree, or null.

Returns

Widget<any>[]

Inherited from

Widget.children

---

height

Get Signature

get height(): number

Defined in: js-api/src/chem.ts:120

Returns

number

---

isInitialized

Get Signature

get abstract isInitialized(): boolean

Defined in: js-api/src/chem.ts:110

Returns

boolean

---

molFile

Get Signature

get abstract molFile(): string

Defined in: js-api/src/chem.ts:95

MolFile representation of the molecule

Returns

string

Set Signature

set abstract molFile(s): void

Defined in: js-api/src/chem.ts:101

Parameters

Parameter	Type
s	string

Returns

void

---

molV3000

Get Signature

get abstract molV3000(): string

Defined in: js-api/src/chem.ts:97

Returns

string

Set Signature

set abstract molV3000(s): void

Defined in: js-api/src/chem.ts:99

Parameters

Parameter	Type
s	string

Returns

void

---

parent

Get Signature

get parent(): Widget<any> | null

Defined in: js-api/src/widgets/base.ts:359

Parent widget up the DOM tree, or null.

Returns

Widget<any> | null

Inherited from

Widget.parent

---

root

Get Signature

get root(): HTMLElement

Defined in: js-api/src/widgets/base.ts:366

Widget's visual root.

Returns

HTMLElement

Set Signature

set root(r): void

Defined in: js-api/src/widgets/base.ts:367

Parameters

Parameter	Type
r	HTMLElement

Returns

void

Inherited from

Widget.root

---

smarts

Set Signature

set abstract smarts(s): void

Defined in: js-api/src/chem.ts:108

Parameters

Parameter	Type
s	string

Returns

void

---

smiles

Get Signature

get abstract smiles(): string

Defined in: js-api/src/chem.ts:90

SMILES representation of the molecule

Returns

string

Set Signature

set abstract smiles(s): void

Defined in: js-api/src/chem.ts:92

Parameters

Parameter	Type
s	string

Returns

void

---

supportedExportFormats

Get Signature

get supportedExportFormats(): string[]

Defined in: js-api/src/chem.ts:112

Returns

string[]

---

type

Get Signature

get type(): string

Defined in: js-api/src/widgets/base.ts:267

Returns

string

Inherited from

Widget.type

---

width

Get Signature

get width(): number

Defined in: js-api/src/chem.ts:116

Returns

number

Methods

apply()

apply(properties): Widget

Defined in: js-api/src/widgets/base.ts:318

Parameters

Parameter	Type	Description
properties	object	-

Returns

Widget

Inherited from

Widget.apply

---

detach()

detach(): void

Defined in: js-api/src/widgets/base.ts:371

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

Widget.detach

---

getDartProperties()

getDartProperties(): any[]

Defined in: js-api/src/widgets/base.ts:347

Returns

any[]

Inherited from

Widget.getDartProperties

---

getFunctions()

getFunctions(): Func[]

Defined in: js-api/src/widgets/base.ts:333

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

Widget.getFunctions

---

getProperties()

getProperties(): Property[]

Defined in: js-api/src/widgets/base.ts:329

Returns all properties of this widget.

Returns

Property[]

Inherited from

Widget.getProperties

---

getSmarts()

getSmarts(): Promise<string>

Defined in: js-api/src/chem.ts:104

SMARTS query

Returns

Promise<string>

---

getWidgetStatus()

getWidgetStatus(): IWidgetStatus

Defined in: js-api/src/widgets/base.ts:418

Returns the widget's runtime structure for automated testing and introspection.

Returns

IWidgetStatus

Inherited from

Widget.getWidgetStatus

---

init()

init(host): Promise<void>

Defined in: js-api/src/chem.ts:125

Override to provide custom initialization. At this point, the root is already in the DOM.

Parameters

Parameter	Type
host	Sketcher

Returns

Promise<void>

---

onEvent()

onEvent(eventId?): Observable<any>

Defined in: js-api/src/widgets/base.ts:415

Observes events with the specified eventId. Override in subclasses to provide actual events.

Parameters

Parameter	Type	Default value
eventId	string | null	null

Returns

Observable<any>

Inherited from

Widget.onEvent

---

onFrameAttached()

onFrameAttached(dataFrame): void

Defined in: js-api/src/widgets/base.ts:353

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

Widget.onFrameAttached

---

onPropertyChanged()

onPropertyChanged(property): void

Defined in: js-api/src/widgets/base.ts:345

Gets called when viewer's property is changed.

Parameters

Parameter	Type	Description
property	Property | null	or null, if multiple properties were changed.

Returns

void

Inherited from

Widget.onPropertyChanged

---

refresh()

refresh(): void

Defined in: js-api/src/chem.ts:129

Returns

void

---

resize()

resize(): void

Defined in: js-api/src/chem.ts:131

Returns

void

---

sourceRowsChanged()

sourceRowsChanged(): void

Defined in: js-api/src/widgets/base.ts:351

Returns

void

Inherited from

Widget.sourceRowsChanged

---

sub()

sub(subscription): void

Defined in: js-api/src/widgets/base.ts:311

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription	-

Returns

void

Inherited from

Widget.sub

---

toDart()

toDart(): any

Defined in: js-api/src/widgets/base.ts:303

Returns

any

Inherited from

Widget.toDart

---

find()

static find(root): Widget<any> | null

Defined in: js-api/src/widgets/base.ts:299

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

Widget<any> | null

Inherited from

Widget.find

---

fromRoot()

static fromRoot(root): Widget

Defined in: js-api/src/widgets/base.ts:421

Creates a new widget from the root element.

Parameters

Parameter	Type
root	HTMLElement

Returns

Widget

Inherited from

Widget.fromRoot

---

getAll()

static getAll(): Widget<any>[]

Defined in: js-api/src/widgets/base.ts:294

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Widget.getAll