You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+5-4
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ HeatMap.builder()
31
31
```
32
32
The output will be a PNG file at the output path of `myOutPutFile`.
33
33
34
-
The builder pattern makes it easy to customize your heat map. For example, the following will render a heatmap with no titles, no labels, no legend no border, just the core heat map with blending enabled:
34
+
The builder pattern makes it easy to customize your heat map. For example, the following will render a heat map with no titles, no labels, no legend no border, just the core heat map with blending enabled:
35
35
36
36
```java
37
37
HeatMap.builder()
@@ -63,7 +63,7 @@ public interface DataRecord {
63
63
}
64
64
```
65
65
66
-
Two options are provided for defining the chart axes: `IntegerAxis` which is useful integer values (such as 1-31for days of the month) and `StringAxis` which is useful for string values (such as Monday-Sundayfor days of the week).In both cases, the axis entries are always treated as discrete values and rendered in the same order that each entry is added to the axis. For the `IntegerAxis`, a convenience method is provided to automatically populate the values between a given minimum and maxmimum. For example:
66
+
Two options are provided for defining the chart axes: `IntegerAxis` which is useful integer values (such as 1-31for days of the month) and `StringAxis` which is useful for string values (such as Monday-Sundayfor days of the week).In both cases, the axis entries are always treated as discrete values and rendered in the same order that each entry is added to the axis. For the `IntegerAxis`, a convenience method is provided to automatically populate the values between a given minimum and maximum. For example:
67
67
68
68
```java
69
69
IntegerAxis xAxis =newIntegerAxis("Days of the Year", 1, 366);
@@ -96,7 +96,7 @@ The heat maps are highly customizable, down to colours, fonts, gradients, titles
96
96
**HeatMapRendering**
97
97
-Custom colour gradients using either pre-defined steps with linear interpolation, or smooth a smooth gradient based on the HSB model colour wheel
98
98
-9 pre-defined gradients to choose from if you don't want to define your own
99
-
- Option to blend the colours of each cell using a custome scale factor for applying the linear colour interpolation
99
+
- Option to blend the colours of each cell using a custom scale factor for applying the linear colour interpolation
100
100
- Custom background colour
101
101
- Option to render of grid lines, including thickness and colour
102
102
- Cell width and height
@@ -129,7 +129,8 @@ The default colour palette, if not specified, is set to number 3. Here are examp
129
129
130
130
## ColourBlending
131
131
132
-
Enabling the `blendColours` option will result in a linear colour interpolation being applied to the cells of the heat map in order to "smooth" out the values. This effect works by first rendering each cell as a single pixel, then applying a bilinear upscaler (with a variable scaling factor), followed by applying an alpha mask to avoid blending with empty cells, and finally applying a nearest-neighbour up or down scaling to the final output resolution. The strength of this effect can be controlled via the `blendColoursScale` option, which supports values between 2 and 20, inclusive. Here is an example of what colour blending looks like, starting with no effect, then a strength of 2, 3, 5,and 10, respectively.
132
+
Enabling the `blendColours` option will result in a linear colour interpolation being applied to the cells of the heat map in order to "smooth out" the values. This effect works by first rendering each cell as a single pixel, then applying a bilinear upscaler (with a variable scaling factor), followed by applying an alpha mask to avoid blending with empty cells, and finally applying a nearest-neighbour up or down scaling to the final output resolution. The strength of this effect can be controlled via the `blendColoursScale` option, which supports values between 2 and 20, inclusive. Here is an example of what colour blending looks like, starting with no effect, then a strength of 2, 3, 5,and 10, respectively.
0 commit comments