/ 
Chart-Plotly-0.004
River stage one • 2 direct dependents • 2 total dependents
/ Chart::Plotly::Trace::Histogram2d

NAME

Chart::Plotly::Trace::Histogram2d

SYNOPSIS

use HTML::Show;
use Chart::Plotly;
use Chart::Plotly::Trace::Histogram2d;
my $histogram2d = Chart::Plotly::Trace::Histogram2d->new(x => [1 .. 5], y => [1 .. 5]);

HTML::Show::show(Chart::Plotly::render_full_html(data => [$histogram2d]));

DESCRIPTION

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/#histogram2d

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

  • reversescale

    Reverses the colorscale.

  • marker

  • _nestedModules

  • nbinsy

    Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data.

  • ybins

  • autobiny

    Determines whether or not the y axis bin attributes are picked by an algorithm. Note that this should be set to false if you want to manually set the number of bins using the attributes in ybins.

  • histnorm

    Specifies the type of normalization used for this histogram trace. If **, the span of each bar corresponds to the number of occurrences (i.e. the number of data points lying inside the bins). If *percent*, the span of each bar corresponds to the percentage of occurrences with respect to the total number of sample points (here, the sum of all bin area equals 100%). If *density*, the span of each bar corresponds to the number of occurrences in a bin divided by the size of the bin interval (here, the sum of all bin area equals the total number of sample points). If *probability density*, the span of each bar corresponds to the probability that an event will fall into the corresponding bin (here, the sum of all bin area equals 1).

  • autocolorscale

    Determines whether or not the colorscale is picked using the sign of the input z values.

  • autobinx

    Determines whether or not the x axis bin attributes are picked by an algorithm. Note that this should be set to false if you want to manually set the number of bins using the attributes in xbins.

  • z

    Sets the aggregation data.

  • xbins

  • ygap

    Sets the vertical gap (in pixels) between bricks.

  • xgap

    Sets the horizontal gap (in pixels) between bricks.

  • x

    Sets the sample data to be binned on the x axis.

  • 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 z space, use zmin and zmax

  • zmin

    Sets the lower bound of color domain.

  • nbinsx

    Specifies the maximum number of desired bins. This value will be used in an algorithm that will decide the optimal bin size such that the histogram best visualizes the distribution of the data.

  • histfunc

    Specifies the binning function used for this histogram trace. If *count*, the histogram values are computed by counting the number of values lying inside each bin. If *sum*, *avg*, *min*, *max*, the histogram values are computed using the sum, the average, the minimum or the maximum of the values lying inside each bin respectively.

  • zsmooth

    Picks a smoothing algorithm use to smooth `z` data.

  • showscale

    Determines whether or not a colorbar is displayed for this trace.

  • zauto

    Determines the whether or not the color domain is computed with respect to the input data.

  • y

    Sets the sample data to be binned on the y axis.

  • zmax

    Sets the upper bound of color domain.