Skip to content

sketch_tool_dev_usage.md

Latest commit

 

History

History
41 lines (31 loc) · 1.61 KB

sketch_tool_dev_usage.md

File metadata and controls

41 lines (31 loc) · 1.61 KB

How to use the SketchResponse sketch tool codebase

  • Change to the sketch_tool directory:

    $ cd sketch_tool

To start the development server:

$ npm run start --debug=allPlugins

This will automatically open your default browser and load the tool with options listed in the allPlugins object located in debugConfigs.js.

Options are:

  • width, height: dimensions of the tool.
  • xrange, yrange: dimension of the drawing canvas.
  • xscale, yscale: linear or logarithmic scales. Only linear is supported for the moment.
  • coordinates: cartesian or polar.
  • plugins: modules that extend drawing functionality either automatically (for example axes and image) or are placed in the top toolbar (freeform, horizontal and vertical lines) and let the user draw the corresponding shape on the canvas.

You can also load these additional configurations which show various features of the tool:

  • allPluginsLatex
  • initialState
  • axesParams
  • tagPosition
  • newPlugins
  • invalidConfig
  • pluginGroup
## To build the *dist* directory: 
$ npm run build

You can change the target browsers of the build by modifying the BrowserList entry in package.json. Currently the target is set to the last 2 versions of every major browser excluding IE.

The dist directory is located in /static/sketch_tool_dist/.