Documentation Index
About 3 min
Documentation Index
Quick Search
Press Ctrl + K or / to quickly search through the documentation
Online Examples
All examples are available online: Live Demo{target="_blank"}
Getting Started
| Document | Description |
|---|---|
| Introduction | WebCAD overview and core features |
| Quick Start | Quick start tutorial |
| Architecture | System architecture and module relationships |
Basic Examples
| Document | Description |
|---|---|
| Basic Examples | Initialization, loading, Viewer mode and other basic features |
| Comprehensive Examples | Complete application scenario examples |
Core Concepts
| Document | Description |
|---|---|
| Engine | CAD engine core class |
| Document | Drawing document management |
| Coordinate System | Coordinate systems and transformations |
Creating Entities
| Document | Description |
|---|---|
| Entity Overview | All entity types and example links |
| Entity Base Class | Base class and common properties for all entities |
| Custom Entities | Creating custom entity types |
Basic Geometry Entities
| Document | Description |
|---|---|
| Line | Line entity |
| Circle | Circle entity |
| Arc | Arc entity |
| Polyline | Polyline entity |
| Ellipse | Ellipse entity |
| Spline | Spline curve entity |
| Ray & XLine | Ray and infinite construction line |
| Dot | Dot entity |
| Hatch | Hatch pattern |
| Solid | Solid fill region |
Text Entities
| Document | Description |
|---|---|
| Text | Single-line text entity |
| MText | Multi-line rich text entity |
Blocks & Images
| Document | Description |
|---|---|
| Insert | Block insert entity |
| Block Definition | Block definition and management |
| Image | Image entity |
Properties
| Document | Description |
|---|---|
| Property Operations | Color, layer, linetype, lineweight, transparency settings |
Edit Operations
| Document | Description |
|---|---|
| Edit Operations | Move, copy, rotate, scale, mirror, delete operations |
| Edit Commands | COPY, MOVE, ROTATE commands |
Layer Management
| Document | Description |
|---|---|
| Layer Management | Layer creation, switching, visibility, freeze, lock |
| Layer Details | Layer system detailed explanation |
| Layer Commands | Layer-related commands |
Geometry
| Document | Description |
|---|---|
| Geometry Calculations | Distance, angle, intersection, area calculations |
| Point2d | 2D point class |
| BoundingBox | Bounding rectangle calculations |
| Calculations | Distance, angle calculations |
| Intersection | Entity intersection detection |
| Selection Algorithms | Point and window selection algorithms |
| Boundary | Closed boundary detection |
| Area | Area calculation methods |
| Spline | Spline curve algorithms |
Events
| Document | Description |
|---|---|
| Event Handling | Entity, document, command event listeners |
| Event Types | Supported event type list |
| Event Usage | Event listening and handling |
Reactor System
| Document | Description |
|---|---|
| Reactors | Entity association and constraints |
| Reactor Details | Reactor mechanism and usage |
User Input
| Document | Description |
|---|---|
| User Input | getPoint, getSelections and other input methods |
| Input System | Command input mechanism |
| Point Input | Point coordinate input |
Insert Graphics
| Document | Description |
|---|---|
| Insert Graphics | Symbol library, SVG import, image vectorization |
Command Development
| Document | Description |
|---|---|
| Command Development | Custom command development guide |
| Command Basics | Command system introduction |
| Command Architecture | Command system architecture |
| Create Command | Creating custom commands |
| Undo/Redo | Command undo/redo |
| Preview Drawing | Real-time preview drawing |
| Command Patterns | Common command patterns |
| Best Practices | Command development best practices |
| API Reference | Command API reference |
Built-in Command Reference
| Document | Description |
|---|---|
| Command Quick Ref | All commands quick reference |
| Drawing Commands | LINE, CIRCLE, ARC, etc. |
| Modify Commands | TRIM, EXTEND, FILLET, etc. |
| Block Commands | Block operation commands |
| Symbol Commands | Symbol library commands |
| Dimension Commands | Dimension annotation commands |
| Text Commands | Text editing commands |
| Inquiry Commands | Distance, area inquiry |
| System Commands | Settings, options commands |
| Import Commands | Import/export commands |
| Property Commands | Property editing commands |
| Script Execution | Script execution |
| Code Execution | Code execution interface |
View Operations
| Document | Description |
|---|---|
| View Operations | Zoom, pan, redraw, coordinate transformations |
| View Commands | Zoom, pan commands |
Selection
| Document | Description |
|---|---|
| Selection Operations | Set/get selection sets, filter by type/condition |
| Entity Selection | Selection set operations in detail |
Undo/Redo
| Document | Description |
|---|---|
| Undo/Redo | undo/redo, undo marks, undo groups |
| Undo/Redo Details | Undo/redo mechanism |
UI Extensions
| Document | Description |
|---|---|
| UI Extensions | Ribbon, context menu, dialog customization |
| Ribbon | Ribbon interface customization |
| Context Menu | Context menu extensions |
| Icons | Icon usage and customization |
| Dialogs | Dialog components |
| Pickers | Color, layer pickers |
| Controls | UI control components |
| Preview View | Preview window component |
| Viewer Mode | Read-only viewer mode |
| Map Overlay | CAD map overlay display |
Plugin Development
| Document | Description |
|---|---|
| Plugin Development | Plugin system overview and examples |
| Plugin Basics | Plugin development introduction |
| Plugin Context | Plugin context and API |
| Menu & Ribbon | Custom menus and Ribbon |
| Plugin Examples | Complete plugin examples |
File Operations
| Document | Description |
|---|---|
| File Operations | Open, save, import, export |
| File Operations Details | File operations detailed explanation |
Tile Editing
| Document | Description |
|---|---|
| Tile Editing | Opening and editing large drawings in tile mode |
| Tile Mode | Tile mode detailed explanation |
Version Control
| Document | Description |
|---|---|
| Version Control | Branching, patches, merging, conflict resolution |
| Versioning | Version control detailed explanation |
Smart Recognition
| Document | Description |
|---|---|
| Smart Recognition | Table extraction and other smart features |
| Table Extraction | Table data extraction API |
API Reference
| Document | Description |
|---|---|
| API Overview | API reference introduction |
| Symbol API | Symbol library API |