Carbon (carbon-graphs)

Notice

Carbon is currently under a code freeze as the library is being moved to Terra Graphs. During this time, contributions will not be accepted. Once the migration is complete, this repository will be archived.

• Install
• Getting Started
• Dependencies
• Features
  • Graph types
  • Graph Settings/Toggles
  • Other highlights
• Resources
• Browser support
• Potential features
• LICENSE

Install

You can install Carbon via npm or download the latest release from GitHub.

npm i @cerner/carbon-graphs --save-dev

Getting Started

• Getting Started
• API Reference

Dependencies

• D3
• Polyfills:
  • Object.assign
  • Object.values

Features

• Adheres to Cerner standard design template
• Responsive
• Native-built graphs
• Default theme for data points

Graph types

• Line
• Multi Line
• Spline Line
• Paired Result
• Bar
• Timeline
• Pie
• Gantt
• Scatter
• Bubble
  • Bubble Single Dataset
  • Bubble Multiple Dataset

Graph Settings/Toggles

• Legend
• Labels
• Grid vertical & horizontal
• Axes x and y or y2
• Regions horizontal

Other highlights

• Supports different shapes for each data-set
• Supports custom SVG shapes for data-sets
• Non-contiguous data point line graph
• Sparkline graph (with Shapes as hidden)
• Criticality indicators for data point
• Locale support for axes ticks
• Y and Y2 Axes label along with respective shapes
• Graph Panning

Resources

• Demo
• Contributing to Carbon
• Release Notes

Browser support

• Android >= 4.4
• Chrome >= 35
• Firefox >= 31
• Internet Explorer >= 10
• iOS >= 7
• Opera >= 12
• Safari >= 7.1

Potential features

• [ ] Support additional themes
• [ ] a11y
• [ ] Area graph
• [ ] Area spline graph
• [ ] Separate graph types to plugin based
• [ ] DST

LICENSE

Copyright 2017 - 2020 Cerner Innovation, Inc.

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.