abstract SketcherBase

A common interface that all sketchers should implement

Extends

• Widget

Constructors

new SketcherBase()

new SketcherBase(): SketcherBase

Returns

SketcherBase

Overrides

Widget . constructor

Source

src/chem.ts:76

Properties

Property	Modifier	Type	Default value	Description	Inherited from
_name	public	string	''	-	-
_properties	protected	Property[]	undefined	-	Widget._properties
_root	protected	HTMLElement	undefined	-	Widget._root
dart	public	any	undefined	-	Widget.dart
factory	public	null | Func	null	Constructor function. No parameters, returns [Widget].	Widget.factory
host?	public	Sketcher	undefined	-	-
isDetached	public	boolean	false	-	Widget.isDetached
onChanged	public	Subject<any>	...	-	-
props	public	any	undefined	-	Widget.props
subs	public	Subscription[]	undefined	-	Widget.subs
temp	public	any	undefined	Contains auxiliary information	Widget.temp

Accessors

height

get height(): number

Returns

number

Source

src/chem.ts:111

---

isInitialized

get abstract isInitialized(): boolean

Returns

boolean

Source

src/chem.ts:101

---

molFile

get abstract molFile(): string

MolFile representation of the molecule

set abstract molFile(s): void

Parameters

Parameter	Type
s	string

Returns

string

Source

src/chem.ts:86

---

molV3000

get abstract molV3000(): string

set abstract molV3000(s): void

Parameters

Parameter	Type
s	string

Returns

string

Source

src/chem.ts:88

---

root

get root(): HTMLElement

Widget's visual root.

set root(r): void

Parameters

Parameter	Type
r	HTMLElement

Returns

HTMLElement

Source

src/widgets.ts:291

---

smarts

set abstract smarts(s): void

Parameters

Parameter	Type
s	string

Source

src/chem.ts:99

---

smiles

get abstract smiles(): string

SMILES representation of the molecule

set abstract smiles(s): void

Parameters

Parameter	Type
s	string

Returns

string

Source

src/chem.ts:81

---

supportedExportFormats

get supportedExportFormats(): string[]

Returns

string[]

Source

src/chem.ts:103

---

type

get type(): string

Returns

string

Source

src/widgets.ts:201

---

width

get width(): number

Returns

number

Source

src/chem.ts:107

Methods

addProperty()

private addProperty(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" | "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 & PropertyOptions	null

Returns

any

Inherited from

Widget . addProperty

See

Registered property gets added to properties. Returns default value, thus allowing to combine registering a property with the initialization

Source

src/widgets.ts:312

---

apply()

apply(properties): Widget<any>

Parameters

Parameter	Type	Description
properties	object

Returns

Widget<any>

Inherited from

Widget . apply

Source

src/widgets.ts:262

---

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

Widget . detach

Source

src/widgets.ts:296

---

getDartProperties()

getDartProperties(): any[]

Returns

any[]

Inherited from

Widget . getDartProperties

Source

src/widgets.ts:278

---

getProperties()

getProperties(): Property[]

Returns

Property[]

Inherited from

Widget . getProperties

Source

src/widgets.ts:272

---

getSmarts()

getSmarts(): Promise<string>

SMARTS query

Returns

Promise<string>

Source

src/chem.ts:95

---

init()

init(host): Promise<void>

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

Parameters

Parameter	Type
host	Sketcher

Returns

Promise<void>

Source

src/chem.ts:116

---

onFrameAttached()

onFrameAttached(dataFrame): void

Parameters

Parameter	Type
dataFrame	DataFrame

Returns

void

Inherited from

Widget . onFrameAttached

Source

src/widgets.ts:284

---

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

Widget . onPropertyChanged

Source

src/widgets.ts:276

---

refresh()

refresh(): void

Returns

void

Source

src/chem.ts:120

---

resize()

resize(): void

Returns

void

Source

src/chem.ts:122

---

sourceRowsChanged()

sourceRowsChanged(): void

Returns

void

Inherited from

Widget . sourceRowsChanged

Source

src/widgets.ts:282

---

sub()

sub(subscription): void

Registers a subscription to an external event.

Parameters

Parameter	Type	Description
subscription	Subscription

Returns

void

Inherited from

Widget . sub

Source

src/widgets.ts:255

---

toDart()

toDart(): any

Returns

any

Inherited from

Widget . toDart

Source

src/widgets.ts:247

---

find()

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

Finds existing widget from its visual root.

Parameters

Parameter	Type
root	Element

Returns

null | Widget<any>

Inherited from

Widget . find

Source

src/widgets.ts:243

---

fromRoot()

static fromRoot(root): Widget<any>

Creates a new widget from the root element.

Parameters

Parameter	Type
root	HTMLElement

Returns

Widget<any>

Inherited from

Widget . fromRoot

Source

src/widgets.ts:335

---

getAll()

static getAll(): Widget<any>[]

Returns all currently active widgets.

Returns

Widget<any>[]

Inherited from

Widget . getAll

Source

src/widgets.ts:238