openchemlib 9.14.0 → 9.15.0

package/dist/openchemlib.d.ts

@@ -1701,9 +1701,10 @@ export declare class Molecule {
    * label rather than replacing the original atom label. If label is null or
    * equals the normal atom label, then the custom label is removed.
    * @param atom
-   * @param label - null to remove custom label
+   * @param label - `null` to remove custom label.
+   * @returns Whether the label was changed.
    */
-  setAtomCustomLabel(atom: number, label: string | null): void;
+  setAtomCustomLabel(atom: number, label: string | null): boolean;
 
   /**
    * This is MDL's enhanced stereo representation (ESR). Stereo atoms and bonds
@@ -2977,14 +2978,52 @@ export declare class Canonizer {
 }
 
 /**
- * All depictor options default to `false`.
+ * All boolean depictor options except `inflateToMaxAVBL` and `chiralTextBelowMolecule` default to `false`.
  */
 export interface DepictorOptions {
+  /**
+   * Must be an integer between 0 and 65535.
+   *
+   * If 0 is passed, a constant value of 24 will be used regardless of `inflateToHighResAVBL`.
+   * @default 0
+   */
+  maxAVBL?: number;
+
+  // Please keep the next groups and ordering the same as in AbstractDepictor.java
+  // We reserve the right to improve / fix names if it makes them easier to understand.
+  // Examples: hilite -> highlight, atomNo -> showAtomNumber
+
+  /**
+   * Mutually exclusive with `inflateToHighResAVBL`.
+   * @default true (if inflateToHighResAVBL is not set)
+   */
   inflateToMaxAVBL?: boolean;
+  /**
+   * Mutually exclusive with `inflateToMaxAVBL`.
+   *
+   * Only has an effect if `maxAVBL` has a value different from 0.
+   * @default false
+   */
   inflateToHighResAVBL?: boolean;
+  /**
+   * Put the chiral text just below the molecule.
+   * @default true
+   */
   chiralTextBelowMolecule?: boolean;
+  /**
+   * Put the chiral text just above the molecule.
+   * @default false
+   */
   chiralTextAboveMolecule?: boolean;
+  /**
+   * Put the chiral text at the top of the frame.
+   * @default false
+   */
   chiralTextOnFrameTop?: boolean;
+  /**
+   * Put the chiral text at the bottom of the frame.
+   * @default false
+   */
   chiralTextOnFrameBottom?: boolean;
 
   noTabus?: boolean;
@@ -2995,7 +3034,6 @@ export interface DepictorOptions {
   suppressChiralText?: boolean;
   suppressCIPParity?: boolean;
   suppressESR?: boolean;
-  noCarbonLabelWithCustomLabel?: boolean;
 
   showSymmetryAny?: boolean;
   showSymmetrySimple?: boolean;
@@ -3005,6 +3043,7 @@ export interface DepictorOptions {
   noColorOnESRAndCIP?: boolean;
   noImplicitHydrogen?: boolean;
   drawBondsInGray?: boolean;
+  noCarbonLabelWithCustomLabel?: boolean;
 }
 
 export declare class Reaction {