Skip to content

Instantly share code, notes, and snippets.

@mcanthony

mcanthony/LICENSE

Forked from curran/LICENSE
Created October 14, 2015 00:03
Show Gist options
  • Save mcanthony/dfd9c1227c619ba6a05d to your computer and use it in GitHub Desktop.
Save mcanthony/dfd9c1227c619ba6a05d to your computer and use it in GitHub Desktop.
Download ZIP
Chiasm Boilerplate
Raw
README.md

Boilerplate starter code for Chiasm.

This example demonstrates the minimal code required to get started developing your own Chiasm applications and custom plugins.

To get started, go ahead and edit this example on blockbuilder.org. From there you can publish your work to bl.ocks.org.

The Chiasm plugins demonstrated here are:

  • chiasm-layout A Chiasm plugin for nested box layout. You can use this plugin to impose a grid system of rectangles on any collection of Chiasm components.

  • coloredRectangle An example custom Chiasm component that draws a colored rectangle using D3.js and SVG. The naming convention of my for the component is inspired by the wonderful piece on reusable D3 charts Towards Reusable Charts.

The configuration in chiasmConfig.json is intended to show how chiasm-layout can be set up with arbitrary levels of nested boxes. If you want something more mininal to start from, use chiasmConfigSimplest.json.

web counter
Raw
chiasmConfig.json
{
"layout": {
"plugin": "layout",
"state": {
"containerSelector": "#chiasm-container",
"layout": {
"orientation": "vertical",
"children": [
"A",
{
"orientation": "horizontal",
"children": [
"B",
{
"orientation": "vertical",
"children": [
"C",
"D"
]
},
"E"
]
}
]
}
}
},
"A": {
"plugin": "coloredRectangle"
},
"B": {
"plugin": "coloredRectangle",
"state": {
"color": "#a8f0ff"
}
},
"C": {
"plugin": "coloredRectangle",
"state": {
"color": "#ffe2a8"
}
},
"D": {
"plugin": "coloredRectangle",
"state": {
"color": "#99e2c8"
}
},
"E": {
"plugin": "coloredRectangle",
"state": {
"color": "#a8ffd0"
}
}
}
Raw
chiasmConfigSimplest.json
{
"layout": {
"plugin": "layout",
"state": {
"containerSelector": "#chiasm-container",
"layout": "visualization"
}
},
"visualization": {
"plugin": "coloredRectangle",
"state": {
"color": "blue"
}
}
}
Raw
coloredRectangle.js
// An example custom Chiasm component that draws a colored rectangle using D3.js and SVG.
function ColoredRectangle() {
// Construct a Chiasm component instance,
// specifying default values for public properties.
var my = ChiasmComponent({
// The color of the rectangle, a CSS color string.
color: "white"
});
// Expose a div element that will be added to the Chiasm container.
// This is a special property that chiasm-layout looks for.
my.el = document.createElement("div");
// Create an SVG DOM element using D3 and append it to the div.
var svg = d3.select(my.el).append("svg");
// Add a background rectangle to the SVG element.
var rect = svg.append("rect");
// Set the rectangle color to be the configured color.
my.when("color", function (color){
rect.attr("fill", color);
});
// Respond to dynamic width and height.
// "box" is a special property set by chiasm-layout.
my.when("box", function (box) {
// Set the size of the SVG element.
svg
.attr("width", box.width)
.attr("height", box.height);
// Set the size of the background rectangle.
rect
.attr("width", box.width)
.attr("height", box.height);
});
return my;
}
Raw
index.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Chiasm Boilerplate</title>
<!-- By Curran Kelleher September 2015. Released under MIT Licence. -->
<!-- Chiasm depends on Lodash, D3.js, and Model.js. -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/lodash.js/3.10.1/lodash.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/d3/3.5.6/d3.min.js"></script>
<!-- A functional reactive model library. github.com/curran/model -->
<script src="http://curran.github.io/model/cdn/model-v0.2.4.js"></script>
<!-- Chiasm core and plugins. github.com/chiasm-project -->
<script src="http://chiasm-project.github.io/chiasm/chiasm-v0.2.0.js"></script>
<script src="http://chiasm-project.github.io/chiasm-component/chiasm-component-v0.2.0.js"></script>
<script src="http://chiasm-project.github.io/chiasm-layout/chiasm-layout-v0.2.1.js"></script>
<!-- Custom Chiasm plugins for this example. -->
<script src="coloredRectangle.js"></script>
<!-- Make the Chiasm container fill the page and have a 20px black border. -->
<style>
body {
background-color: black;
}
/* Make the Chiasm container fill the page with a 20px margin. */
#chiasm-container {
background-color: white;
position: fixed;
left: 20px;
right: 20px;
top: 20px;
bottom: 20px;
}
</style>
</head>
<body>
<!-- The Chiasm Layout Plugin will inject components into this div. -->
<div id="chiasm-container"></div>
<script>
// Create a new Chiasm instance.
var chiasm = new Chiasm();
// Register plugins that configurations can access.
chiasm.plugins.layout = ChiasmLayout;
chiasm.plugins.coloredRectangle = ColoredRectangle;
// Use D3 to fetch the chiasm configuration file.
d3.json("chiasmConfig.json", function (config){
// Set the Chaism application configuration.
chiasm.setConfig(config);
});
</script>
</body>
</html>
Raw
LICENSE
The MIT License (MIT)
Copyright (c) 2015 Curran Kelleher
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment