vjmapext documentation index

Search

Press Ctrl + K to search, or browse the sections below.

Live demos

Runnable demos are available in the vjmapext Demo Playground.

Getting started

Doc	Description
Product overview	Positioning, features, and use cases
Quick start	Environment, install, first drawing
Architecture	Layers, components, data flow

Tutorials

Doc	Description
Tutorial index	Learning path
Entity basics	Create, add, and manage entities
Entity advanced	Blocks, dimensions, splines, custom entities
Commands & input	Commands, input, object snap
Layers & properties	Layers and entity properties
Serialization	JSON import/export and defaults
SVG import	SVG parsing and block refs
UI & plugins	Built-in UI and plugin intro

Core concepts

Doc	Description
MapCadLayer	Main control — facade for all subsystems
Coordinate system	CoordMapper — CAD vs map coordinates
EntityStore	Storage, selection, spatial index
RenderPipeline	GeoJSON pipeline and map sources

Entities

Doc	Description
Entity overview	All entity types and demo index
EntityBase	Base class — style, layer, props, transform
PointEnt	Point entity
LineEnt	Line segment
PolylineEnt	Polyline / closed polygon
CircleEnt	Circle
ArcEnt	Arc
EllipseEnt	Ellipse / elliptical arc
SplineEnt	B-spline
HatchEnt	Hatch / pattern fill
TextEnt	Single-line text
MTextEnt	Multiline text
BlockDef / BlockRefEnt	Block definitions and references
Dimensions	Linear, aligned, angular, radial
MLeaderEnt	Multileader
Custom entities	Extend EntityBase
Entity transforms	Move, rotate, scale, mirror

Linetype system

Doc	Description
Linetype overview	LinetypeManager
Built-in linetypes	Predefined linetypes
Custom linetypes	Custom definitions
Complex linetypes	Shapes in linetypes
Linetype scale	Global and per-entity scale

Annotation system

Doc	Description
Annotation overview	DimReactorManager
Linear dimension	Horizontal / vertical
Aligned dimension	Along two points
Angular dimension	Angle between lines
Radial dimension	Circle / arc radius
Multileader	Multileader annotation
Dimension style	Arrows, text, color
Associative dimensions	Linked updates

Editing

Doc	Description
Editing overview	Edit commands
Move & copy	MOVE / COPY
Rotate & scale	SCALE and rotation
Mirror & erase	MIRROR / ERASE
Undo & redo	UndoManager stack
Grip editing	GripManager

Property system

Doc	Description
Property overview	Property model
Basic properties	Color, linetype, width, layer, visibility
Custom properties	customProperties & serialization
Display level	minDisplayLevel / maxDisplayLevel
Selectable & editable	editable / selectableInReadonly
Visual effects	Glow, highlight, etc.

Layer management

Doc	Description
Layer overview	Layer concepts
Manage layers	Create, visibility
Layer style	Default color and linetype

Events

Doc	Description
Event overview	EventBus
Entity events	entity:added / deleted / modified
Mouse events	mouseenter / leave / click
Selection events	selection:changed, box select
Command events	command:start/end, mode:changed
Topology events	Topology & dimension reactors

Input & interaction

Doc	Description
Input overview	InputManager state machine
Get point	getPoint
Get selection	getSelection
Get values	getReal / getInteger
Get keyword	getKeyword

Commands

Doc	Description
Command overview	CommandRegistry
Execute commands	executeCommand
Register commands	Custom commands
Preview commands	PreviewManager
Built-in command list	Reference table
Drawing command modes	CIRCLE / ARC / ELLIPSE / RECTPOLY / PLINE keywords
DLINE	Double lines, corners, butt/square/round caps
REVCLOUD	Revision cloud from bulge polyline

Object snap

Doc	Description
Snap overview	SnapManager
Snap modes	Endpoint, midpoint, center, intersection, …
Snap while drawing	Live snap during commands

Serialization

Doc	Description
Serialization overview	Document serialization
Import & export	toJSON / fromJSON
Drawing defaults	DrawingDefaults persistence

Map data integration

Doc	Description
Overview	Query / convert / hide / export-delete
Query DWG entities	queryMapEntities, entTypes, combineWhere
Feature → entity	GeoJSON mapping, fallbackToGeometry
Hide source entities	MapEntityHider
Export, delete & hooks	exportDwg, onBeforeUpdate, deleteObjectIds

SVG import

Doc	Description
SVG overview	SVG parsing
SVG parsing	svgToEntities
SVG to block	createBlockDefFromSvg

Geometry

Doc	Description
Geometry overview	Geometry utilities
Distance & midpoint	Distances and midpoints
Transforms	Transform matrices
Spatial queries	SpatialIndex / R-tree
CoordMapper	Coordinate mapping
Construction	Intersections, tangents

Animation

Doc	Description
Animation overview	AnimationManager
Basic animation	Tween
Path animation	PathAnimator
Easing	Easing functions
Color animation	lerpColor
Effects	Radar, trail, pulse, blink
Performance	Best practices

High-performance FX layer (fx)

Doc	Description
FX overview	Naming, capability map, vs CPU animation
Quick start	First halo in three lines — handles, batch, color
Coordinates & size units	cad / lngLat / mercator × map / pixels
Point presets	12 presets: fire, pulseRing, halo, radarSweep, smoke, lightning, meteor, vortex, shield, firework, crosshair, shadertoy
Line presets	flowLine, meteor, lightning, arrowFlow, dashFlow — head/base, reverse
Triggers & lifecycle	Handles, setPointData, batch APIs, triggerOnce
Shadertoy	Point / line / fullscreen entries + five alphaMode values
Bind to CAD entities	bindToEntity, follow geometry, mode-aware visibility
Symbol shader icons	Bake shaders to icons — scale with data + SDF + icon-color
Runtime tuning & monitoring	bucket, setQuality, events, getMetrics, stress numbers
API reference	Public types and “I want to…” API map

UI components

Doc	Description
UI overview	ToolbarManager
Toolbar	Toolbar configuration
Theme	Dark / light
Panels	Property, command line, layer, JSON
Mode switch	Edit / browse
Shortcuts	Keyboard shortcuts

Plugins

Doc	Description
Plugin overview	PluginManager
Basic plugin	Getting started
Plugin lifecycle	install / activate / deactivate

Internationalization

Doc	Description
i18n	locale, setLocale / getLocale, t()

Comprehensive examples

Doc	Description
Examples index	Real-world integrations
Personnel & data	Staff positioning on CAD basemap
Geological section	Geological cross-section

API reference

Doc	Description
API overview	Quick reference
MapCadLayer	Main control API
EntityBase	Entity base API
EntityStore	Storage API
CommandRegistry	Commands API
InputManager	Input API
EventBus	Events API
SnapManager	Snap API
UndoManager	Undo API
AnimationManager	Animation API
PluginManager	Plugins API
LinetypeManager	Linetypes API
Types	Public types & interfaces