@arqlet/engine-client
v0.3.0
Published
The Arqlet graph-layout engine as WebAssembly, with a loader, a worker protocol, an ELK-style layout call and preset sequencing. Provisional.
Maintainers
Readme
@arqlet/engine-client
The Arqlet engine as WebAssembly (arqlet.wasm, included) and its JavaScript access:
engine.js:loadEngine(url?)(browser viafetch, Node from disk),sceneOf(run, snapshot),createEngineWorker(url?);wasm-client.js:createEngine(bytes, {onPublish}), the raw binding;elk.js:createElkLayout(run), anelk.layout(graph)-style call;session.js:createSession(run), a layout session that keeps positions across changes (collapse, expand, …) with revision checks, andworkerRun(worker), the worker as an asynchronousrun;presets.js:presetStateandapplyPreset.
Most users want the arqlet package, which re-exports these.
Bundlers that understand new URL('./arqlet.wasm', import.meta.url) (Vite, webpack 5,
esbuild with a loader) copy the engine along; otherwise pass its URL to loadEngine.
Status: prototype. The API, the JSON protocol and the snapshot format are provisional and may change in any release.
Part of Arqlet, an incremental graph-layout engine in Rust. See the repository for documentation and the current status.
License
Licensed under either of Apache License, Version 2.0 or MIT license at your option.
