NAME

Chart::Plotly::Trace::Sankey::Hoverlabel - This attribute is one of the possible options for the trace sankey.

VERSION

version 0.025

SYNOPSIS

use Chart::Plotly qw(show_plot);
use Chart::Plotly::Trace::Sankey;
# Example data from: https://plot.ly/javascript/sankey-diagram/#basic-sankey-diagram
my $sankey = Chart::Plotly::Trace::Sankey->new(
    orientation => "h",
    node        => {
        pad       => 15,
        thickness => 30,
        line      => {
            color => "black",
            width => 0.5
        },
        label     => [ "A1", "A2", "B1", "B2", "C1", "C2" ],
        color     => [ "blue", "blue", "blue", "blue", "blue", "blue" ]
    },

    link        => {
        source => [ 0, 1, 0, 2, 3, 3 ],
        target => [ 2, 3, 3, 4, 4, 5 ],
        value  => [ 8, 4, 2, 8, 4, 2 ]
    }
);

show_plot([ $sankey ]);

DESCRIPTION

This attribute is part of the possible options for the trace sankey.

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

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

  • align

    Sets the horizontal alignment of the text content within hover label box. Has an effect only if the hover label text spans more two or more lines

  • alignsrc

    Sets the source reference on plot.ly for align .

  • bgcolor

    Sets the background color of the hover labels for this trace

  • bgcolorsrc

    Sets the source reference on plot.ly for bgcolor .

  • bordercolor

    Sets the border color of the hover labels for this trace.

  • bordercolorsrc

    Sets the source reference on plot.ly for bordercolor .

  • font

  • namelength

    Sets the default length (in number of characters) of the trace name in the hover labels for all traces. -1 shows the whole name regardless of length. 0-3 shows the first 0-3 characters, and an integer >3 will show the whole name if it is less than that many characters, but if it is longer, will truncate to `namelength - 3` characters and add an ellipsis.

  • namelengthsrc

    Sets the source reference on plot.ly for namelength .

AUTHOR

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

COPYRIGHT AND LICENSE

This software is Copyright (c) 2019 by Pablo Rodríguez González.

This is free software, licensed under:

The MIT (X11) License