NAME

Chart::Plotly::Trace::Scatter3d - The data visualized as scatter point or lines in 3D dimension is set in `x`, `y`, `z`. Text (appearing either on the chart or on hover only) is via `text`. Bubble charts are achieved by setting `marker.size` and/or `marker.color` Projections are achieved via `projection`. Surface fills are achieved via `surfaceaxis`.

VERSION

version 0.032

SYNOPSIS

use Chart::Plotly qw(show_plot);
use Chart::Plotly::Trace::Scatter3d;
use English qw(-no_match_vars);
use Const::Fast;

const my $PI => 4 * atan2( 1, 1 );
const my $DELTA => 0.1;
my ( @x, @y, @z );
for ( my $u = 0; $u <= 2 * $PI; $u += $DELTA ) {
    for ( my $v = -1; $v < 1; $v += $DELTA ) {
        push @x, ( 1 + ( $v / 2 ) * cos( $u / 2 ) ) * cos($u);
        push @y, ( 1 + ( $v / 2 ) * cos( $u / 2 ) ) * sin($u);
        push @z, ( $v / 2 ) * sin( $u / 2 );
    }
}
my $scatter3d = Chart::Plotly::Trace::Scatter3d->new( x => \@x, y => \@y, z => \@z, mode => 'lines' );

show_plot( [$scatter3d] );

DESCRIPTION

The data visualized as scatter point or lines in 3D dimension is set in `x`, `y`, `z`. Text (appearing either on the chart or on hover only) is via `text`. Bubble charts are achieved by setting `marker.size` and/or `marker.color` Projections are achieved via `projection`. Surface fills are achieved via `surfaceaxis`.

Screenshot of the above example:

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

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.

type

Trace type.

ATTRIBUTES

• connectgaps

  Determines whether or not gaps (i.e. {nan} or missing values) in the provided data arrays are connected.

• customdata

  Assigns extra data each datum. This may be useful when listening to hover, click and selection events. Note that, *scatter* traces also appends customdata items in the markers DOM elements

• customdatasrc

  Sets the source reference on plot.ly for customdata .

• error_x

• error_y

• error_z

• hoverinfo

  Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

• hoverinfosrc

  Sets the source reference on plot.ly for hoverinfo .

• hoverlabel

• hovertemplate

  Template string used for rendering the information that appear on hover box. Note that this will override `hoverinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plot.ly/javascript/plotlyjs-events/#event-data. Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>". To hide the secondary box completely, use an empty tag `<extra></extra>`.

• hovertemplatesrc

  Sets the source reference on plot.ly for hovertemplate .

• hovertext

  Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates. To be seen, trace `hoverinfo` must contain a *text* flag.

• hovertextsrc

  Sets the source reference on plot.ly for hovertext .

• ids

  Assigns id labels to each datum. These ids for object constancy of data points during animation. Should be an array of strings, not numbers or any other type.

• idssrc

  Sets the source reference on plot.ly for ids .

• legendgroup

  Sets the legend group for this trace. Traces part of the same legend group hide/show at the same time when toggling legend items.

• line

• marker

• pmeta

  Assigns extra meta information associated with this trace that can be used in various text attributes. Attributes such as trace `name`, graph, axis and colorbar `title.text`, annotation `text` `rangeselector`, `updatemenues` and `sliders` `label` text all support `meta`. To access the trace `meta` values in an attribute in the same trace, simply use `%{meta[i]}` where `i` is the index or key of the `meta` item in question. To access trace `meta` in layout attributes, use `%{data[n[.meta[i]}` where `i` is the index or key of the `meta` and `n` is the trace index.

• metasrc

  Sets the source reference on plot.ly for meta .

• mode

  Determines the drawing mode for this scatter trace. If the provided `mode` includes *text* then the `text` elements appear at the coordinates. Otherwise, the `text` elements appear on hover. If there are less than 20 points and the trace is not stacked then the default is *lines+markers*. Otherwise, *lines*.

• name

  Sets the trace name. The trace name appear as the legend item and on hover.

• opacity

  Sets the opacity of the trace.

• projection

• scene

  Sets a reference between this trace's 3D coordinate system and a 3D scene. If *scene* (the default value), the (x,y,z) coordinates refer to `layout.scene`. If *scene2*, the (x,y,z) coordinates refer to `layout.scene2`, and so on.

• showlegend

  Determines whether or not an item corresponding to this trace is shown in the legend.

• stream

• surfaceaxis

  If *-1*, the scatter points are not fill with a surface If *0*, *1*, *2*, the scatter points are filled with a Delaunay surface about the x, y, z respectively.

• surfacecolor

  Sets the surface fill color.

• text

  Sets text elements associated with each (x,y,z) triplet. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to the this trace's (x,y,z) coordinates. If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.

• textfont

• textposition

  Sets the positions of the `text` elements with respects to the (x,y) coordinates.

• textpositionsrc

  Sets the source reference on plot.ly for textposition .

• textsrc

  Sets the source reference on plot.ly for text .

• texttemplate

  Template string used for rendering the information text that appear on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-3.x-api-reference/blob/master/Formatting.md#d3_format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format for details on the date formatting syntax. Every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available.

• texttemplatesrc

  Sets the source reference on plot.ly for texttemplate .

• transforms

• uid

  Assign an id to this trace, Use this to provide object constancy between traces during animations and transitions.

• uirevision

  Controls persistence of some user-driven changes to the trace: `constraintrange` in `parcoords` traces, as well as some `editable: true` modifications such as `name` and `colorbar.title`. Defaults to `layout.uirevision`. Note that other user-driven trace attribute changes are controlled by `layout` attributes: `trace.visible` is controlled by `layout.legend.uirevision`, `selectedpoints` is controlled by `layout.selectionrevision`, and `colorbar.(x|y)` (accessible with `config: {editable: true}`) is controlled by `layout.editrevision`. Trace changes are tracked by `uid`, which only falls back on trace index if no `uid` is provided. So if your app can add/remove traces before the end of the `data` array, such that the same trace has a different index, you can still preserve user-driven changes if you give each trace a `uid` that stays with it as it moves.

• visible

  Determines whether or not this trace is visible. If *legendonly*, the trace is not drawn, but can appear as a legend item (provided that the legend itself is visible).

• x

  Sets the x coordinates.

• xcalendar

  Sets the calendar system to use with `x` date data.

• xsrc

  Sets the source reference on plot.ly for x .

• y

  Sets the y coordinates.

• ycalendar

  Sets the calendar system to use with `y` date data.

• ysrc

  Sets the source reference on plot.ly for y .

• z

  Sets the z coordinates.

• zcalendar

  Sets the calendar system to use with `z` date data.

• zsrc

  Sets the source reference on plot.ly for z .

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