new Base(id, coord2D, coord3D)
Represent an small glyph in chem document (especially in 2D rendering).
Parameters:
| Name | Type | Description |
|---|---|---|
id |
String | Id of this object. //@param {String} glyphName Name of this glyph. |
coord2D |
Hash | The top left 2D coordinates of glyph, {x, y}, can be null. |
coord3D |
Hash | The min 3D coordinates of glyph box, {x, y, z}, can be null. Usually unneeded. //@property {String} glyphName Name of this glyph. |
Properties:
| Name | Type | Description |
|---|---|---|
coord2D |
Hash | The 2D coordinates of glyph, {x, y}. |
coord3D |
Hash | The 3D coordinates of glyph, {x, y, z}. |
absCoord2D |
Hash | The absolute 2D coordinates of glyph, {x, y}. |
absCoord3D |
Hash | The absolute 3D coordinates of glyph, {x, y, z}. |
size2D |
Hash | The 2D dimension (width, height) of glyph, {x, y}. |
size3D |
Hash | The 3D dimension (width, height, depth) of glyph, {x, y, z}. |
- Source:
Extends
Methods
-
appendMarker(marker)
-
Attach a marker to this object. If marker already exists, nothing will be done.
Parameters:
Name Type Description markerKekule.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 classTypeClass canCreateBool exactMatchBool If true, only marker of classType (not its descendants) should be returned. defPropsHash 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 indexInt - 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 classTypeClass exactMatchBool 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 classTypeClass exactMatchBool 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 coordModeInt - Inherited From:
- Source:
Returns:
- Type
- Array
-
hasMarker(marker) → {Bool}
-
Check if a marker has been attached to this object.
Parameters:
Name Type Description markerKekule.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 classTypeClass exactMatchBool 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 markerKekule.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 markerKekule.ChemObject indexInt - 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 markerKekule.ChemObject refMarkerKekule.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 markerKekule.ChemObject - Inherited From:
- Source:
-
removeMarkerAt(index)
-
Remove marker at index in attached marker list.
Parameters:
Name Type Description indexInt - Inherited From:
- Source:
-
replaceMarker(oldMarker, newMarker)
-
Replace oldMarker with new one.
Parameters:
Name Type Description oldMarkerKekule.ChemObject newMarkerKekule.ChemObject - Inherited From:
- Source:
-
setMarkerIndex(marker, index)
-
Change index of marker.
Parameters:
Name Type Description markerKekule.ChemObject indexInt - Inherited From:
- Source: