MLightCAD
    Preparing search index...

    Manages read-only reference drawing sessions overlaid on the active document.

    XATTACH and the External References palette should go through this manager instead of binding source entities into the host database.

    Index

    Constructors

    Accessors

    Methods

    • Shows or hides an xref overlay by session id.

      Parameters

      • id: string

        Session id of the overlay to update.

      • visible: boolean

        Desired visibility state.

      Returns boolean

      true if the session exists and visibility was applied; otherwise false.

    • Shows or hides an xref overlay by host block-table record name.

      Parameters

      • blockName: string

        Host BTR name associated with the xref.

      • visible: boolean

        Desired visibility state.

      Returns boolean

      true if a matching session exists and visibility was applied; otherwise false.

    • Removes overlay geometry and clears the session map entry.

      Host BTR/INSERT are left untouched (Unload semantics).

      Parameters

      • id: string

        Session id to unload.

      Returns boolean

      true if the session existed and was removed; otherwise false.

    • Unloads an xref overlay by host block-table record name.

      Parameters

      • blockName: string

        Host BTR name associated with the xref.

      Returns boolean

      true if a matching session existed and was unloaded; otherwise false.

    • Creates an empty xref block-table record and INSERT on the host database.

      Source entities are intentionally not bound into the BTR; geometry is shown via a separate overlay session managed by this class.

      Parameters

      • hostDb: AcDbDatabase

        Host drawing database that receives the BTR and INSERT.

      • blockName: string

        Name for the new xref block-table record.

      • pathName: string

        Path stored on the BTR (pathName property).

      • transform: AcApXrefTransform

        Position, scale, and rotation applied to the INSERT.

      • Optionalorigin: AcGeVector3dLike

        Optional block origin for the xref BTR.

      Returns { insert: AcDbBlockReference; record: AcDbBlockTableRecord }

      The created block-table record and block reference.