Class: BaseMarker

.ChemMarker. BaseMarker

new BaseMarker(id, coord2D, coord3D)

Base class of chem marker representing chemical concepts (e.g. charge, lone pair...) of parent chem object.
Parameters:
Name Type Description
id String Id of this marker.
coord2D Hash The 2D coordinates of marker, {x, y}, can be null.
coord3D Hash The 3D coordinates of marker, {x, y, z}, can be null.
Properties:
Name Type Description
value Variant Value of the property value of parent chem object.
Source:

Extends

Methods

appendMarker(marker)

Attach a marker to this object. If marker already exists, nothing will be done.
Parameters:
Name Type Description
marker Kekule.ChemObject
Inherited From:
Source:

clearMarkers()

Remove all attached markers.
Inherited From:
Source:

fetchMarkerOfType(classType, canCreate, exactMatch, defProps) → {Kekule.ChemObject}

Get attached marker of classType. If no such a marker currently and canCreate is true, a new marker will be created.
Parameters:
Name Type Description
classType Class
canCreate Bool
exactMatch Bool If true, only marker of classType (not its descendants) should be returned.
defProps Hash If create a new marker, those prop values will be applied.
Inherited From:
Source:
Returns:
Type
Kekule.ChemObject

getMarkerAt(index) → {Kekule.ChemObject}

Get attached marker at index.
Parameters:
Name Type Description
index Int
Inherited From:
Source:
Returns:
Type
Kekule.ChemObject

getMarkerCount() → {Int}

Return count of attached markers.
Inherited From:
Source:
Returns:
Type
Int

getMarkerOfType(classType, exactMatch) → {Kekule.ChemObject}

Returns the first child marker of a specified class type.
Parameters:
Name Type Description
classType Class
exactMatch Bool If true, only marker of classType (not its descendants) should be returned.
Inherited From:
Source:
Returns:
Type
Kekule.ChemObject

getMarkersOfType(classType, exactMatch) → {Array}

Returns all child markers of a specified class type.
Parameters:
Name Type Description
classType Class
exactMatch Bool If true, only markers of classType (not its descendants) should be returned.
Inherited From:
Source:
Returns:
Type
Array

getUnplacedMarkers(coordMode) → {Array}

Returns markers that has no coord on coordMode
Parameters:
Name Type Description
coordMode Int
Inherited From:
Source:
Returns:
Type
Array

hasMarker(marker) → {Bool}

Check if a marker has been attached to this object.
Parameters:
Name Type Description
marker Kekule.ChemObject
Inherited From:
Source:
Returns:
Type
Bool

hasMarkerOfType(classType, exactMatch) → {Bool}

Returns whether there exists child markers of a specified class type.
Parameters:
Name Type Description
classType Class
exactMatch Bool If true, only markers of classType (not its descendants) should be considered.
Inherited From:
Source:
Returns:
Type
Bool

indexOfMarker(marker) → {Int}

Get index of attached marker in marker array.
Parameters:
Name Type Description
marker Kekule.ChemObject
Inherited From:
Source:
Returns:
Type
Int

insertMarkerAt(marker, index)

Insert marker to index. If index is not set, marker will be inserted to the tail of the marker array.
Parameters:
Name Type Description
marker Kekule.ChemObject
index Int
Inherited From:
Source:

insertMarkerBefore(marker, refMarker) → {Int}

Insert marker before refMarker in marker list. If refMarker is null or does not exists, marker will be append to tail of list.
Parameters:
Name Type Description
marker Kekule.ChemObject
refMarker Kekule.ChemObject
Inherited From:
Source:
Returns:
Index of obj after inserting.
Type
Int

isAttachedMarker() → {Bool}

Returns whether current object is an attachedMarker of parent object.
Inherited From:
Source:
Returns:
Type
Bool

removeMarker(marker)

Remove an attached marker.
Parameters:
Name Type Description
marker Kekule.ChemObject
Inherited From:
Source:

removeMarkerAt(index)

Remove marker at index in attached marker list.
Parameters:
Name Type Description
index Int
Inherited From:
Source:

replaceMarker(oldMarker, newMarker)

Replace oldMarker with new one.
Parameters:
Name Type Description
oldMarker Kekule.ChemObject
newMarker Kekule.ChemObject
Inherited From:
Source:

