Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
addon:referenz:graph:basic_graph [2018/08/14 14:01]
benjamin-ortmann
addon:referenz:graph:basic_graph [2019/09/02 14:55] (aktuell)
benjamin-ortmann
Zeile 1: Zeile 1:
 ====== Graph ====== ====== Graph ======
 +
 Dies ist die Basisklasse,​ von der die Graphen erben. Von ihr sollte nicht direkt geerbt werden, da in ihr nicht alle Parameter zum erstellen eines Graphen gesetzt werden können. Sie erbt die Methoden der addon_base Klasse ([[addon:​referenz:​start#​allgemeine_methoden]]). Dies ist die Basisklasse,​ von der die Graphen erben. Von ihr sollte nicht direkt geerbt werden, da in ihr nicht alle Parameter zum erstellen eines Graphen gesetzt werden können. Sie erbt die Methoden der addon_base Klasse ([[addon:​referenz:​start#​allgemeine_methoden]]).
 +
 +===== Hilfskonstanten =====
 +  *  VALUE: der Wert eines Items
 +  *  LABEL: die Beschriftung eines Items
 +  *  COLOR: die Farbe eines Items
 +
 +===== Definition =====
 +
  
 ===== Aufrufreihenfolge ===== ===== Aufrufreihenfolge =====
 +
 +  *  [[#​get_view|get_view()]]
 +  *  [[#​get_label|get_label()]]
 +  *  [[#​get_container|get_container()]]
 +  *  [[#​get_value|get_value()]]
 +  *  [[#​get_border|get_border()]]
 +  *  [[#​get_color|get_color()]]
 +  *  [[#​get_data|get_data()]]
 +  *  [[#​get_heading|get_heading()]]
 +
 +===== Abstrakte Methoden =====
 +Die Methoden sind hauptsächlich dafür verantwortlich die Parameter für den Graphen zu erhalten. Die Graphen stellen ein Konfigurationsarray bereit, welches es erleichtern soll, viele Parameter auf einmal zu setzen.
 +
 +==== get_view =====
 +
 +
 +**Syntax**:
 +  string get_view()
 +
 +**Beschreibung**:​
 +Diese Methode muss einen String zurückgeben. Dies wird als interne ID für den Graphen verwendet. ​
 +
 +**Beispiel**:​
 +<sxh php>
 +
 +function get_view() : string
 +{
 +   ​return "​chart";​
 +}
 +
 +</​sxh>​
 +
 +----
 +
 +==== get_label =====
 +
 +
 +**Syntax**:
 +  string get_label()
 +
 +**Beschreibung**:​
 +Diese Methode muss einen String zurückgeben. Dies wird als Beschriftung der angezeigten Datensätze vom Graph verwendet. ​
 +
 +**Beispiel**:​
 +<sxh php>
 +
 +function get_label() : string
 +{
 +   ​return "#​user#";​
 +}
 +
 +</​sxh>​
 +
 +----
 +
 +==== get_container =====
 +
 +
 +**Syntax**:
 +  string get_container()
 +
 +**Beschreibung**:​
 +Diese Methode muss einen String zurückgeben. Dies ist die Container-ID,​ in die der Graph platziert werden soll. 
 +
 +**Beispiel**:​
 +<sxh php>
 +
 +function get_container() : string
 +{
 +   ​return "​chart_div";​
 +}
 +
 +</​sxh>​
 +
 +----
 +
 +==== get_value =====
 +
 +
 +**Syntax**:
 +  string get_value()
 +
 +**Beschreibung**:​
 +Diese Methode muss einen String zurückgeben. Dies sind die Werte, die zum zeichnen verwendet werden sollen. ​
 +
 +**Beispiel**:​
 +<sxh php>
 +
 +function get_value() : string
 +{
 +   ​return "#​value#";​
 +}
 +
 +</​sxh>​
 +
 +----
 +
 +==== get_border =====
 +
 +
 +**Syntax**:
 +  bool get_border()
 +
 +**Beschreibung**:​
 +Diese Methode muss einen Bool Wert zurückgeben. Dies signalisiert,​ ob die Graphen Komponenten einen Rand bekommen sollen.
 +
 +**Beispiel**:​
 +<sxh php>
 +
 +function get_border() : bool
 +{
 +   ​return true;
 +}
 +
 +</​sxh>​
 +
 +----
 +
 +==== get_color =====
 +
 +
 +**Syntax**:
 +  string get_color()
 +
 +**Beschreibung**:​
 +Diese Methode muss einen String zurückgeben. Dies setzt die Farbe für alle Komponenten im Graph. Alternativ kann die Farbe auch im Dataset gesetzt werden, so kann erreicht werden, dass die einzelnen Graph Komponenten unterschiedliche Farben erhalten.
 +
 +**Beispiel**:​
 +<sxh php>
 +
 +function get_color() : string
 +{
 +   ​return "​66ccff";​
 +}
 +
 +</​sxh>​
 +
 +----
 +
 +==== get_data =====
 +
 +
 +**Syntax**:
 +  array get_data()
 +
 +**Beschreibung**:​
 +Diese Methode muss ein Array zurückgeben. Dies setzt die zu verwendenden Daten, die für den Graphen verwendet werden.
 +
 +**Beispiel**:​
 +<sxh php>
 +
 +function get_data() : array
 +{
 +   ​return [["​user"​ => '​anna',​ "​value"​ => 14],
 +           ​["​user"​ => '​bert',​ "​value"​ => 18]
 +          ];
 +}
 +
 +</​sxh>​
 +
 +----
 +
 +==== get_heading =====
 +
 +
 +**Syntax**:
 +  String get_heading()
 +
 +**Beschreibung**:​
 +Diese Methode muss einen String zurückgeben. Dies ist die Überschrift,​ die für den Graphen verwendet wird.
 +
 +**Beispiel**:​
 +<sxh php>
 +
 +function get_heading() : String
 +{
 +   ​return "​chart_heading";​
 +}
 +
 +</​sxh>​
 +
 +----