/ 
Chart-Plotly-0.013
River stage one • 2 direct dependents • 2 total dependents
/ Chart::Plotly::Trace::Histogram2dcontour

NAME

Chart::Plotly::Trace::Histogram2dcontour

VERSION

version 0.013

SYNOPSIS

use HTML::Show;
use Chart::Plotly;
use Chart::Plotly::Trace::Histogram2dcontour;
my $histogram2dcontour =
  Chart::Plotly::Trace::Histogram2dcontour->new( x => [ map { int( 10 * rand() ) } ( 1 .. 500 ) ],
                                                 y => [ map { int( 10 * rand() ) } ( 1 .. 500 ) ] );

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

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

NAME

Chart::Plotly::Trace::Histogram2dcontour

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.

ATTRIBUTES

  • 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.

  • 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.

  • autocolorscale

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

  • autocontour

    Determines whether or not the contour level attributes are picked by an algorithm. If *true*, the number of contour levels can be set in `ncontours`. If *false*, set the contour level attributes in `contours`.

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

  • contours

  • 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.

  • 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).

  • line

  • marker

  • 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.

  • 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.

  • ncontours

    Sets the maximum number of contour levels. The actual number of contours will be chosen automatically to be less than or equal to the value of `ncontours`. Has an effect only if `autocontour` is *true*.

  • reversescale

    Reverses the colorscale.

  • showscale

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

  • x

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

  • xbins

  • y

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

  • ybins

  • z

    Sets the aggregation data.

  • zauto

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

  • zmax

    Sets the upper bound of color domain.

  • zmin

    Sets the lower bound of color domain.

  • name

    Sets the trace name

type

Trace type.

AUTHOR

Pablo Rodríguez González <pablo.rodriguez.gonzalez@gmail.com>

COPYRIGHT AND LICENSE

Copyright (c) 2017 by Pablo Rodríguez González.

This is free software, licensed under:

The MIT (X11) License