NAME
Chart::Plotly::Trace::Choropleth - The data that describes the choropleth value-to-color mapping is set in `z`. The geographic locations corresponding to each value in `z` are set in `locations`.
VERSION
version 0.037
SYNOPSIS
use HTML::Show;
use Chart::Plotly;
use Chart::Plotly::Plot;
use Chart::Plotly::Trace::Choropleth;
my $countries = [ 'Afghanistan', 'Albania',
'Algeria', 'Andorra',
'Angola', 'Antigua and Barbuda',
'Argentina', 'Armenia',
'Australia', 'Austria',
'Azerbaijan', 'Bahamas',
'Bahrain', 'Bangladesh',
'Barbados', 'Belarus',
'Belgium', 'Belize',
'Benin', 'Bhutan',
'Bolivia', 'Bosnia and Herzegovina',
'Botswana', 'Brazil',
'Brunei', 'Bulgaria',
'Burkina Faso', 'Burundi',
'Cambodia', 'Cameroon',
'Canada', 'Cape Verde',
'Central African Republic', 'Chad',
'Chile', 'China',
'Colombia', 'Comoros',
'Congo, Democratic Republic of the', 'Congo, Republic of the',
'Costa Rica', 'Croatia',
'Cuba', 'Cyprus',
'Czech Republic', 'Denmark',
'Djibouti', 'Dominica',
'Dominican Republic', 'East Timor',
'Ecuador', 'Egypt',
'El Salvador', 'Equatorial Guinea',
'Eritrea', 'Estonia',
'Ethiopia', 'Fiji',
'Finland', 'France',
'Gabon', 'Gambia, The',
'Georgia', 'Germany',
'Ghana', 'Greece',
'Grenada', 'Guatemala',
'Guinea', 'Guinea-Bissau',
'Guyana', 'Haiti',
'Honduras', 'Hungary',
'Iceland', 'India',
'Indonesia', 'Iran',
'Iraq', 'Ireland, Republic of',
'Israel', 'Italy',
'Ivory Coast', 'Jamaica',
'Japan', 'Jordan',
'Kazakhstan', 'Kenya',
'Kiribati', 'Korea, North',
'Korea, South', 'Kuwait',
'Kyrgyzstan', 'Laos',
'Latvia', 'Lebanon',
'Lesotho', 'Liberia',
'Libya', 'Liechtenstein',
'Lithuania', 'Luxembourg',
'Macedonia, Republic of', 'Madagascar',
'Malawi', 'Malaysia',
'Maldives', 'Mali',
'Malta', 'Marshall Islands',
'Mauritania', 'Mauritius',
'Mexico', 'Micronesia, Federated States of',
'Moldova', 'Monaco',
'Mongolia', 'Montenegro',
'Morocco', 'Mozambique',
'Myanmar', 'Namibia',
'Nepal', 'Netherlands, Kingdom of the',
'New Zealand', 'Nicaragua',
'Niger', 'Nigeria',
'Norway', 'Oman',
'Pakistan', 'Palau',
'Panama', 'Papua New Guinea',
'Paraguay', 'Peru',
'Philippines', 'Poland',
'Portugal', 'Qatar',
'Romania', 'Russia',
'Rwanda', 'Saint Kitts and Nevis',
'Saint Lucia', 'Saint Vincent and the Grenadines',
'Samoa', 'San Marino',
'Sao Tome and Principe', 'Saudi Arabia',
'Senegal', 'Serbia',
'Seychelles', 'Sierra Leone',
'Singapore', 'Slovakia',
'Slovenia', 'Solomon Islands',
'Somalia', 'South Africa',
'Spain', 'Sri Lanka',
'Sudan', 'Suriname',
'Swaziland', 'Sweden',
'Switzerland', 'Syria',
'Tajikistan', 'Tanzania',
'Thailand', 'Togo',
'Tonga', 'Trinidad and Tobago',
'Tunisia', 'Turkey',
'Turkmenistan', 'Tuvalu',
'Uganda', 'Ukraine',
'United Arab Emirates', 'United Kingdom',
'United States', 'Uruguay',
'Uzbekistan', 'Vanuatu',
'Venezuela', 'Vietnam',
'Yemen', 'Zambia',
'Zimbabwe'
];
my $avg_temperature = [ 12.6, 11.4, 22.5, 7.6, 21.55, 26, 14.8, 7.15, 21.65, 6.35, 11.95, 24.85,
27.15, 25, 26, 6.15, 9.55, 25.3, 27.55, 7.4, 21.55, 9.85, 21.5, 24.95,
26.85, 10.55, 28.25, 19.8, 26.8, 24.6, -5.35, 23.3, 24.9, 26.55, 8.45, 6.95,
24.5, 25.55, 24, 24.55, 24.8, 10.9, 25.2, 18.45, 7.55, 7.5, 28, 22.35,
24.55, 25.25, 21.85, 22.1, 24.45, 24.55, 25.5, 5.1, 22.2, 24.4, 1.7, 10.7,
25.05, 27.5, 5.8, 8.5, 27.2, 15.4, 26.65, 23.45, 25.7, 26.75, 26, 24.9,
23.5, 9.75, 1.75, 23.65, 25.85, 17.25, 21.4, 9.3, 19.2, 13.45, 26.35, 24.95,
11.15, 18.3, 6.4, 24.75, 28.2, 5.7, 11.5, 25.35, 1.55, 22.8, 5.6, 16.4,
11.85, 25.3, 21.8, 5.65, 6.2, 8.65, 9.8, 22.65, 21.9, 25.4, 27.65, 28.25,
19.2, 27.4, 27.65, 22.4, 21, 25.85, 9.45, 13.55, -0.7, 10.55, 17.1, 23.8,
13.05, 19.95, 8.1, 9.25, 10.55, 24.9, 27.15, 26.8, 1.5, 25.6, 20.2, 27.6,
25.4, 25.25, 23.55, 19.6, 25.85, 7.85, 15.15, 27.15, 8.8, -5.1, 17.85, 24.5,
25.5, 26.8, 26.7, 11.85, 23.75, 24.65, 27.85, 10.55, 27.15, 26.05, 26.45, 6.8,
8.9, 25.65, 27.05, 17.75, 13.3, 26.95, 26.9, 25.7, 21.4, 2.1, 5.5, 17.75,
2, 22.35, 26.3, 27.15, 25.25, 25.75, 19.2, 11.1, 15.1, 28, 22.8, 8.3,
27, 8.45, 8.55, 17.55, 12.05, 23.95, 25.35, 24.45, 23.85, 21.4, 21
];
my $choropleth = Chart::Plotly::Trace::Choropleth->new( locationmode => 'country names',
locations => $countries,
z => $avg_temperature,
text => $countries,
autocolorscale => 1
);
my $plot = Chart::Plotly::Plot->new(
traces => [$choropleth],
layout => {
title => 'Average temperature by country
Source: https://en.wikipedia.org/wiki/List_of_countries_by_average_yearly_temperature',
geo => { projection => { type => 'robinson' } }
}
);
Chart::Plotly::show_plot($plot);DESCRIPTION
The data that describes the choropleth value-to-color mapping is set in `z`. The geographic locations corresponding to each value in `z` are set in `locations`.
Screenshot of the above example:
This file has been autogenerated from the official plotly.js source.
If you like Plotly, please support them: https://plot.ly/ Open source announcement: https://plot.ly/javascript/open-source-announcement/
Full reference: https://plot.ly/javascript/reference/#choropleth
DISCLAIMER
This is an unofficial Plotly Perl module. Currently I'm not affiliated in any way with Plotly. But I think plotly.js is a great library and I want to use it with perl.
METHODS
TO_JSON
Serialize the trace to JSON. This method should be called only by JSON serializer.
type
Trace type.
ATTRIBUTES
autocolorscale
Determines whether the colorscale is a default palette (`autocolorscale: true`) or the palette determined by `colorscale`. In case `colorscale` is unspecified or `autocolorscale` is true, the default palette will be chosen according to whether numbers in the `color` array are all positive, all negative or mixed.
coloraxis
Sets a reference to a shared color axis. References to these shared color axes are *coloraxis*, *coloraxis2*, *coloraxis3*, etc. Settings for these shared color axes are set in the layout, under `layout.coloraxis`, `layout.coloraxis2`, etc. Note that multiple color scales can be linked to the same color axis.
colorbar
colorscale
Sets the colorscale. The colorscale must be an array containing arrays mapping a normalized value to an rgb, rgba, hex, hsl, hsv, or named color string. At minimum, a mapping for the lowest (0) and highest (1) values are required. For example, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the bounds of the colorscale in color space, use`zmin` and `zmax`. Alternatively, `colorscale` may be a palette name string of the following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividis.
customdata
Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements
customdatasrc
Sets the source reference on plot.ly for customdata .
featureidkey
Sets the key in GeoJSON features which is used as id to match the items included in the `locations` array. Only has an effect when `geojson` is set. Support nested property, for example *properties.name*.
geo
Sets a reference between this trace's geospatial coordinates and a geographic map. If *geo* (the default value), the geospatial coordinates refer to `layout.geo`. If *geo2*, the geospatial coordinates refer to `layout.geo2`, and so on.
geojson
Sets optional GeoJSON data associated with this trace. If not given, the features on the base map are used. It can be set as a valid GeoJSON object or as a URL string. Note that we only accept GeoJSONs of type *FeatureCollection* or *Feature* with geometries of type *Polygon* or *MultiPolygon*.
hoverinfo
Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.
hoverinfosrc
Sets the source reference on plot.ly for hoverinfo .
hoverlabel
hovertemplate
Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.
hovertemplatesrc
Sets the source reference on plot.ly for hovertemplate .
hovertext
Same as `text`.
hovertextsrc
Sets the source reference on plot.ly for hovertext .
ids
Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.
idssrc
Sets the source reference on plot.ly for ids .
legendgroup
Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.
locationmode
Determines the set of locations used to match entries in `locations` to regions on the map. Values *ISO-3*, *USA-states*, *country names* correspond to features on the base map and value *geojson-id* corresponds to features from a custom GeoJSON linked to the `geojson` attribute.
locations
Sets the coordinates via location IDs or names. See `locationmode` for more info.
locationssrc
Sets the source reference on plot.ly for locations .
marker
pmeta
Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.
metasrc
Sets the source reference on plot.ly for meta .
name
Sets the trace name. The trace name appear as the legend item and on hover.
reversescale
Reverses the color mapping if true. If true, `zmin` will correspond to the last color in the array and `zmax` will correspond to the first color.
selected
selectedpoints
Array containing integer indices of selected points. Has an effect only for traces that support selections. Note that an empty array means an empty selection where the `unselected` are turned on for all points, whereas, any other non-array values means no selection all where the `selected` and `unselected` styles have no effect.
showlegend
Determines whether or not an item corresponding to this trace is shown in the legend.
showscale
Determines whether or not a colorbar is displayed for this trace.
stream
text
Sets the text elements associated with each location.
textsrc
Sets the source reference on plot.ly for text .
transforms
uid
Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.
uirevision
Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.
unselected
visible
Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).
z
Sets the color values.
zauto
Determines whether or not the color domain is computed with respect to the input data (here in `z`) or the bounds set in `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` are set by the user.
zmax
Sets the upper bound of the color domain. Value should have the same units as in `z` and if set, `zmin` must be set as well.
zmid
Sets the mid-point of the color domain by scaling `zmin` and/or `zmax` to be equidistant to this point. Value should have the same units as in `z`. Has no effect when `zauto` is `false`.
zmin
Sets the lower bound of the color domain. Value should have the same units as in `z` and if set, `zmax` must be set as well.
zsrc
Sets the source reference on plot.ly for z .
AUTHOR
Pablo Rodríguez González <pablo.rodriguez.gonzalez@gmail.com>
COPYRIGHT AND LICENSE
This software is Copyright (c) 2020 by Pablo Rodríguez González.
This is free software, licensed under:
The MIT (X11) License