Colorbar example for heatmap #1736
Conversation
The final section, color, refered to the "previous example", which did not do anything with colors. So it had an outdated reference, and did not add anything other than this outdated reference. I found it to be only noise, and therefore feel it is better to remove it.
|
Credit also goes to @MaPagh for pointing out this lack of documentation, so that it could be added. |
|
Friendly bump |
There was a problem hiding this comment.
looks good to me :)
@jkrumbiegel can we merge this, or would you document the usage of Colorbar differently?
| zs1 = [sin(x*y) for x in xs, y in ys] | ||
| zs2 = [2sin(x*y) for x in xs, y in ys] | ||
|
|
||
| my_limits = extrema(hcat(zs1, zs2)) # Get maximum and minimum for all z-values |
There was a problem hiding this comment.
I don't like this too much because I can see the hcat breaking on different datasets already, where the matrices don't match. I haven't been able to come up with a really nice and short "cumulative extrema of multiple arrays" expression though that's easy to understand. Maybe it's fine just specifying -2, 2 here manually as we know that from the 2sin expression.
There was a problem hiding this comment.
How about extrema(extrema.((zs1, zs2)))
There was a problem hiding this comment.
That makes a tuple of tuples
There was a problem hiding this comment.
Ah yeah...
@KronosTheLate, should we just use (-2, 2)... I think that's fine here, since we're not trying to show how to get the extrema from the values ;)
There was a problem hiding this comment.
I think that's fair, it's reasonably obvious with the sine (actually it can even look better because if the limits go from -1.99123 to 1.992852 then the colorbar ticks don't have -2 and 2)
There was a problem hiding this comment.
Ok, I'll edited it... @KronosTheLate I think we can merge it now, if you don't have objections
There was a problem hiding this comment.
No objections - extrema of extrema is besides the point of this documentation, so manual limits, though inelegant in some ways, seems like a great solution for this documentation ^_^
| @@ -128,7 +128,7 @@ ys = range(0, 2π, length=100) | |||
| zs1 = [sin(x*y) for x in xs, y in ys] | |||
| zs2 = [2sin(x*y) for x in xs, y in ys] | |||
|
|
|||
| my_limits = extrema(hcat(zs1, zs2)) # Get maximum and minimum for all z-values | |||
| my_limits = (-2, 2) # choose some good limits for sin / 2sin | |||
There was a problem hiding this comment.
maybe not my_limits but joint_limits or something, and say # here we pick the limits manually for simplicity instead of computing them so that it's clear that that would be the normal course of action?
There was a problem hiding this comment.
Good points. I agree with thoose changes.
The optimal thing would perhaps be a helper function that would find the extremas of any heatmap, contour or contour3D (I think those are the ones this would apply to?) in the given figure.
Description
This PR adds documentation to the page on
heatmap, specifically how to make a colorbar.It also removes the previous final section Colors, as it