@hpcc-js/wasm
Advanced tools
This repository contains a collection of useful c++ libraries compiled to WASM for (re)use in Web Browsers and JavaScript Libraries.
The simplest way to include this project is via NPM:
npm install --save @hpcc-js/wasm
@hpcc-js/wasm includes the following files in its dist folder:
index.js / index.min.js files: Exposes all the available APIs for all WASM files.graphvizlib.wasmImportant: WASM files are dynamically loaded at runtime (this is a browser / emscripten requirement), which has a few implications for the consumer:
Pros:
Cons:
fetch and loading pages via file:// URN, so for testing / development work you will need to run a test web server.Utility functions relating to @hpcc-js/wasm as a package
If url is specified, sets the default location for all WASM files. If url is not specified it returns the current url (defaults to undefined).
Global variable for setting default WASM location, this is an alternative to wasmFolder
graphvizlib.wasm)GraphViz WASM library, see graphviz.org for c++ details. While this package is similar to Viz.js, it employs a completely different build methodology taken from GraphControl.
The GraphViz library comes in two flavours
graphviz namespace, where each API function is asynchrounous and returns a Promise<string>.graphvizSync asynchrounous function which returns a Promise<GraphvizSync> which is a mirror instance of graphviz, where each API function is synchrounous and returns a string.<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>GraphViz WASM</title>
<script src="https://unpkg.com/@hpcc-js/wasm/dist/index.min.js"></script>
<script>
var hpccWasm = window["@hpcc-js/wasm"];
</script>
</head>
<body>
<div id="placeholder"></div>
<div id="placeholder2"></div>
<script>
const dot = `
digraph G {
node [shape=rect];
subgraph cluster_0 {
style=filled;
color=lightgrey;
node [style=filled,color=white];
a0 -> a1 -> a2 -> a3;
label = "Hello";
}
subgraph cluster_1 {
node [style=filled];
b0 -> b1 -> b2 -> b3;
label = "World";
color=blue
}
start -> a0;
start -> b0;
a1 -> b3;
b2 -> a3;
a3 -> a0;
a3 -> end;
b3 -> end;
start [shape=Mdiamond];
end [shape=Msquare];
}
`;
// Asynchronous call to layout
hpccWasm.graphviz.layout(dot, "svg", "dot").then(svg => {
const div = document.getElementById("placeholder");
div.innerHTML = svg;
});
hpccWasm.graphvizSync().then(graphviz => {
const div = document.getElementById("placeholder2");
// Synchronous call to layout
div.innerHTML = graphviz.layout(dot, "svg", "dot");
});
</script>
</body>
</html>
# layout(dotSource[, outputFormat][, layoutEngine]) · <>
Performs layout for the supplied dotSource, see The DOT Language for specification.
outputFormat supports the following options:
See Output Formats for more information.
layoutEngine supports the following options:
See Layout manual pages for more information.
# circo(dotSource[, outputFormat]) · <>
Convenience function that performs circo layout, is equivalent to layout(dotSource, outputFormat, "circo");.
# dot(dotSource[, outputFormat]) · <>
Convenience function that performs dot layout, is equivalent to layout(dotSource, outputFormat, "dot");.
# fdp(dotSource[, outputFormat]) · <>
Convenience function that performs circo layout, is equivalent to layout(dotSource, outputFormat, "fdp");.
# neato(dotSource[, outputFormat]) · <>
Convenience function that performs neato layout, is equivalent to layout(dotSource, outputFormat, "neato");.
# osage(dotSource[, outputFormat]) · <>
Convenience function that performs osage layout, is equivalent to layout(dotSource, outputFormat, "osage");.
# patchwork(dotSource[, outputFormat]) · <>
Convenience function that performs patchwork layout, is equivalent to layout(dotSource, outputFormat, "patchwork");.
# twopi(dotSource[, outputFormat]) · <>
Convenience function that performs twopi layout, is equivalent to layout(dotSource, outputFormat, "twopi");.
Building is supported on both Linux (tested with Ubuntu 18.04) and Windows (with WSL installed)
There are several required OS dependencies which can be installed with:
sudo ./scripts/cpp-install-prerequisites.sh
(See ./scripts/cpp-install-prerequisites.sh for details)
git clone https://github.com/hpcc-systems/hpcc-js-wasm.git
cd hpcc-js-wasm
npm ci
npm run install-build-deps
npm run build
Note: The install-build-deps downloads both the Emscripten SDK and the GraphViz sources. This has been made a manual step as the downloads are quite large and the auto-configuration can be time consuming.
FAQs
hpcc-js - WASM Libraries
The npm package @hpcc-js/wasm receives a total of 0 weekly downloads. As such, @hpcc-js/wasm popularity was classified as not popular.
We found that @hpcc-js/wasm demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.