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:40]
benjamin-ortmann
addon:referenz:graph:basic_graph [2019/09/02 14:55] (aktuell)
benjamin-ortmann
Zeile 2: Zeile 2:
  
 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 ===== ===== Definition =====
  
-==== Konfiguration ==== 
- 
-Zur Erleichterung der Graphen Konfiguration werden mehrere Konstanten und ein Konfigurationsarray bereitgestellt. Das Konfigurationsarray kann zur speicherung der Graphen Parameter verwendet werden. 
- 
-  * addon_graph::​HEADING 
-  * addon_graph::​ID 
-  * addon_graph::​VIEW 
-  * addon_graph::​LABEL 
-  * addon_graph::​CONTAINER 
-  * addon_graph::​VALUE 
-  * addon_graph::​BORDER 
-  * addon_graph::​COLOR 
-  * addon_graph::​DATA 
-  * addon_graph::​HEIGHT 
-  * addon_graph::​WIDTH 
- 
-   ​config = [ 
-        self::​ID ​       => '',​ 
-        self::​VIEW ​     => '',​ 
-        self::​LABEL ​    => '',​ 
-        self::​CONTAINER => '',​ 
-        self::​VALUE ​    => '',​ 
-        self::​BORDER ​   => false, 
-        self::​COLOR ​    => '',​ 
-        self::​DATA ​     => '',​ 
-        self::​TYPE ​     => '',​ 
-        self::​HEADING ​  => '',​ 
-        self::​HEIGHT ​   => 0, 
-        self::​WIDTH ​    => 0 
-    ]; 
  
 ===== Aufrufreihenfolge ===== ===== Aufrufreihenfolge =====
Zeile 41: Zeile 16:
   *  [[#​get_label|get_label()]]   *  [[#​get_label|get_label()]]
   *  [[#​get_container|get_container()]]   *  [[#​get_container|get_container()]]
-  *  [[#​get_type|get_type()]] 
   *  [[#​get_value|get_value()]]   *  [[#​get_value|get_value()]]
   *  [[#​get_border|get_border()]]   *  [[#​get_border|get_border()]]
Zeile 47: Zeile 21:
   *  [[#​get_data|get_data()]]   *  [[#​get_data|get_data()]]
   *  [[#​get_heading|get_heading()]]   *  [[#​get_heading|get_heading()]]
-  *  [[#​get_height|get_height()]] 
-  *  [[#​get_width|get_width()]] 
  
 ===== Abstrakte Methoden ===== ===== Abstrakte Methoden =====
Zeile 67: Zeile 39:
 function get_view() : string function get_view() : string
 { {
-   ​return ​$this->​config[self::​VIEW];+   ​return ​"​chart"​;
 } }
  
Zeile 88: Zeile 60:
 function get_label() : string function get_label() : string
 { {
-   $data = ["​user"​ => "​max",​ "​value", ​ 
- 
    ​return "#​user#";​    ​return "#​user#";​
 } }
Zeile 111: Zeile 81:
 function get_container() : string function get_container() : string
 { {
-   ​return "my_container";+   ​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";
 } }