Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(sparkline): Fix to work point.focus.only option #3172

Merged
merged 1 commit into from
Apr 10, 2023
Merged

fix(sparkline): Fix to work point.focus.only option #3172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/ChartInternal/shape/point.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
import type {d3Selection} from "../../../types/types";
import {$CIRCLE, $COMMON, $SELECT} from "../../config/classes";
import {document} from "../../module/browser";
import type {IDataRow} from "../data/IData";
import {getBoundingRect, getPointer, getRandom, isFunction, isObject, isObjectType, isUndefined, isValue, toArray, notEmpty} from "../../module/util";

const getTransitionName = () => getRandom();
Expand Down Expand Up @@ -188,7 +189,7 @@ export default {
* @param {object} d Selected data
* @private
*/
showCircleFocus(d?): void {
showCircleFocus(d?: IDataRow[]): void {
const $$ = this;
const {config, state: {hasRadar, resizing, toggling, transiting}, $el} = $$;
let {circle} = $el;
Expand All @@ -202,7 +203,7 @@ export default {
if (d) {
circle = circle
.filter(function(t) {
const data = d.filter(v => v.id === t.id);
const data = d.filter?.(v => v.id === t.id);

return data.length ?
d3Select(this).datum(data[0]) : false;
Expand Down
10 changes: 9 additions & 1 deletion src/Plugin/sparkline/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,11 @@ export default class Sparkline extends Plugin {
}

$$.state.event = e;

if ($$.config.point_focus_only && d) {
$$.showCircleFocus?.([d]);
}

$$.setExpand(index, data.id, true);
$$.showTooltip([d], e.target);
}
Expand All @@ -229,7 +234,10 @@ export default class Sparkline extends Plugin {
const {$$} = this;

$$.state.event = e;
$$.unexpandCircles();

$$.config.point_focus_only ?
$$.hideCircleFocus() : $$.unexpandCircles();

$$.hideTooltip();
}

Expand Down
145 changes: 97 additions & 48 deletions test/plugin/sparkline/sparkline-spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import util from "../../assets/util";
describe("PLUGIN: SPARKLINE", () => {
let chart;
const selector = ".sparkline";
const args = {
let args: any = {
size: {
width: 150,
height: 50
Expand Down Expand Up @@ -54,54 +54,103 @@ describe("PLUGIN: SPARKLINE", () => {
chart = util.generate(args);
});

it("Sparkline generated correctly?", () => {
expect(document.body.querySelectorAll(selector).length).to.be.equal(chart.data().length);
describe("basic functionality", () => {
it("Sparkline generated correctly?", () => {
expect(document.body.querySelectorAll(selector).length).to.be.equal(chart.data().length);
});

it("check for tooltip interaction", () => {
const el = chart.plugins[0].element[0];
const {tooltip} = chart.$;
const svg = el.querySelector("svg");

// hover 1st chart element
util.fireEvent(svg, "mousemove", {
clientX: 10,
clientY: 10
}, chart);

expect(tooltip.style("display")).to.be.equal("block");

expect(tooltip.select("th").text()).to.be.equal("0");
expect(tooltip.select(".name").text()).to.be.equal("data1");
expect(tooltip.select(".value").text()).to.be.equal("30");

const circle = svg.querySelector(`.${$COMMON.EXPANDED}`);

expect(circle).to.be.ok;
expect(circle.classList.contains(`${$CIRCLE.circle}-0`)).to.be.true;

// when
util.fireEvent(svg, "mouseout", {
clientX: 10,
clientY: 10
}, chart);

expect(tooltip.style("display")).to.be.equal("none");
});

it("set options", () => {
args.padding = false;
args.tooltip.show = false;
});

it("check for the dimension & tooltip", () => {
const last = document.querySelectorAll(selector)[2];
const {width, height} = last.querySelector(`.${$AREA.areas} path`)?.getBoundingClientRect() ?? {width:0, height: 0};

// chart element should occupy the whole dimension of given size
expect({width, height}).to.be.deep.equal(args.size);

// tooltip element shouldn't be added to the DOM
expect(chart.$.tooltip).to.be.null;
});
});

it("check for tooltip interaction", () => {
const el = chart.plugins[0].element[0];
const {tooltip} = chart.$;
const svg = el.querySelector("svg");

// hover 1st chart element
util.fireEvent(svg, "mousemove", {
clientX: 10,
clientY: 10
}, chart);

expect(tooltip.style("display")).to.be.equal("block");

expect(tooltip.select("th").text()).to.be.equal("0");
expect(tooltip.select(".name").text()).to.be.equal("data1");
expect(tooltip.select(".value").text()).to.be.equal("30");

const circle = svg.querySelector(`.${$COMMON.EXPANDED}`);

expect(circle).to.be.ok;
expect(circle.classList.contains(`${$CIRCLE.circle}-0`)).to.be.true;

// when
util.fireEvent(svg, "mouseout", {
clientX: 10,
clientY: 10
}, chart);

expect(tooltip.style("display")).to.be.equal("none");
});

it("set options", () => {
args.padding = false;
args.tooltip.show = false;
});

it("check for the dimension & tooltip", () => {
const last = document.querySelectorAll(selector)[2];
const {width, height} = last.querySelector(`.${$AREA.areas} path`)?.getBoundingClientRect() ?? {width:0, height: 0};

// chart element should occupy the whole dimension of given size
expect({width, height}).to.be.deep.equal(args.size);

// tooltip element shouldn't be added to the DOM
expect(chart.$.tooltip).to.be.null;
describe("point option", () => {
before(() => {
args = {
size: {
width: 150,
height: 50
},
data: {
columns: [
["data1", 130, 200, 150, 140, 160, 150],
["data2", 200, 130, 90, 240, 130, 220],
["data3", 300, 200, 160, 400, 250, 250],
],
type: "area",
types: {
data1: "line",
data2: "step"
}
},
point: {
focus: {
only: true
}
},
plugins: [
new Sparkline({
selector
})
]
};
});

it("when point.focus.only=true is set, only one point per dataseries should show.", () => {
const testX = 3;

expect(chart.$.circles.size()).to.be.equal(args.data.columns.length);

// when
chart.tooltip.show({x: testX});

chart.$.circles.each(function(d) {
expect(d.x).to.be.equal(testX);
expect(+this.getAttribute("cx")).to.be.equal(90);
});
});
});
});
5 changes: 1 addition & 4 deletions types/options.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
*/
import {Axis} from "./axis";
import {ChartTypes, d3Selection, DataItem, PrimitiveArray} from "./types";
import Bubblecompare from "./plugin/bubblecompare/index";
import Stanford from "./plugin/stanford/index";
import TextOverlap from "./plugin/textoverlap/index";
import {Chart} from "./chart";
import {IArcData, IData, IDataRow} from "../src/ChartInternal/data/IData";
import {
Expand Down Expand Up @@ -334,7 +331,7 @@ export interface ChartOptions {
/**
* Set plugins
*/
plugins?: Array<(Bubblecompare | Stanford | TextOverlap)>;
plugins?: Array<InstanceType<any>>;

/**
* Control the render timing
Expand Down