NAME

Chart::Plotly::Trace::Heatmap

VERSION

version 0.013

SYNOPSIS

use Chart::Plotly qw(show_plot);
use Chart::Plotly::Trace::Heatmap;
use English qw(-no_match_vars);

my $heatmap = Chart::Plotly::Trace::Heatmap->new(
    x => [ 0 .. 10 ],
    y => [ 0 .. 10 ],
    z => [
        map {
            my $y = $ARG;
            [ map { $ARG * $ARG + $y * $y } ( 0 .. 10 ) ]
        } ( 0 .. 10 )
    ]
);

show_plot( [$heatmap] );

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

NAME

Chart::Plotly::Trace::Heatmap

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

  • autocolorscale

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

  • 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

  • connectgaps

    Determines whether or not gaps (i.e. {nan} or missing values) in the `z` data are filled in.

  • dx

    Sets the x coordinate step. See `x0` for more info.

  • dy

    Sets the y coordinate step. See `y0` for more info.

  • reversescale

    Reverses the colorscale.

  • showscale

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

  • text

    Sets the text elements associated with each z value.

  • transpose

    Transposes the z data.

  • x

    Sets the x coordinates.

  • x0

    Alternate to `x`. Builds a linear space of x coordinates. Use with `dx` where `x0` is the starting coordinate and `dx` the step.

  • xgap

    Sets the horizontal gap (in pixels) between bricks.

  • xtype

    If *array*, the heatmap's x coordinates are given by *x* (the default behavior when `x` is provided). If *scaled*, the heatmap's x coordinates are given by *x0* and *dx* (the default behavior when `x` is not provided).

  • y

    Sets the y coordinates.

  • y0

    Alternate to `y`. Builds a linear space of y coordinates. Use with `dy` where `y0` is the starting coordinate and `dy` the step.

  • ygap

    Sets the vertical gap (in pixels) between bricks.

  • ytype

    If *array*, the heatmap's y coordinates are given by *y* (the default behavior when `y` is provided) If *scaled*, the heatmap's y coordinates are given by *y0* and *dy* (the default behavior when `y` is not provided)

  • z

    Sets the z 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.

  • zsmooth

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

  • 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