Dies ist eine alte Version des Dokuments!


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 (allgemeine_methoden).

  • VALUE: der Wert eines Items
  • LABEL: die Beschriftung eines Items
  • COLOR: die Farbe eines Items
  • GRADIENT_FALLING: Farbverlauf fallend
  • GRADIENT_RISING: Farbverlauf steigend

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:


function get_view() : string
{
   return "chart";
}


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:


function get_label() : string
{
   return "#user#";
}


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:


function get_container() : string
{
   return "chart_div";
}


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:


function get_value() : string
{
   return "#value#";
}


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:


function get_border() : bool
{
   return true;
}


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:


function get_color() : string
{
   return "66ccff";
}


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:


function get_data() : array
{
   return [["user" => 'anna', "value" => 14],
           ["user" => 'bert', "value" => 18]
          ];
}


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:


function get_heading() : String
{
   return "chart_heading";
}