mandelbrot-set

Julia and Mandelbrot Sets

NPM version Build Status Maintainability devDependency Status JavaScript Style Guide

Web components and a web worker for painting Julia and Mandelbrot sets on a web page, including interactive controls. See the sources too.

Synopsis

Place elements of your choice to your web page and load their script at the end of the body element. You can use either a global stylesheet to style the custom elements, or an element-specific one to turn them to isolated web components.

<mandelbrot-set
  stylesheet="https://unpkg.com/mandelbrot-set@2.2.0/public/assets/mini-default.min.css"
  palette="jewels" iteration-threshold="150" scale="50"
  width="600" height="300" offset-x="0.465" offset-y="1.980"></mandelbrot-set>
<script
  src="https://unpkg.com/mandelbrot-set@2.2.0/public/scripts/mandelbrot-all.min.js"
  type="module"></script>

Mandelbrot All Example

Common

You can import single components as written below, or you can use the single minified JavaScript bundle with all of them:

<script
  src="https://unpkg.com/mandelbrot-set@2.2.0/public/scripts/mandelbrot-all.min.js"
  type="module"></script>

Before you insert any other custom element, you may need to set the URL to the web worker for performing the computations. The URL may be either absolute or relative to the path of the current page. The following is the default:

<mandelbrot-set-computer
  src="https://unpkg.com/mandelbrot-set@2.2.0/public/scripts/computer.js"
  ></mandelbrot-set-computer>

If you use a stylesheet, which normalizes and styles plain HTML elements, like mini.css, it will apply to the configuration form and manipulation toolbar too:

<link
  href="https://cdnjs.cloudflare.com/ajax/libs/mini.css/3.0.1/mini-default.min.css"
  rel="stylesheet">

Mandelbrot and Julia Sets

Import the web component with Julia or Mandelbrot set graphs by including its module at the end of the body element on your HTML page.:

<script
  src="https://unpkg.com/mandelbrot-set@2.2.0/public/scripts/mandelbrot-set-graph.js"
  type="module"></script>
<script
  src="https://unpkg.com/mandelbrot-set@2.2.0/public/scripts/julia-set-graph.js"
  type="module"></script>

Place the web component where you want to see it and set its attributes. The following ones are the defaults:

<mandelbrot-set-graph
  palette="grayscale" iteration-threshold="20" scale="1"
  width="400" height="400" offset-x="0" offset-y="0"
  id="graph"></mandelbrot-set-graph>
<julia-set-graph
  palette="grayscale" iteration-threshold="20" scale="1"
  width="400" height="400" offset-x="0" offset-y="0"
  kr="0.4" ki="0.4" id="graph"></julia-set-graph>

Possible colour palettes are “grayscale”, “jewels”, “fiety”, “rainbow”, “sharp”, “onion”, “poison”, “garden”, and “sky”.

Mandelbrot Set Example Julia Set Example

Configuration Form

In addition to Julia or Mandelbrot set graphs described above, import the web component with the configuration form by including its module at the end of the body element on your HTML page:

<script
  src="https://unpkg.com/mandelbrot-set@2.2.0/public/scripts/mandelbrot-set-form.js"
  type="module"></script>

Place the web component where you want to see it and set its attributes. The attribute for may to point to a graph element by its ID, if you want to wire them automatically:

<mandelbrot-set-form id="settings" for="graph"></mandelbrot-set-form>
<julia-set-form id="settings" for="graph"></julia-set-form>

Mandelbrot Configuration Example Julia Configuration Example

If you point the for attribute to the element with the graph, the form will be wired with it automatically, so that changes of field values will result in updating the graph. If you do not, you will be able to reuse the form for multiple graphs, but you will have to wire it to them manually:

addEventListener('DOMContentLoaded', function () {
  const form = document.getElementById('settings')
  const graph = document.getElementById('graph')
  form.addEventListener('submit', refreshGraph)

  function refreshGraph () {
    graph.suppressUpdates()
    graph.setParameters(form.getParameters())
    graph.resumeUpdates()
  }
})

