/ 
Quiq-1.180
River stage zero No dependents
/ Quiq::PlotlyJs::TimeSeries

NAME

Quiq::PlotlyJs::TimeSeries - Erzeuge Zeitreihen-Plot auf Basis von Plotly.js

BASE CLASS

Quiq::Hash

DESCRIPTION

Diese Klasse ist ein Perl-Wrapper für die Erzeugung für Zeitreihen-Plots auf Basis von Plotly.js.

EXAMPLE

(Folgendes Diagramm erscheint in HTML - außer auf meta::cpan, da der HTML-Code dort gestrippt wird - es zeigt 720 Messwerte einer Windgeschwindigkeits-Messung)

METHODS

Konstruktor

new() - Instantiiere Objekt

Synopsis

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

Attributes

color => $color (Default: 'rgb(255,0,0,1)')

Farbe der Kurve.

height (Default: 450 Default von plotly.js)

Höhe des Plot in Pixeln.

marginBottom => $n (Default: 10)

Unterer Rand in Pixeln.

marginLeft => $n (Default: 90)

Linker Rand in Pixeln.

marginRight => $n (Default: 90)

Rechter Rand in Pixeln.

marginTop => $n (Default: 60)

Oberer Rand in Pixeln.

name => $name (Default: 'plot')

Name des Plot. Der Name wird als CSS-Id für den Div-Container und als Variablenname für die JavaScript-Instanz verwendet.

shape => 'spline'|'linear'|'hv'|'vh'|'hvh'|'vhv' (Default: 'spline')

Legt die Linienform fest.

title => $str

Titel des Plot. Wird über das Diagramm gesetzt. Typischerweise der Name des gemessenen Parameters.

x => \@x (Default: [])

Referenz auf Array der Zeit-Werte (bevorzugt in JavaScript-Epoch).

xSpikeFormat => $timeFormat ('%Y-%m-%d %H:%M:%S')

Format der Spike-Beschriftung für die X-Koordinate. Siehe: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format.

xTickFormat => $timeFormat ('%Y-%m-%d %H:%M')

Format der Zeitachsen-Beschriftung. Siehe: https://github.com/d3/d3-3.x-api-reference/blob/master/Time-Formatting.md#format.

y => \@y (Default: [])

Referenz auf Array der Y-Werte (Weltkoordinaten).

yMin => $val

Kleinster Wert auf der Y-Achse. Der Default 'undefined' bedeutet, dass der Wert aus den Daten ermittelt wird.

yMax => $val

Größter Wert auf der Y-Achse. Der Default 'undefined' bedeutet, dass der Wert aus den Daten ermittelt wird.

ySide => 'left'|'right' (Default: 'left' Default von plotly.js)
yTitle => $str

Beschriftung an der Y-Achse. Typischerweise die Einheit des gemessenen Parameters.

Returns

Objekt

Description

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

Klassenmethoden

cdnUrl() - Liefere CDN URL

Synopsis

$url = $ch->cdnUrl($version);

Returns

URL (String)

Description

Liefere einen CDN URL für Plotly.js.

Objektmethoden

html() - Generiere HTML

Synopsis

$html = $ch->html($h);

Returns

HTML-Code (String)

Description

Liefere den HTML-Code der Plot-Instanz.

js() - Generiere JavaScript

Synopsis

$js = $ch->js;

Returns

JavaScript-Code (String)

Description

Liefere den JavaScript-Code für die Erzeugung Plot-Instanz.

VERSION

1.180

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.