/ 
Chart-Plotly-0.020
River stage one • 2 direct dependents • 2 total dependents
/ Chart::Plotly::Trace::Sankey::Link

NAME

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

VERSION

version 0.020

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

  • color

    Sets the `link` color. It can be a single value, or an array for specifying color for each `link`. If `link.color` is omitted, then by default, a translucent grey link will be used.

  • colorsrc

    Sets the source reference on plot.ly for color .

  • description

  • label

    The shown name of the link.

  • labelsrc

    Sets the source reference on plot.ly for label .

  • line

  • source

    An integer number `[0..nodes.length - 1]` that represents the source node.

  • sourcesrc

    Sets the source reference on plot.ly for source .

  • target

    An integer number `[0..nodes.length - 1]` that represents the target node.

  • targetsrc

    Sets the source reference on plot.ly for target .

  • value

    A numeric value representing the flow volume value.

  • valuesrc

    Sets the source reference on plot.ly for value .

AUTHOR

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

COPYRIGHT AND LICENSE

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

This is free software, licensed under:

The MIT (X11) License