/ 
Chart-Plotly-0.042
River stage one • 2 direct dependents • 2 total dependents
/ Chart::Plotly::Trace::Candlestick::Hoverlabel

NAME

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

VERSION

version 0.042

SYNOPSIS

use Chart::Plotly;
use Chart::Plotly::Trace::Candlestick;
my $candlestick = Chart::Plotly::Trace::Candlestick->new(
    x     => [ 1 .. 5 ],
    open  => [ 1, 6, 7 ],
    close => [ 7, 12, 5 ],
    high  => [ 8, 15, 10 ],
    low   => [ 0.5, 5, 4 ]
);

Chart::Plotly::show_plot([$candlestick]);

DESCRIPTION

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

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

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 Chart Studio Cloud for `align`.

  • bgcolor

    Sets the background color of the hover labels for this trace

  • bgcolorsrc

    Sets the source reference on Chart Studio Cloud for `bgcolor`.

  • bordercolor

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

  • bordercolorsrc

    Sets the source reference on Chart Studio Cloud 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 Chart Studio Cloud for `namelength`.

  • split

    Show hover information (open, close, high, low) in separate labels.

AUTHOR

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

COPYRIGHT AND LICENSE

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

This is free software, licensed under:

The MIT (X11) License