UNPKG

react-timeseries-charts

Version:
93 lines (79 loc) 8.03 kB
"use strict"; Object.defineProperty(exports, "__esModule", { value: true }); var _createClass = function () { function defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } } return function (Constructor, protoProps, staticProps) { if (protoProps) defineProperties(Constructor.prototype, protoProps); if (staticProps) defineProperties(Constructor, staticProps); return Constructor; }; }(); var _react = require("react"); var _react2 = _interopRequireDefault(_react); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } } function _possibleConstructorReturn(self, call) { if (!self) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return call && (typeof call === "object" || typeof call === "function") ? call : self; } function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; } /** * Copyright (c) 2015-present, The Regents of the University of California, * through Lawrence Berkeley National Laboratory (subject to receipt * of any required approvals from the U.S. Dept. of Energy). * All rights reserved. * * This source code is licensed under the BSD-style license found in the * LICENSE file in the root directory of this source tree. */ /** * * The `<Charts>` element is a grouping for charts within a row. * It takes no props. Each chart within the group will be overlaid * on top of each other. * * Here is an example of two line charts within a `<Charts>` group: * * ```xml * <ChartContainer timeRange={audSeries.timerange()}> * <ChartRow height="200"> * <YAxis/> * <Charts> * <LineChart axis="aud" series={audSeries} style={audStyle}/> * <LineChart axis="euro" series={euroSeries} style={euroStyle}/> * </Charts> * <YAxis/> * </ChartRow> * </ChartContainer> * ``` * * ## Making your own chart * * Anything within this grouping is considered a chart, meaning it will have * certain props injected into it. As a result you can easily implement your own chart * by simply expecting to have these props available and rendering as such. * * For your own chart, the render() method should return a SVG group `<g>` at the * top level, and then your chart rendering within that. * * In addition to any props you add to your chart, the following props are passed into * each chart automatically: * * #### timeScale * * A d3 scale for the time axis which you can use to transform your data in the x direction * * #### yScale * * A d3 scale for the y-axis which you can use to transform your data in the y direction * * #### width * * A the width your chart will render into */ var Charts = function (_React$Component) { _inherits(Charts, _React$Component); function Charts() { _classCallCheck(this, Charts); return _possibleConstructorReturn(this, (Charts.__proto__ || Object.getPrototypeOf(Charts)).apply(this, arguments)); } _createClass(Charts, [{ key: "render", value: function render() { return this.constructor.name + " elements are for configuration only\nand should not be rendered"; } }]); return Charts; }(_react2.default.Component); exports.default = Charts;