If you want to isolate the styling of the form, set the stylesheet URL to the stylesheet attribute:

<mandelbrot-set-form
  stylesheet="https://cdnjs.cloudflare.com/ajax/libs/mini.css/3.0.1/mini-default.min.css"
  id="settings"></mandelbrot-set-form>

The page mandelbrot.html integrates the form in-place on the page. The page julia.html opens the form in a modal dialog when clicking on the button with the settings icon.

Manipulation Toolbar

If you want to make panning and zoomin in Julia or Mandelbrot set graphs easier, import the web component with the manipulation toolbar by including its module at the end of the body element on your HTML page:

<script
  src="https://unpkg.com/mandelbrot-set@2.2.0/public/scripts/mandelbrot-set-toolbar.js"
  type="module"></script>

Place the web component where you want to see it and set its attributes. The attribute for has to point to a graph element by its ID. The following attribute values are defaults:

<mandelbrot-set-toolbar
  panning="true" zooming="true" settings="true"
  id="toolbar" for="graph"></mandelbrot-set-toolbar>

Mandelbrot Toolbar Example

Panning and zooming will be wired to the graph automatically. Opening the configuration form has to be done manually depending on how you integrate the form. For example, if you use a modal dialog:

addEventListener('DOMContentLoaded', function () {
  const toolbar = document.getElementById('toolbar')
  const dialog = document.getElementById('settings-dialog')
  const form = document.getElementById('settings')

  toolbar.addEventListener('open-settings', openSettingsDialog)
  form.addEventListener('submitted', closeSettingsDialog)

  function openSettingsDialog () {
    dialog.showModal()
  }

  function closeSettingsDialog () {
    dialog.close()
  }
})

If you want to isolate the styling of the form, set the stylesheet URL to the stylesheet attribute:

<mandelbrot-set-toolbar
  stylesheet="https://cdnjs.cloudflare.com/ajax/libs/mini.css/3.0.1/mini-default.min.css"
  id="toolbar"></mandelbrot-set-toolbar>

The page julia.html demonstrates the usage of the toolbar including opening the configuration form in a modal dialog.

All-In-One

Import the web component with Julia or Mandelbrot set demonstration by including its module at the end of the body element on your HTML page.:

<script
  src="https://unpkg.com/mandelbrot-set@2.2.0/public/scripts/mandelbrot-set.js"
  type="module"></script>

Place the web component where you want to see it and set its attributes. The attributetype can be set only once with the initial HTML markup. The following attribute values are the defaults:

<mandelbrot-set
  palette="grayscale" iteration-threshold="20" scale="1"
  width="400" height="400" offset-x="0" offset-y="0"
  panning="true" zooming="true" settings="true"
  type="mandelbrot"></mandelbrot-set>

Possible types are “mandelbrot” and “julia”. Possible colour palettes are “grayscale”, “jewels”, “fiety”, “rainbow”, “sharp”, “onion”, “poison”, “garden”, and “sky”. This element includes controls for panning, zooming and configuring the graph.

Mandelbrot Set Example

If you want to isolate the styling of the form, set the stylesheet URL to the stylesheet attribute:

<mandelbrot-set
  stylesheet="https://cdnjs.cloudflare.com/ajax/libs/mini.css/3.0.1/mini-default.min.css"
  ></mandelbrot-set-toolbar>

The page demo.html demonstrates the usage of this element.

Development

This project installs support for a local web server, code validation and build output using NPM. Make sure, that you use Node.js version 8 or newer.

npm ci
npm start
open http://localhost:8008/mandelbrot.html

Examples

Grayscale Full Example

Fiery Detail Example

Rainbow Zoom Example

Jewels Dialog Example

<mandelbrot-set
  type="julia" kr="0.4" ki="0.4" palette="jewels" iteration-threshold="135" scale="40"
  width="600" height="300" offset-x="1.798" offset-y="1.439"></mandelbrot-set>

Julia All Example

This site is open source. Improve this page.