rectangles
The rectangles statement adds an input data table, which is transformed
according to a user-provided scale configuration and then plotted as one or more
rectangles to the chart. It is used to plot colored tiles.
Synopsis
rectangles {
data: <dataset>;
data-format: <dataset-format>;
data-x: <dataset-x>;
data-y: <dataset-y>;
size: <>;
sizes: <>;
size-x: <>;
sizes-x: <>;
size-y: <>;
sizes-y: <>;
color: <color>;
colors: <dataset_colors>;
color-map: <color_map>;
scale-x: <scale>;
scale-y: <scale>;
limit-x: <limit>;
limit-x-min: <limit_min>;
limit-x-max: <limit-max>;
limit-y: <limit>;
limit-y-min: <limit_min>;
limit-y-max: <limit-max>;
}List of Options
data
Set the dataset for the current element. The dataset should be a valid CSV (RFC4180) or GeoJSON file.
data: <path>;
Examples:
// load a csv file
data: "myfile.csv";
// load a geojson file
data: "myfile.geojson";
data-format
Explicitly set the dataset format. This is usually not required, since the format should, in most cases, be detected automatically.
data-format: <dataset-format>;
Examples:
// set the format to CSV
data-format: csv;
// set the format to geojson
data-format: geojson;
data-x
This parameter controls how the X position of geometry is retrieved from the dataset. For CSV files, the parameter controls the name of the column that is displayed on the X axis. The default value is `"x"`. You can also use this parameter to declare an "inline" data list.
data-x: <key>;
data-x: list(<value>...);
Examples:
// reference the "mycolumn" column
data-x: mycolumn;
// list of static values
data-x: list(10 20 30);
data-y
This parameter controls how the Y position of geometry is retrieved from the dataset. For CSV files, the parameter controls the name of the column that is displayed on the Y axis. The default value is `"y"`. You can also use this parameter to declare an "inline" data list.
data-y: <key>;
data-y: list(<value>...);
Examples:
// reference the "mycolumn" column
data-y: mycolumn;
// list of static values
data-y: list(10 20 30);
size
Set rectangle size in both dimensions (x and y). Note that this value is only used if no sizes option is specified.
size <measure>
Examples:
;; set the rectangle size to 5pt
size 5pt
sizes
Load the rectangle sizes from data.
sizes (<values>...)
sizes (csv <file> <column>)
Examples:
;; list of static values
sizes (2pt 8pt 5pt)
;; load a csv file
sizes (csv myfile.csv mysizes)
size-x
Set rectangle size in the x dimension. Note that this value is only used if no sizes option is specified.
size <measure>
Examples:
;; set the rectangle width to 5pt
size-x 5pt
sizes-x
Load the rectangle widths from data
sizes-x (<values>...)
sizes-x (csv <file> <column>)
Examples:
;; list of static values
sizes-x (2pt 8pt 5pt)
;; load a csv file
sizes-x (csv myfile.csv mysizes)
size-y
Set rectangle size in the y dimension. Note that this value is only used if no sizes option is specified.
size <measure>
Examples:
;; set the rectangle height to 5pt
size-u 5pt
sizes-y
Load the rectangle heights from data
sizes-y (<values>...)
sizes-y (csv <file> <column>)
Examples:
;; list of static values
sizes-y (2pt 8pt 5pt)
;; load a csv file
sizes-y (csv myfile.csv mysizes)
color
Set the rectangle color. Note that this value is only used if no data-colors option is specified.
color: <color>;
Examples:
;; set the color to grey
color: #eee;
;; set the color to red, 50% transparent
color: rgba(1 0 0 .5);
colors
Set the 'colors' dataset for the plot. The 'colors' dataset will be used to
calculate the color of rectangles. The mapping of input values to colors
is controlled by the color-map option. If no explicit color-map
option is provided, the values colors will be interpreted as
hex color codes.
color-map
Set the color map. Controls how the values in colors will be mapped
to colors.
color-map <color-map>
scale-x
Set the type of the 'x' (horizontal) scale.
scale-x: [linear] [log] [logarithmic] [invert] [inverted];
List of scale types: - `linear` - Standard linear scale - `log`, `logarithmic` - Logarithmic (log10) scale - `invert`, `inverted` - Flip the scale
Examples:
;; set the scale to logarithmic mode
scale-x: log;
;; set the scale to inverted mode
scale-x: invert;
scale-y
Set the type of the 'y' (vertical) scale.
scale-y: [linear] [log] [logarithmic] [invert] [inverted];
List of scale types: - `linear` - Standard linear scale - `log`, `logarithmic` - Logarithmic (log10) scale - `invert`, `inverted` - Flip the scale
Examples:
;; set the scale to logarithmic mode
scale-y: log;
;; set the scale to inverted mode
scale-y: invert;
limit-x
Set the limits (minimum and maximum values) for the 'x' (horizontal) scale.
limit-x: <min> <max;
Examples:
;; set limits to [1..10]
limit-x: 1 10;
limit-x-min
Set the minimum value (lower limit) for the 'x' (horizontal) scale.
limit-x-min: <min>;
Examples:
;; set the lower limit to 2
limit-x-min: 2;
limit-x-max
Set the maximum value (upper limit) for the 'x' (horizontal) scale.
limit-x-max: <value>;
Examples:
;; set the upper limit to 20
limit-x-max: 20;
limit-y
Set the limits (minimum and maximum values) for the 'y' (vertical) scale.
limit-y: <min> <max;
Examples:
;; set limits to [1..10]
limit-y: 1 10;
limit-y-min
Set the minimum value (lower limit) for the 'y' (vertical) scale.
limit-y-min: <min>;
Examples:
;; set the lower limit to 2
limit-y-min: 2;
limit-y-max
Set the maximum value (upper limit) for the 'y' (vertical) scale.
limit-y-max: <value>;
Examples:
;; set the upper limit to 20
limit-y-max: 20;