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

NAME

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

VERSION

version 0.042

SYNOPSIS

use Chart::Plotly qw(show_plot);
use Chart::Plotly::Trace::Parcoords;
# Example data from: https://plot.ly/javascript/parallel-coordinates-plot/#adding-dimensions
my $parcoords = Chart::Plotly::Trace::Parcoords->new(
 line=> {
    color=> 'blue'
  },
  
  dimensions=> [{
    range=> [1, 5],
    constraintrange=> [1, 2],
    label=> 'A',
    values=> [1,4]
  }, {    
    range=> [1,5],
    label=> 'B',
    values=> [3,1.5],
    tickvals=> [1.5,3,4.5]
  }, {
    range=> [1, 5],
    label=> 'C',
    values=> [2,4],
    tickvals=> [1,2,4,5],
    ticktext=> ['text 1','text 2','text 4','text 5']
  }, {
    range=> [1, 5],
    label=> 'D',
    values=> [4,2]
  }]
);

show_plot([ $parcoords ]);

DESCRIPTION

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

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

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

  • constraintrange

    The domain range to which the filter on the dimension is constrained. Must be an array of `[fromValue, toValue]` with `fromValue <= toValue`, or if `multiselect` is not disabled, you may give an array of arrays, where each inner array is `[fromValue, toValue]`.

  • description

  • label

    The shown name of the dimension.

  • multiselect

    Do we allow multiple selection ranges or just a single range?

  • name

    When used in a template, named items are created in the output figure in addition to any items the figure already has in this array. You can modify these items in the output figure by making your own item with `templateitemname` matching this `name` alongside your modifications (including `visible: false` or `enabled: false` to hide it). Has no effect outside of a template.

  • range

    The domain range that represents the full, shown axis extent. Defaults to the `values` extent. Must be an array of `[fromValue, toValue]` with finite numbers as elements.

  • templateitemname

    Used to refer to a named item in this array in the template. Named items from the template will be created even without a matching item in the input figure, but you can modify one by making an item with `templateitemname` matching its `name`, alongside your modifications (including `visible: false` or `enabled: false` to hide it). If there is no template or no matching item, this item will be hidden unless you explicitly show it with `visible: true`.

  • tickformat

    Sets the tick label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for dates see: https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format. We add two items to d3's date formatter: *%h* for half of the year as a decimal number as well as *%{n}f* for fractional seconds with n digits. For example, *2016-10-13 09:15:23.456* with tickformat *%H~%M~%S.%2f* would display *09~15~23.46*

  • ticktext

    Sets the text displayed at the ticks position via `tickvals`.

  • ticktextsrc

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

  • tickvals

    Sets the values at which ticks on this axis appear.

  • tickvalssrc

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

  • values

    Dimension values. `values[n]` represents the 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). Each value must be a finite number.

  • 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