New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

gauge-chart

Package Overview
Dependencies
Maintainers
1
Versions
13
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

gauge-chart

**A library for creating nice and flexible gauge charts.**

  • 1.0.0
  • latest
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

Gauge Chart

A library for creating nice and flexible gauge charts.

GitHub Workflow Status code style: prettier

Demo

Installation

The easiest way to get started is to install it via npm. When you import it in you code, then by default it will use CommonJS module.

  npm install gauge-chart@0.5.3
const GaugeChart = require('gauge-chart')

You can also import the library as ES Module:

import * as GaugeChart from 'https://unpkg.com/gauge-chart@next/dist/bundle.mjs'

Usage

Create an element for positioning gauge in your html file:

<div id="gaugeArea"></div>

Now you're ready to draw your own gauge.

Just copy this code into your Javascript or Typescript file or into <script> </script> tags in HTML file:

// Element inside which you want to see the chart
let element = document.querySelector('#gaugeArea')

// Properties of the gauge
let gaugeOptions = {
  hasNeedle: true,
  needleColor: 'gray',
  needleUpdateSpeed: 1000,
  arcColors: ['rgb(44, 151, 222)', 'lightgray'],
  arcDelimiters: [30],
  rangeLabel: ['0', '100'],
  centralLabel: '50',
}

// Drawing and updating the chart
GaugeChart.gaugeChart(element, 300, gaugeOptions).updateNeedle(50)
Result:

Gauge Example

By default, the needle is pointing to 0, thus in order to move it you have to use .updateNeedle(val), where val denotes the value on the chart.

Feel free to change or delete any of the gaugeOptions properties as long as their values are in permitted ranges.

Options

gaugeOptions: { ... }
NameValues RangesDescription
hasNeedletrue / falsedetermines whether to show the needle or not
needleColorvalue supported by CSScolorizes needle with specified colors
needleUpdateSpeednumber ⩾ 0determines the speed of needle update animation
arcColorsarray of values supported by CSScolorizes gauge with specified color
arcDelimitersarray of numbers from 0 to 100specifies delimiters of the gauge in ascending order
arcOverEffecttrue / falsedetermines if over effect on ars is enabled or not
arcLabelsarray of stringsspecifies labels to be placed at delimiters ends
arcPaddingnumberspecifies padding between arcs (in pixels)
arcPaddingColorvalue supported by CSScolor of the padding between delimeters
rangeLabelarray of two stringsdepicts gauge ranges on both sides of the chart
centralLabelstringdepicts gauge inner label
labelsFontstringspecifies font-family to be used for labels
.gaugeChart( ... )
NameValues RangesDescription
elementhtml elementspecifies an element which contains a chart
chartWidthnumber larger than 0gives a width to the gauge (height is always 0.5 * chartWidth)
gaugeOptionsobjectprovides gauge properties (can be empty)
.updateNeedle( ... )
NameValues RangesDescription
needleValuenumber from 0 to 100specifies needle value on the gauge

Examples

Some examples of what you can get out of the library using different properties:

Gauge Examples

Contributing

Build the library with npm run build. This will compile the dist files. To see the examples locally you can start a web server with npm run dev.

Authors

Alexey Karpov, Maxim Maltsev.

FAQs

Package last updated on 03 Aug 2022

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc