/*
|
* Licensed to the Apache Software Foundation (ASF) under one
|
* or more contributor license agreements. See the NOTICE file
|
* distributed with this work for additional information
|
* regarding copyright ownership. The ASF licenses this file
|
* to you 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.
|
*/
|
|
import * as numberUtil from '../util/number';
|
|
const roundNumber = numberUtil.round;
|
|
type intervalScaleNiceTicksResult = {
|
interval: number,
|
intervalPrecision: number,
|
niceTickExtent: [number, number]
|
};
|
/**
|
* @param extent Both extent[0] and extent[1] should be valid number.
|
* Should be extent[0] < extent[1].
|
* @param splitNumber splitNumber should be >= 1.
|
*/
|
export function intervalScaleNiceTicks(
|
extent: [number, number],
|
splitNumber: number,
|
minInterval?: number,
|
maxInterval?: number
|
): intervalScaleNiceTicksResult {
|
|
const result = {} as intervalScaleNiceTicksResult;
|
|
const span = extent[1] - extent[0];
|
let interval = result.interval = numberUtil.nice(span / splitNumber, true);
|
if (minInterval != null && interval < minInterval) {
|
interval = result.interval = minInterval;
|
}
|
if (maxInterval != null && interval > maxInterval) {
|
interval = result.interval = maxInterval;
|
}
|
// Tow more digital for tick.
|
const precision = result.intervalPrecision = getIntervalPrecision(interval);
|
// Niced extent inside original extent
|
const niceTickExtent = result.niceTickExtent = [
|
roundNumber(Math.ceil(extent[0] / interval) * interval, precision),
|
roundNumber(Math.floor(extent[1] / interval) * interval, precision)
|
];
|
|
fixExtent(niceTickExtent, extent);
|
|
return result;
|
}
|
|
/**
|
* @return interval precision
|
*/
|
export function getIntervalPrecision(interval: number): number {
|
// Tow more digital for tick.
|
return numberUtil.getPrecisionSafe(interval) + 2;
|
}
|
|
function clamp(
|
niceTickExtent: [number, number], idx: number, extent: [number, number]
|
): void {
|
niceTickExtent[idx] = Math.max(Math.min(niceTickExtent[idx], extent[1]), extent[0]);
|
}
|
|
// In some cases (e.g., splitNumber is 1), niceTickExtent may be out of extent.
|
export function fixExtent(
|
niceTickExtent: [number, number], extent: [number, number]
|
): void {
|
!isFinite(niceTickExtent[0]) && (niceTickExtent[0] = extent[0]);
|
!isFinite(niceTickExtent[1]) && (niceTickExtent[1] = extent[1]);
|
clamp(niceTickExtent, 0, extent);
|
clamp(niceTickExtent, 1, extent);
|
if (niceTickExtent[0] > niceTickExtent[1]) {
|
niceTickExtent[0] = niceTickExtent[1];
|
}
|
}
|
|
export function contain(val: number, extent: [number, number]): boolean {
|
return val >= extent[0] && val <= extent[1];
|
}
|
|
export function normalize(val: number, extent: [number, number]): number {
|
if (extent[1] === extent[0]) {
|
return 0.5;
|
}
|
return (val - extent[0]) / (extent[1] - extent[0]);
|
}
|
|
export function scale(val: number, extent: [number, number]): number {
|
return val * (extent[1] - extent[0]) + extent[0];
|
}
|