Add true log scale to line chart #1507
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| /* Copyright 2018 The TensorFlow Authors. All Rights Reserved. | ||
|
|
||
| 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. | ||
| ==============================================================================*/ | ||
| namespace vz_line_chart2 { | ||
|
|
||
| export class LinearScale extends Plottable.Scales.Linear implements ITfScale { | ||
| private _ignoreOutlier: boolean = false; | ||
| protected _valueProviderForDomain: ValueProviderForDomain; | ||
|
|
||
| constructor() { | ||
| super(); | ||
| this.padProportion(.2); | ||
| } | ||
|
|
||
| public setValueProviderForDomain(provider: ValueProviderForDomain): this { | ||
| this._valueProviderForDomain = provider; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * TODO(nickfelt): Examine whether we truly require `c`. | ||
| * Adds some padding to a given domain. Specifically, it: | ||
| * - returns about [-0.1a - c, 2.1a + c] when a = b and a >= 0. | ||
| * - returns about [-2.1|a| - c, -0.1|a| + c] when a = b and a < 0. | ||
| * - returns [-0.1b, b + padProportion * (b-a)] if b > 2a and a > 0 | ||
| * - else, pads by `padProportion` | ||
| * Note that `c` is a constant offset which specifically is 1.1. Please refer | ||
|
There was a problem hiding this comment. Can you add a TODO(nickfelt) here to revisit whether this offset is actually intentional/helpful? |
||
| * to [1] for its rationale. | ||
| * @override | ||
| */ | ||
| protected _niceDomain(domain: number[], count?: number): number[] { | ||
| const [a, b] = domain; | ||
| let padding: number; | ||
| const span = b - a; | ||
| if (span === 0) { | ||
| // If b===a, we would create an empty range. We instead select the range | ||
| // [0, 2*a] if a > 0, or [-2*a, 0] if a < 0, plus a little bit of | ||
| // extra padding on the top and bottom of the plot. | ||
| padding = Math.abs(a) * 1.1 + 1.1; | ||
|
There was a problem hiding this comment. Should that extra There was a problem hiding this comment. Not answering your question directly, I took the code directly from Instead of focusing on correctness, I made sure the linear scale remains exactly as is today. I honestly do not exactly understand the original author's intension here. |
||
| } else { | ||
| padding = span * this.padProportion(); | ||
| } | ||
|
|
||
| let lower: number; | ||
| if (a >= 0 && a < span) { | ||
| // [1]: We include the intercept (y = 0) if doing so less than doubles the | ||
| // span of the y-axis. (We actually select a lower bound that's slightly | ||
| // less than 0 so that 0.00 will clearly be written on the lower edge of | ||
| // the chart. The label on the lowest tick is often filtered out.) | ||
| lower = -0.1 * b; | ||
| } else { | ||
| lower = a - padding; | ||
| } | ||
| return super._niceDomain([lower, b + padding], count); | ||
| } | ||
|
|
||
| /** | ||
| * @override to remove default padding logic. | ||
| */ | ||
| protected _getUnboundedExtent(ignoreAttachState): number[] { | ||
| const includedValues = this._getAllIncludedValues(ignoreAttachState); | ||
| let extent = this._defaultExtent(); | ||
| if (includedValues.length !== 0) { | ||
| const combinedExtent = [ | ||
| Plottable.Utils.Math.min<number>(includedValues, extent[0]), | ||
| Plottable.Utils.Math.max<number>(includedValues, extent[1]), | ||
| ]; | ||
| extent = this._niceDomain(combinedExtent); | ||
| } | ||
| return extent; | ||
| } | ||
|
|
||
| /** | ||
| * @override | ||
| */ | ||
| protected _getAllIncludedValues(ignoreAttachState = false): number[] { | ||
| const values = this._valueProviderForDomain ? | ||
| this._valueProviderForDomain() : []; | ||
| return this.extentOfValues(values); | ||
| } | ||
|
|
||
| /** | ||
| * @override to apply the outlier logic. | ||
| */ | ||
| public extentOfValues(values: number[]): number[] { | ||
| const legalValues = values | ||
| .filter(x => Plottable.Utils.Math.isValidNumber(x)); | ||
| let filteredValues = legalValues; | ||
| if (this.ignoreOutlier()) { | ||
| const sortedValues = legalValues.sort((a, b) => a - b); | ||
| const a = d3.quantile(sortedValues, 0.05); | ||
| const b = d3.quantile(sortedValues, 0.95); | ||
| filteredValues = legalValues.filter(x => x >= a && x <= b); | ||
| } | ||
| const extent = d3.extent(filteredValues); | ||
| return extent[0] == null || extent[1] == null ? [] : extent; | ||
| } | ||
|
|
||
| public ignoreOutlier(): boolean; | ||
| public ignoreOutlier(ignore: boolean): this; | ||
| public ignoreOutlier(ignore?: boolean): any { | ||
| if (typeof ignore == 'boolean') { | ||
| this._ignoreOutlier = ignore; | ||
| return this; | ||
| } | ||
| return this._ignoreOutlier; | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } // namespace vz_line_chart2 | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FWIW, it would seem more consistent if padProportion were always used to determine the padding factor, rather than effectively using 0.1 instead for the edge cases outlined below.
That way the logic is more streamlined - you can mostly just adjust the domain, and only apply padding in one consistent way at the end. And it's easier to catch extra edge cases in domain adjustment that the current logic isn't handling, like a === b === 0 and also the expansion in the case where a/2 < b < 0.