NAME

Quiq::PlotlyJs::XY::Diagram - Metadaten eines XY-Diagramms

BASE CLASS

Quiq::Hash

DESCRIPTION

Ein Objekt der Klasse speichert Metadaten zu einem XY-Diagramm, das von der Klasse Quiq::PlotlyJs::XY::DiagramGroup geplottet wird.

Die zu plottenden Daten können entweder mittels der Komponenten x, y (und ggf. z) übergeben werden oder sie werden per Ajax-Aufruf geholt, wenn das Attribut url gesetzt ist.

Es ist sinnvoll, die Wertebereiche xMin, xMax, yMin, yMax explizit vorzugeben. Dies ist nicht zwingend erforderlich, da Plotly.js die Wertebereiche auch selbständig setzt, dann aber nach eigenen Kriterien. Ist kein Y-Wertebereich vorgegeben, wird z.B. bei fill: 'tozeroy' die Y-Achse bis 0 ausgedeht, auch wenn alle Y-Werte > 0 sind.

METHODS

Konstruktor

new() - Instantiiere Objekt

Synopsis

  $par = $class->new(@attVal);

Attributes

Pflichtangaben sind fett wiedergegeben. Die zu plottenden Daten werden entweder per x, y (und ggf. z) übergeben oder via url besorgt.

color => $color (Default: '#ff0000')

Farbe, in der die Kurve und Titel dargestellt werden. Alle Schreibweisen, die in CSS erlaubt sind, sind zulässig, also NAME, #XXXXXX oder rgb(NNN,NNN,NNN,NNN).

html => $html

HTML-Code der zum Div-Container des Diagramms hinzugefügt wird, z.B. um absolut postionierte Divs über den Diagramm-Bereich zu legen.

title => $title

Diagramm-Titel.

x => \@x

Referenz auf Array der X-Werte. Im Falle einer Zeitreihe sollten die Zeiten als Strings angegeben werden, da Plotly.js Epoch- und JavaScript Date-Objekte (auch mit Zeitzone) als UTC-Zeiten ansieht und diese in die Zeitzone des Browsers umgerechnet werden.

xMin => $val

Kleinster Wert der X-Achse.

xMax => $val

Größter Wert der X-Achse.

y => \@y

Referenz auf Array der Y-Werte (Weltkoordinaten).

yMin => $val

Kleinster Wert der Y-Achse.

yMax => $val

Größter Wert der Y-Achse.

yTitle => $str

Titel der Y-Achse, typischerweise die Einheit des Parameters.

url => $url

URL des Ajax-Requests, mit welchem die zu plottenden Daten (x, y, ggf. z) abgerufen werden.

z => \@z

Referenz auf Array von Z-Werten. Dies ist eine Liste von Markerfarben.

zName => $name

Name für die Liste der Markerfarben. Wird der Liste der Markerfarben ein Name gegeben, erscheint eine zusätzliche Option in der Shape-Auswahlliste.

Returns

Objekt

Description

Instantiiere ein Objekt der Klasse und liefere eine Referenz auf dieses Objekt zurück.

VERSION

1.188

AUTHOR

Frank Seitz, http://fseitz.de/

COPYRIGHT

Copyright (C) 2020 Frank Seitz

LICENSE

This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself.