|
- 'use strict';
-
- Object.defineProperty(exports, "__esModule", {
- value: true
- });
- exports.DIRECTION = exports.ORIENTATION = undefined;
- exports.getTicksTotalFromSize = getTicksTotalFromSize;
- exports.getTickValues = getTickValues;
- exports.generateFit = generateFit;
- exports.generatePoints = generatePoints;
- exports.getAxisAngle = getAxisAngle;
-
- var _d3Array = require('d3-array');
-
- var _d3Scale = require('d3-scale');
-
- // Copyright (c) 2016 - 2017 Uber Technologies, Inc.
- //
- // Permission is hereby granted, free of charge, to any person obtaining a copy
- // of this software and associated documentation files (the "Software"), to deal
- // in the Software without restriction, including without limitation the rights
- // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- // copies of the Software, and to permit persons to whom the Software is
- // furnished to do so, subject to the following conditions:
- //
- // The above copyright notice and this permission notice shall be included in
- // all copies or substantial portions of the Software.
- //
- // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- // THE SOFTWARE.
-
- var ORIENTATION = exports.ORIENTATION = {
- TOP: 'top',
- LEFT: 'left',
- RIGHT: 'right',
- BOTTOM: 'bottom',
- VERTICAL: 'vertical',
- HORIZONTAL: 'horizontal'
- };
-
- var DIRECTION = exports.DIRECTION = {
- VERTICAL: 'vertical',
- HORIZONTAL: 'horizontal'
- };
-
- /**
- * Get total amount of ticks from a given size in pixels.
- * @param {number} size Size of the axis in pixels.
- * @returns {number} Total amount of ticks.
- */
- function getTicksTotalFromSize(size) {
- if (size < 700) {
- if (size > 300) {
- return 10;
- }
- return 5;
- }
- return 20;
- }
-
- /**
- * Get the tick values from a given d3 scale.
- * @param {d3.scale} scale Scale function.
- * @param {number} tickTotal Total number of ticks
- * @param {Array} tickValues Array of tick values if they exist.
- * @returns {Array} Array of tick values.
- */
- function getTickValues(scale, tickTotal, tickValues) {
- return !tickValues ? scale.ticks ? scale.ticks(tickTotal) : scale.domain() : tickValues;
- }
-
- /**
- * Generate a description of a decorative axis in terms of a linear equation
- * y = slope * x + offset in coordinates
- * @param {Object} axisStart Object of format {x, y} describing in coordinates
- * the start position of the decorative axis
- * @param {Object} axisEnd Object of format {x, y} describing in coordinates
- * the start position of the decorative axis
- * @returns {Number} Object describing each the line in coordinates
- */
- function generateFit(axisStart, axisEnd) {
- // address the special case when the slope is infinite
- if (axisStart.x === axisEnd.x) {
- return {
- left: axisStart.y,
- right: axisEnd.y,
- slope: 0,
- offset: axisStart.x
- };
- }
- var slope = (axisStart.y - axisEnd.y) / (axisStart.x - axisEnd.x);
- return {
- left: axisStart.x,
- right: axisEnd.x,
- // generate the linear projection of the axis direction
- slope: slope,
- offset: axisStart.y - slope * axisStart.x
- };
- }
-
- /**
- * Generate a description of a decorative axis in terms of a linear equation
- * y = slope * x + offset in coordinates
- * @param props
- * props.@param {Object} axisStart Object of format {x, y} describing in coordinates
- * the start position of the decorative axis
- * props.@param {Object} axisEnd Object of format {x, y} describing in coordinates
- * the start position of the decorative axis
- * props.@param {Number} numberOfTicks The number of ticks on the axis
- * props.@param {Array.Numbers} axisDomain The values to be interpolated across for the axis
- * @returns {Number} Object describing the slope and the specific coordinates of the points
- */
- function generatePoints(_ref) {
- var axisStart = _ref.axisStart,
- axisEnd = _ref.axisEnd,
- numberOfTicks = _ref.numberOfTicks,
- axisDomain = _ref.axisDomain;
-
- var _generateFit = generateFit(axisStart, axisEnd),
- left = _generateFit.left,
- right = _generateFit.right,
- slope = _generateFit.slope,
- offset = _generateFit.offset;
- // construct a linear band of points, then map them
-
-
- var pointSlope = (right - left) / numberOfTicks;
- var axisScale = (0, _d3Scale.scaleLinear)().domain([left, right]).range(axisDomain);
-
- var slopeVertical = axisStart.x === axisEnd.x;
- return {
- slope: slopeVertical ? Infinity : slope,
- points: (0, _d3Array.range)(left, right + pointSlope, pointSlope).map(function (val) {
- if (slopeVertical) {
- return { y: val, x: slope * val + offset, text: axisScale(val) };
- }
- return { x: val, y: slope * val + offset, text: axisScale(val) };
- }).slice(0, numberOfTicks + 1)
- };
- }
-
- /**
- * Compute the angle (in radians) of a decorative axis
- * @param {Object} axisStart Object of format {x, y} describing in coordinates
- * the start position of the decorative axis
- * @param {Object} axisEnd Object of format {x, y} describing in coordinates
- * the start position of the decorative axis
- * @returns {Number} Angle in radials
- */
- function getAxisAngle(axisStart, axisEnd) {
- if (axisStart.x === axisEnd.x) {
- return axisEnd.y > axisStart.y ? Math.PI / 2 : 3 * Math.PI / 2;
- }
- return Math.atan((axisEnd.y - axisStart.y) / (axisEnd.x - axisStart.x));
- }
-
- exports.default = {
- DIRECTION: DIRECTION,
- ORIENTATION: ORIENTATION,
- getTicksTotalFromSize: getTicksTotalFromSize,
- getTickValues: getTickValues
- };
|