import { scaleSqrt } from "d3-scale";
import { max, descending } from "d3-array";
import { geoPath, geoIdentity } from "d3-geo";
const d3 = Object.assign(
{},
{ scaleSqrt, max, descending, geoPath, geoIdentity }
);
import { create } from "../container/create";
import { render } from "../container/render";
import { height as computeheight } from "../tool/height";
import { centroid } from "../tool/centroid";
import { tooltip } from "../helpers/tooltip";
import { viewof } from "../helpers/viewof";
import {
camelcasetodash,
unique,
getsize,
check,
implantation,
propertiesentries,
detectinput,
order,
} from "../helpers/utils";
/**
* @function spike
* @description The `spike` function allows to create a layer with spikes from a geoJSON. The function adds a layer to the SVG container and returns the layer identifier. If the container is not defined, then the layer is displayed directly.
* @see {@link https://observablehq.com/@neocartocnrs/spike-mark}
*
* @property {object} data - GeoJSON FeatureCollection
* @property {string} [id] - id of the layer
* @property {number[]} [pos = [0,0]] - position of the sîkes to display a single spike
* @property {number|string} [height = 10] - a number or the name of a property containing numerical values
* @property {number} [width = 30] - a number defining the width of the spikes
* @property {number} [straight = 0] - a number between 0 and 1 defining the curve of the spikes. 0 = curved ; 1 = straight
* @property {number} [k = 100] - height of the highest spike (or corresponding to the value defined by `fixmax`)
* @property {number} [fixmax] - value matching the spikes with height `k`. Setting this value is useful for making maps comparable with each other
* @property {string|function} [sort] - the field to sort spikes or a sort function
* @property {boolean} [descending] - spikes sorting order
* @property {string} [coords = "geo"] - use "svg" if the coordinates are already in the plan of the svg document (default: "geo")
* @property {string|function} [fill] - fill color. To create choropleth maps or typologies, use the `tool.choro` and `tool.typo` functions
* @property {string|function} [stroke] - stroke color. To create choropleth maps or typologies, use the `tool.choro` and `tool.typo` functions
* @property {boolean|function} [tip = false] - a function to display the tip. Use true tu display all fields
* @property {boolean} [view = false] - use true and viewof in Observable for this layer to act as Input
* @property {object} [tipstyle] - tooltip style
* @property {*} [*] - *other SVG attributes that can be applied (strokeDasharray, strokeWidth, opacity, strokeLinecap...)*
* @property {*} [svg_*] - *parameters of the svg container created if the layer is not called inside a container (e.g svg_width)*
* @example
* // There are several ways to use this function
* geoviz.spike(svg, { pos: [10,20], height: 15 }) // a single circle
* geoviz.spike(svg, { data: cities, height: "population" }) // where svg is the container
* svg.spike({ data: cities, height: "population" }) // where svg is the container
* svg.plot({ type: "spike", data: cities, height: "population" }) // where svg is the container
* geoviz.spike({ data: cities, height: "population" }) // no container
*/
export function spike(arg1, arg2) {
// Test if new container
let newcontainer =
(arguments.length <= 1 || arguments[1] == undefined) &&
!arguments[0]?._groups
? true
: false;
arg1 = newcontainer && arg1 == undefined ? {} : arg1;
arg2 = arg2 == undefined ? {} : arg2;
// Arguments
const options = {
mark: "spike",
id: unique(),
data: undefined,
pos: [0, 0],
k: 50,
width: 30,
height: 100,
pos: [0, 0],
straight: 0,
sort: undefined,
descending: true,
fixmax: null,
fill: "#F13C47",
stroke: "#F13C47",
fillOpacity: 0.5,
strokeWidth: 0.5,
tip: undefined,
tipstyle: undefined,
};
let opts = { ...options, ...(newcontainer ? arg1 : arg2) };
// New container
let svgopts = { domain: opts.data || opts.datum };
Object.keys(opts)
.filter((str) => str.slice(0, 4) == "svg_")
.forEach((d) => {
Object.assign(svgopts, {
[d.slice(0, 4) == "svg_" ? d.slice(4) : d]: opts[d],
});
delete opts[d];
});
let svg = newcontainer ? create(svgopts) : arg1;
// init layer
let layer = svg.selectAll(`#${opts.id}`).empty()
? svg.append("g").attr("id", opts.id)
: svg.select(`#${opts.id}`);
layer.selectAll("*").remove();
if (!opts.data) {
opts.coords = opts.coords !== undefined ? opts.coords : "svg";
}
if (opts.data) {
svg.data = true;
opts.coords = opts.coords !== undefined ? opts.coords : "geo";
opts.data =
implantation(opts.data) == 3
? centroid(opts.data, {
latlong:
svg.initproj == "none" || opts.coords == "svg" ? false : true,
})
: opts.data;
}
// zoomable layer
if (svg.zoomable && !svg.parent) {
if (!svg.zoomablelayers.map((d) => d.id).includes(opts.id)) {
svg.zoomablelayers.push(opts);
} else {
let i = svg.zoomablelayers.indexOf(
svg.zoomablelayers.find((d) => d.id == opts.id)
);
svg.zoomablelayers[i] = opts;
}
}
// Specific attributes
let entries = Object.entries(opts).map((d) => d[0]);
const notspecificattr = entries.filter(
(d) =>
![
"mark",
"id",
"coords",
"data",
"height",
"width",
"k",
"sort",
"descending",
"fixmax",
"tip",
"tipstyle",
"pos",
].includes(d)
);
// Projection
// Simple spike
if (!opts.data) {
let projection = opts.coords == "svg" ? d3.geoIdentity() : svg.projection;
let path = d3.geoPath(projection);
notspecificattr.forEach((d) => {
layer.attr(camelcasetodash(d), opts[d]);
});
let pos = path.centroid({ type: "Point", coordinates: opts.pos });
layer
.append("path")
.attr(
"d",
`m ${pos[0] - opts.width / 2},${pos[1]} Q ${pos[0]},${
pos[1] - opts.height * opts.straight
},${pos[0]} ${pos[1] - opts.height}
Q ${pos[0]}, ${pos[1] - opts.height * opts.straight} ${
pos[0] + opts.width / 2
},${pos[1]}`
)
.attr("visibility", isNaN(pos[0]) ? "hidden" : "visible");
} else {
let projection =
opts.coords == "svg"
? d3.geoIdentity().scale(svg.zoom.k).translate([svg.zoom.x, svg.zoom.y])
: svg.projection;
let path = d3.geoPath(projection);
// Centroid
opts.data =
implantation(opts.data) == 3
? centroid(opts.data, {
latlong:
svg.initproj == "none" || opts.coords == "svg" ? false : trueg,
})
: opts.data;
// layer attributes
let fields = propertiesentries(opts.data);
const layerattr = notspecificattr.filter(
(d) => detectinput(opts[d], fields) == "value"
);
layerattr.forEach((d) => {
layer.attr(camelcasetodash(d), opts[d]);
});
// features attributes (iterate on)
const eltattr = notspecificattr.filter((d) => !layerattr.includes(d));
eltattr.forEach((d) => {
opts[d] = check(opts[d], fields);
});
// Height
let data = opts.data;
let columns = propertiesentries(data);
const type = detectinput(opts.height, columns);
let drawspike;
switch (type) {
case "value":
drawspike = (d) =>
`m ${path.centroid(d.geometry)[0] - opts.width / 2},${
path.centroid(d.geometry)[1]
} Q ${path.centroid(d.geometry)[0]},${
path.centroid(d.geometry)[1] - opts.height * opts.straight
},${path.centroid(d.geometry)[0]} ${
path.centroid(d.geometry)[1] - opts.height
}
Q ${path.centroid(d.geometry)[0]}, ${
path.centroid(d.geometry)[1] - opts.height * opts.straight
} ${path.centroid(d.geometry)[0] + opts.width / 2},${
path.centroid(d.geometry)[1]
}`;
break;
case "field":
const yscale = computeheight(
data.features.map((d) => d.properties[opts.height]),
{
fixmax: opts.fixmax,
k: opts.k,
}
).h;
drawspike = (d) =>
`m ${path.centroid(d.geometry)[0] - opts.width / 2},${
path.centroid(d.geometry)[1]
} Q ${path.centroid(d.geometry)[0]},${
path.centroid(d.geometry)[1] -
yscale(d.properties[opts.height]) * opts.straight
},${path.centroid(d.geometry)[0]} ${
path.centroid(d.geometry)[1] - yscale(d.properties[opts.height])
}
Q ${path.centroid(d.geometry)[0]}, ${
path.centroid(d.geometry)[1] -
yscale(d.properties[opts.height]) * opts.straight
} ${path.centroid(d.geometry)[0] + opts.width / 2},${
path.centroid(d.geometry)[1]
}`;
break;
}
// Sort & filter
data = data.features
.filter((d) => d.geometry)
.filter((d) => d.geometry.coordinates != undefined);
if (detectinput(opts.height, columns) == "field") {
data = data.filter((d) => d.properties[opts.height] != undefined);
}
data = order(data, opts.sort || opts.height, {
fields: columns,
descending: opts.descending,
});
// Drawing
layer
.selectAll("path")
.data(data)
.join((d) => {
let n = d
.append("path")
.attr("d", drawspike)
.attr("visibility", (d) =>
isNaN(path.centroid(d.geometry)[0]) ? "hidden" : "visible"
);
eltattr.forEach((e) => {
n.attr(camelcasetodash(e), opts[e]);
});
return n;
});
// Tooltip & view
if (opts.tip) {
tooltip(
layer,
opts.data,
svg,
opts.tip,
opts.tipstyle,
fields,
opts.view
);
}
if (!opts.tip && opts.view) {
viewof(layer, svg);
}
}
// Output
if (newcontainer) {
const size = getsize(layer);
svg
.attr("width", size.width)
.attr("height", size.height)
.attr("viewBox", [size.x, size.y, size.width, size.height]);
return render(svg);
} else {
return `#${opts.id}`;
}
}