SigPlot

SigPlot provides fast, interactive plotting for software defined radio applications using HTML5.

Getting Started

First include the SigPlot library in your webpage:

<script src="sigplot-minimized.js" type="text/javascript"></script>

Then create a 'div' element to hold your plot:

<div id="plot"></div>

The size and position of the plot are controlled by regular CSS positioning of the 'div' element. For example:

#plot {
        height: 400px;
        width: 600px;
}

Finally, invoke SigPlot:

plot = new sigplot.Plot(document.getElementById('plot'), {autohide_panbars: true});

Additional examples and demos are available along with API documentation.

Help

Join the discussion on Slack.

Building

Using Grunt

Grunt is the primary mechanism for building SigPlot. You will need an installation of Node.js and the Grunt command line interface.

The first step is to install the build dependencies using npm install.

Run grunt test to run the unittests and JavaScript linting; run grunt dist to build a distributable version of the project.

If you get an warning from jsbeautifer about files not being "beautified", you can use --force while doing development but prior to making your final commits you should run grunt jsbeautifier:cleanup. This will fix any of the formatting issues. It was an intentional decision to not automatically run cleanup because it can be risky to make changes to the code as part of the build (even if the beautifier is supposed to be 100% code-identical).

Using Make

Although Grunt is the canonical build system, a basic Makefile is provided for environment where Grunt cannot be used. You will need the following:

• GNU Make
• Java version 1.7+

If you wish to build the SigPlot API documention, you will need jsdoc installed.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.