setMarkerIndex(marker, index)

Change index of marker.
Parameters:
Name Type Description
marker Kekule.ChemObject
index Int
Inherited From:
Source:

.ChemMarker. BaseMarker

new BaseMarker()

Source:

Methods

appendMarker(marker)

Attach a marker to this object. If marker already exists, nothing will be done.
Parameters:
Name Type Description
marker Kekule.ChemObject
Inherited From:
Source:

clearMarkers()

Remove all attached markers.
Inherited From:
Source:

fetchMarkerOfType(classType, canCreate, exactMatch, defProps) → {Kekule.ChemObject}

Get attached marker of classType. If no such a marker currently and canCreate is true, a new marker will be created.
Parameters:
Name Type Description
classType Class
canCreate Bool
exactMatch Bool If true, only marker of classType (not its descendants) should be returned.
defProps Hash If create a new marker, those prop values will be applied.
Inherited From:
Source:
Returns:
Type
Kekule.ChemObject

getMarkerAt(index) → {Kekule.ChemObject}

Get attached marker at index.
Parameters:
Name Type Description
index Int
Inherited From:
Source:
Returns:
Type
Kekule.ChemObject

getMarkerCount() → {Int}

Return count of attached markers.
Inherited From:
Source:
Returns:
Type
Int

getMarkerOfType(classType, exactMatch) → {Kekule.ChemObject}

Returns the first child marker of a specified class type.
Parameters:
Name Type Description
classType Class
exactMatch Bool If true, only marker of classType (not its descendants) should be returned.
Inherited From:
Source:
Returns:
Type
Kekule.ChemObject

getMarkersOfType(classType, exactMatch) → {Array}

Returns all child markers of a specified class type.
Parameters:
Name Type Description
classType Class
exactMatch Bool If true, only markers of classType (not its descendants) should be returned.
Inherited From:
Source:
Returns:
Type
Array

getUnplacedMarkers(coordMode) → {Array}

Returns markers that has no coord on coordMode
Parameters:
Name Type Description
coordMode Int
Inherited From:
Source:
Returns:
Type
Array

hasMarker(marker) → {Bool}

Check if a marker has been attached to this object.
Parameters:
Name Type Description
marker Kekule.ChemObject
Inherited From:
Source:
Returns:
Type
Bool

hasMarkerOfType(classType, exactMatch) → {Bool}

Returns whether there exists child markers of a specified class type.
Parameters:
Name Type Description
classType Class
exactMatch Bool If true, only markers of classType (not its descendants) should be considered.
Inherited From:
Source:
Returns:
Type
Bool

indexOfMarker(marker) → {Int}

Get index of attached marker in marker array.
Parameters:
Name Type Description
marker Kekule.ChemObject
Inherited From:
Source:
Returns:
Type
Int

insertMarkerAt(marker, index)

Insert marker to index. If index is not set, marker will be inserted to the tail of the marker array.
Parameters:
Name Type Description
marker Kekule.ChemObject
index Int
Inherited From:
Source:

insertMarkerBefore(marker, refMarker) → {Int}

Insert marker before refMarker in marker list. If refMarker is null or does not exists, marker will be append to tail of list.
Parameters:
Name Type Description
marker Kekule.ChemObject
refMarker Kekule.ChemObject
Inherited From:
Source:
Returns:
Index of obj after inserting.
Type
Int

isAttachedMarker() → {Bool}

Returns whether current object is an attachedMarker of parent object.
Inherited From:
Source:
Returns:
Type
Bool

removeMarker(marker)

Remove an attached marker.
Parameters:
Name Type Description
marker Kekule.ChemObject
Inherited From:
Source:

removeMarkerAt(index)

Remove marker at index in attached marker list.
Parameters:
Name Type Description
index Int
Inherited From:
Source:

replaceMarker(oldMarker, newMarker)

Replace oldMarker with new one.
Parameters:
Name Type Description
oldMarker Kekule.ChemObject
newMarker Kekule.ChemObject
Inherited From:
Source:

setMarkerIndex(marker, index)

Change index of marker.
Parameters:
Name Type Description
marker Kekule.ChemObject
index Int
Inherited From:
Source: