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

allow labels functions to return Promise (resolving with label text) #85

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

allow labels functions to return Promise (resolving with label text) #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a9d58ab
allow legend.labels to return Promise
christophe-g Jul 22, 2018
bf7ba11
added docs; improved example;
christophe-g Jul 22, 2018
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
530 changes: 335 additions & 195 deletions d3-legend.js
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions d3-legend.min.js
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/color.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ This function is called for each generated label and gives you the options:
- generatedLabels: array of generated labels
- domain: array from input scale
- range: array from input scale
The function returns either the label **or** a Promise resolving into label text.
This allows you to make any custom functions to handle labels. An example: [Color - Threshold Scale, Custom Labels](#color-threshold)

List of [helper functions](#helpers).
Expand Down
6 changes: 3 additions & 3 deletions docs/d3-legend.min.js
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/docs.min.js
View file
Open in desktop

Large diffs are not rendered by default.

187 changes: 125 additions & 62 deletions docs/example.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<!DOCTYPE html>
<meta charset="utf-8">
<style>

body {
margin: 0;
overflow: hidden;
Expand All @@ -24,69 +23,133 @@
shape-rendering: crispEdges;
}

.q0-9 {
fill: rgb(247, 251, 255);
}

.q1-9 {
fill: rgb(222, 235, 247);
}

.q2-9 {
fill: rgb(198, 219, 239);
}

.q3-9 {
fill: rgb(158, 202, 225);
}

.q4-9 {
fill: rgb(107, 174, 214);
}

.q5-9 {
fill: rgb(66, 146, 198);
}

.q6-9 {
fill: rgb(33, 113, 181);
}

.q7-9 {
fill: rgb(8, 81, 156);
}

.q8-9 {
fill: rgb(8, 48, 107);
}

</style>

<body>
<script src="https://cdnjs.cloudflare.com/ajax/libs/d3/3.5.5/d3.min.js"></script>
<script src="../d3-legend.min.js"></script>
<svg id="legend">
<g transform="translate(20,20)" class="legend"></g>
</svg>
<svg id="promiseLegend">
<g transform="translate(20,20)" class="legend"></g>
</svg>
</body>
<!-- <script src="https://cdnjs.cloudflare.com/ajax/libs/d3/3.5.5/d3.min.js"></script> -->
<script src="https://d3js.org/d3.v5.min.js"></script>
<script src="../d3-legend.js"></script>
<script>

var width = 960,
height = 500,
formatPercent = d3.format(".0%"),
formatNumber = d3.format(".0f");

var threshold = d3.scale.threshold()
.domain([.11, .22, .33, .50])
.range(["#6e7c5a", "#a0b28f", "#d8b8b3", "#b45554", "#760000"]);

// A position encoding for the key only.
var x = d3.scale.linear()
.domain([0, 1])
.range([0, 240]);

var xAxis = d3.svg.axis()
.scale(x)
.orient("bottom")
.tickSize(13)
.tickValues(threshold.domain())
.tickFormat(function(d) { return d === .5 ? formatPercent(d) : formatNumber(100 * d); });

var svg = d3.select("body").append("svg")
.attr("width", width)
.attr("height", height);

var g = svg.append("g")
.attr("class", "key")
.attr("transform", "translate(" + (width - 240) / 2 + "," + height / 2 + ")");

var legend = d3.legend.color()
.scale(threshold)
.orient("horizontal")
.shapeWidth(60);

svg.append("g")
.attr("class", "legend")
.attr("transform", "translate(20,20)");

svg.select(".legend")
var thresholdScale = d3.scaleThreshold()
.domain([0, 1000, 2500, 5000, 10000])
.range(d3.range(6)
.map(function(i) { return "q" + i + "-9" }));

var linear = d3.scaleLinear()
.domain([0, 10])
.range(["rgb(46, 73, 123)", "rgb(71, 187, 94)"]);

// ----legendHelpers.thresholdLabels----
const promiseHelper = function({
i,
genLength,
generatedLabels,
labelDelimiter
}) {

//
const promise = Promise.resolve()
.then(function(string) {
return new Promise(function(resolve, reject) {
setTimeout(function() {
let res;
if (i === 0) {
const values = generatedLabels[i].split(` ${labelDelimiter} `);
return resolve(`Less than ${values[1]}`);
} else if (i === genLength - 1) {
const values = generatedLabels[i].split(` ${labelDelimiter} `);
return resolve(`${values[0]} or more`);
}
return resolve(generatedLabels[i]);
}, 100);
});
});

return promise;
};

// ----legendHelpers.thresholdLabels----
const helper = function({
i,
genLength,
generatedLabels,
labelDelimiter
}) {

if (i === 0) {
const values = generatedLabels[i].split(` ${labelDelimiter} `);
return `Less than ${values[1]}`;
} else if (i === genLength - 1) {
const values = generatedLabels[i].split(` ${labelDelimiter} `);
return `${values[0]} or more`;
}
return generatedLabels[i];
};

const legend = d3.legendColor()
.labelFormat(d3.format('.2f'))
.title('Sync labels')
.labels(helper)
.useClass(true)
.scale(thresholdScale);

const promiseLegend = d3.legendColor()
.labelFormat(d3.format('.2f'))
.title('Async labels (Promise)')
.labels(promiseHelper)
.useClass(true)
.scale(thresholdScale);



d3.select('#legend .legend')
.call(legend);

g.selectAll("rect")
.data(threshold.range().map(function(color) {
var d = threshold.invertExtent(color);
if (d[0] == null) d[0] = x.domain()[0];
if (d[1] == null) d[1] = x.domain()[1];
return d;
}))
.enter().append("rect")
.attr("height", 8)
.attr("x", function(d) { return x(d[0]); })
.attr("width", function(d) { return x(d[1]) - x(d[0]); })
.style("fill", function(d) { return threshold(d[0]); });

g.call(xAxis).append("text")
.attr("class", "caption")
.attr("y", -6)
.text("Percentage of stops that involved force");

</script>
d3.select('#promiseLegend .legend')
.call(promiseLegend);


</script>
1 change: 1 addition & 0 deletions docs/size.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ This function is called for each generated label and gives you the options:
- generatedLabels: array of generated labels
- domain: array from input scale
- range: array from input scale
The function returns either the label **or** a Promise resolving into label text.
This allows you to make any custom functions to handle labels. An example: [Color - Threshold Scale, Custom Labels](#color-threshold)

List of [helper functions](#helpers).
Expand Down
1 change: 1 addition & 0 deletions docs/symbol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ This function is called for each generated label and gives you the options:
- generatedLabels: array of generated labels
- domain: array from input scale
- range: array from input scale
The function returns either the label **or** a Promise resolving into label text.
This allows you to make any custom functions to handle labels. An example: [Color - Threshold Scale, Custom Labels](#color-threshold)

List of [helper functions](#helpers).
Expand Down
Loading