/ 
Chart-Plotly-0.042
River stage one • 2 direct dependents • 2 total dependents
/ Chart::Plotly::Trace::Parcats::Dimension

NAME

Chart::Plotly::Trace::Parcats::Dimension - This attribute is one of the possible options for the trace parcats.

VERSION

version 0.042

SYNOPSIS

use Chart::Plotly;
use Chart::Plotly::Trace::Parcats;
use Chart::Plotly::Plot;

# Example from https://github.com/plotly/plotly.js/blob/7b751009fc9804272316f0bb539ed0386c0858bd/test/image/mocks/parcats_bundled.json

my $trace = Chart::Plotly::Trace::Parcats->new( bundlecolors => 1,
                                                dimensions   => [
                                                           { label  => 'One',
                                                             values => [ (1) x 2, 2, 1, 2, (1) x 2, 2, 1 ]
                                                           },
                                                           { label  => 'Two',
                                                             values => [ 'A', 'B', 'A', 'B', ('C') x 2, 'A', 'B', 'C' ]
                                                           },
                                                           { label  => 'Three',
                                                             values => [ (11) x 9 ]
                                                           }
                                                ],
                                                domain => { x => [ 0.125, 0.625 ],
                                                            y => [ 0.25,  0.75 ]
                                                },
                                                line => { color => [ (0) x 2, (1) x 2, 0, 1, (0) x 3 ] }
);

my $plot = Chart::Plotly::Plot->new( traces => [$trace],
                                     layout => { height => 602,
                                                 margin => { b => 40,
                                                             l => 40,
                                                             r => 40,
                                                             t => 50
                                                 },
                                                 width => 592
                                     }
);

Chart::Plotly::show_plot($plot);

DESCRIPTION

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

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

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

  • categoryarray

    Sets the order in which categories in this dimension appear. Only has an effect if `categoryorder` is set to *array*. Used with `categoryorder`.

  • categoryarraysrc

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

  • categoryorder

    Specifies the ordering logic for the categories in the dimension. By default, plotly uses *trace*, which specifies the order that is present in the data supplied. Set `categoryorder` to *category ascending* or *category descending* if order should be determined by the alphanumerical order of the category names. Set `categoryorder` to *array* to derive the ordering from the attribute `categoryarray`. If a category is not found in the `categoryarray` array, the sorting behavior for that attribute will be identical to the *trace* mode. The unspecified categories will follow the categories in `categoryarray`.

  • description

  • displayindex

    The display index of dimension, from left to right, zero indexed, defaults to dimension index.

  • label

    The shown name of the dimension.

  • ticktext

    Sets alternative tick labels for the categories in this dimension. Only has an effect if `categoryorder` is set to *array*. Should be an array the same length as `categoryarray` Used with `categoryorder`.

  • ticktextsrc

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

  • values

    Dimension values. `values[n]` represents the category value of the `n`th point in the dataset, therefore the `values` vector for all dimensions must be the same (longer vectors will be truncated).

  • valuessrc

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

  • visible

    Shows the dimension when set to `true` (the default). Hides the dimension for `false`.

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