FlashChart Dokumentation

Das FlashChart plugin wurde entwickelt, um es zu ermöglichen, einfach Diagramme in Joomla! Inhalte (Artikel) einfügen zu können. Es basiert auf dem API von "Open Flash Chart".

Man benutzt flashChart, um verschiedenste Typen von Diagrammen zu generieren, u. a. Linien-, Streu-, Säulen und Torten-Diagramme im 2D oder 3D Erscheinungsbild. Für jeden Type kann man eine Vielzahl von Attributen angeben, wie z. B. Größe, Farben, Bezeichner, und vieles mehr. Die Daten für die Diagramme können entweder über manuelle Eingaben, von einer Datenbank, einer Datei oder von einem entfernten WebServer geliefert werden. Mit diesem Plugin ist es sehr einfach, Inhalte mit dynamisch erzeugten Diagrammen zu versehen und attraktiv zu gestalten. Für eine detaillierte Darstellung der möglichen Diagrammtypen, von Datenquellen und Diagrammattributen schauen Sie sich bitte das Kapitel "Beschreibung aller Parameter" an.

Überblick

Um ein mit flashChart zu erzeugendes Diagramm in einem Inhalt (Artikel) dazustellen, fügt man das plugin tag {flashchart} mit optionalen Parametern, die die Attribute des Diagramms definieren, und eine eindeutige chart-id des Diagramms ein. Das Ende des Plugins zeigt man mit dem "end-of-plugin tag" {/flashchart}. Das Plugin Tag hat folgende Syntax:

{flashchart parm1="wert" parm2="wert" } chartid {/flashchart} .

Werte für Parameter müssen in normale Anführungszeichen ("Gänsefüßchen") eingeschlossen sein ("wert") und sind nur klein zu schreiben. Die Namen der Parameter sind zwingend klein zu schreiben. über die Plugin Parameter können eine Vielzahl von Attributen für Diagramme global zugewiesen werden, sodaß man auf sich auf diese Defaults beziehen kann und so die Eingabe von Parametern reduzieren kann (natürlich kann man jeden der unterstützten Parameter individuell ausgestalten). Wie das ganze funktioniert, sieht am vielleicht am unteren Beispiel - hier wird ein Diagramm angefordert, das nur die notwendigen Parameter, ("data" und "chartid" enthält (alle anderen Attribute werden über die Default Plugin-Parameter geliefert):

"{flashchart data="50,60,70,80,90,60|109,120,100,130,140,100"} Beispiel01{/flashchart}"

Der "data"-tag beschreibt die Daten für das Diagramm.Zahlen sind durch Komma zu trennen. Wenn man mehrere Datengruppen darstellen möchte, müssen diese mit dem "Oder"-Zeichen "|" voneinander getrennt werden (das Beispiel oben hat zwei Datengruppen). Um das mit diesen Parametern erzeugte Diagramm zu sehen, klicken Sie bitte hier.

Plugin Einstellungen

flashChart hat bereits ein Vielzahl von Diagrammattributen gesetzt, sodaß Benutzer nur wenig selbst angeben müssen und nicht alle unterstützten Parameter "im Kopf" haben müssen. Alle diese Defaults können natürlich individuell in flashChart tags gesetzt werden.
Man ändert die Defaults im Administrator Backend über "Erweiterungen -> "Plugins" und wählt dann das Plugin "flashChart content plugin" aus.

Parameter

Beschreibung und Referenz aller unterstützten Parameter

Es ist nicht notwendig viele der unterstützten Parameter (mit diesem Release sind es nun 85(!) Optionen) für ein Diagramm zu spezifizieren, aber einige sind sehr nützlich und ergeben ein attraktiveres und informativeres Erscheinungsbild Ihres Flash Objektes. Einige der Parameter werden auch mit Beispielen illustriert - schauen Sie sich diese doch mal an.

Parameter auswählen:

Neues

Release 1.3.3

Release 1.3.3 ist eine aktualisierte Version von Release 1.3.2. Wesentliche Code-Änderungen wurden für die Unterstützung für die neue Joomla namespaced API implementiert. Ausserdem wurden Anpassungen für eine PHP Version 7.2 Umgebung gemacht.

Eine grosse Änderung in Joomla! 4 sind die Namespaces. Eine Funktion, die seit PHP 5.3.0 existiert und 2009 eingeführt wurde. Die gesamte PHP-Community hat sich darauf eingestellt und Joomla! will in diesem Bereich nicht zurückbleiben. In Joomla! 4.0 wird die Kernarchitektur die Unterstützung und weitgehende Verwendung von PHP-Code in PHP Namespaces-Schreibweise sein. Dies gilt für die Kernbibliotheken und auch Erweiterungen, wie z. B. flashchart.

Release 1.3.2

Release 1.3.2 ist eine aktualisierte Version von Release 1.3.1. Wesentliche Code-Änderungen wurden für die Unterstützung für eine PHP Version 7 Umgebung implementiert.

Release 1.3.1

Zwei neue Optionen "target_line" und "target_linecolor" wurden eingeführt. Bei Angabe von "target_line" wird im Koordinatensystem zusätzlich zu X-Achse und Y-Achse eine (Ziel) Linie bei dem Y-Wert bzw. X-Wert angezeigt. "target_linecolor" setzt die Farbe für eine Ziel-Linie. Falls man hier die gleiche Farbe wie für den Hintergrund gewählt hat, wird die Linie nicht sichtbar sein.

Build Level 1.3.1.2 unterstützt nun die logarithmische Skalierung der y-Achse mit dem Paramerter "log_scaley". Daneben wurde die Darstellung von Tooltips-Inhalten beim Einsatz des Parameters "x_label_truncate" verbessert.

Release 1.3.0

Der Code wurde komplett überarbeitet und Verbesserungen für das Laufzeitverhalten (Performance) eingebaut.

Neu im Release 1.2.2

Release 1.2.2 ist im wesentlichen ein "Security-Release" - es wird nun z. B. in allen php-Scripts geprüft, ob das Joomla Framework verwendet wird, d.h. jeder direkte Aufruf wird mit einem Fehler abgewiesen. Die OFC Post/Get Schnittstelle wird (auch aus Sicherheitsgründen) nun nicht mehr unterstützt.

Mit diesem Release wurde die Schnittstelle für "Modal Windows" erweitert. Man kann nun via Parameter "modal_chart" ein Diagramm unmittelbar in einem modalen Fenster anzeigen lassen.

Das Exception-Handling für die Datenbankschnittstelle (MYSQL) wurde für Joomla Version 3.x angepasst.

Neu im Release 1.2.1

Mit diesem Release sind eine Reihe von Erweiterungen und Verbesserungen hinzugekommen:

Neue Diagrammtypen - Streudiagramme:

scatter_dot
scatter_star
scatter_box
scatter_hollow

Darstellung von Trends (Trendlinie) in Säulen- und Liniendiagrammen
Regressionsanalyse für Streudiagramme:

lineare Regression
exponentiale Regression (zwei Typen)
Einsatz von eigenen Regressionsformeln

Erzeugung von Diagrammdaten via mathematischer Formeln

Neu im Release 1.2.0

ein neu überarbeitetes Flash-Objekt ("open-flash-chart.swf") wird eingesetzt
FlashChart unterstützt eine Vielzahl von Aktionen auf "mouse click events" (via Mausklicks auf Diagrammelemente können Aktionen ausgelöst und verarbeitet werden).
Kreisdiagramme kann man zusätzlich mit Legenden versehen
der Radius von Kreisdiagrammen kann frei definiert werden
Legenden können auf die rechten Seite (statt auf der oberen Seite) des Diagramms gesetzt werden
Man kann nun Diagramm-Menüs definieren und nutzen
das Problem bei Balkendiagrammen (type="bar_horizontal") mit mehreren Datengruppen wurde beseitigt
Säulen- und Liniendiagramme können mit Zahlenwerten angezeigt werden
Funktionen, um Javascripts zu erstellen bzw. für Click-Events zu nutzen wurden bereitgestellt
Diagramme können mit einem Hintergrundbild dargestellt werden
man kann nun die Datenstruktur für Säulendiagramme unverändert auch für gestapelete Säulendiagramme (type="bar_stack") verwenden
Unterstützung für "standalone" Webanwendungen
plus einer Reihe von Verbesserungen im Code

Änderungen

Parameter "c_color" wurde in "chart_colors" geändert. Bitte im Administrator Backend via "Erweiterungen -> "Plugins" und dann das Plugin "flashChart content plugin" auswählen und dann nach dem Aufruf "speichern" klicken.

Hints und Tips

Meine Parameter scheinen O.K.zu sein aber es wird kein Diagramm angezeigt oder ich bekomme eine Fehlernachricht
Einige Probleme dieser Art werden durch Joomla!'s WYSIWIG Editoren verursacht. Ich musste einige Male erleben, dass mein Editor zu "schlau" meine Eingabe korrigierte . Leerzeichen wurden durch " " oder Tabulatorzeichen ersetzt. Aus Sonderzeichen wie "=" oder "/" machte der Editor HTML-Codes. Um solche Dinge herauszufinden, schaut man sich am besten immer die HTML-Quelle an (alle Editoren bieten diese Möglichkeit), die der Editor erzeugt hat und korrigiert die Eingabe in der HTML-Quelle.

Drucken
Seit der Version 1.2.0.13 kann man via Kontext-Menu Diagramme drucken (Aufruf via Klick im Diagramm mit rechter Maustaste). Wenn man Diagramme vor dem Druck in Images konvertiert (via Kontext-Menu) kann man auch die gesamte Webseite zusammen mit den Diagrammen drucken (dieses Konvertieren ist bei Microsofts Internet Explorer nicht notwendig). Daneben bietet auch das mitgelieferte Javascript "print_page" die gleiche Funktionalität.

Hinweise zum Einsatz von gestapelten Säulendiagrammen:
Wenn man ein einfaches oder Seite an Seite stehendes Säulendiagramm anfordert, erzeugt jeder einzelne Wert innerhalb einer Datengruppe eine einzelne Säule mit der jeweils gleichen Farbe. Bei gestapelten Säulendiagrammen (type="bar_stack") ist dieses Verhalten anders. Hier führt jeder Wert innerhalb einer Datengruppe zu einem Stapel (Stack) mit unterschiedlicher Farbe auf einer einzelnen Säule.
Beispiel: Sie möchten die Umsätze von zwei Produkten für die Monate Januar bis März in einem Diagramm darstellen. Dafür haben Sie folgende Datendefininition angegeben: data="Jan,Feb,Mär,Apr / 10,20,30,40 | 50,60,70,80" und fordern ein Säulendiagramm mit type="bar_cylinder" an. Dann werden aus dieser Angabe vier Seite an Seite stehende Paare von Säulen erzeugt.
Wenn man nun ein gestapeltes Säulendiagramm (type="bar_stacked") mit den gleichen Daten anfordert, würde man ein Diagramm mit nur zwei gestapelten Säulen erzeugen - dies würde also zu einem inkorrektes Diagramm führen. Um dies zu korrigieren muss man also die Daten neu anordnen: data="Jan,Feb,Mär,Apr / 10,50 | 20,60 | 30,70 | 40,80" - diese Anordnung führt dann zu dem korrekten Diagramm mit vier gestapelten Säulen (wenn Daten aus einer Datenbank angefordert wurden, sorgt flashChart automatisch für eine Neuanordnung).

Mit der Version 1.2.0 hat man nun die Möglichkeit, via Parameter rearrange_data="1" die Daten über FlashChart neu anzuordnen.

Hinweise zur mysql Schnittstelle:
Mit flashChart haben Sie Zugriff auf Tabellen der Joomla! Datenbank und auf externe mysql Datenbanken. Die Erzeugung ihres Diagramms hängt unmittelbar von den Daten ab, die sie mit ihrer Abfrage von der mysql Datenbank bekommen, d. h. der Schlüssel zur Datengewinnung und ihre Darstellung ist ihre SQL-Anweisung. Die Resultatsmenge von Daten über ihre Abfrage wird von flashChart in folgender Weise verwendet:

falls die Resultatsmenge nur eine Daten-Spalte enthält oder der Parameter "sql_labels" den Wert "0" gesetzt hat, werden die Daten unmittelbar zur Erzeugung des Diagramms verwendet.
zum Beispiel: ...data="database" sql="Select hits From jos_content Order By hits Desc Limit 10"
falls die Resultatsmenge zwei oder mehr Datenspalten enthält und der Parameter "sql_labels" den Wert "1" (das ist der Default) gesetzt hat:
zum Beispiel: ...data="database" sql="Select title, hits From jos_content Order By hits Desc Limit 10"
- werden die Daten aus der ersten Spalte zur Erzeugung der Labels für die x-Achse verwendet
- die Daten aus den folgenden Spalten werden als Daten für das Diagramm interpretiert. Jede Spalte bildet dabei eine Datengruppe (und sorgt für die Erzeugung von side by side bar-charts, stacked bar-charts oder multi line-charts).

Support

Obwohl ich sehr intensiv getestet habe, könnte es sein, daß ich noch einige Bugs übersehen habe. Deshalb bitte "take it easy"! Ich bin bemüht, einen Fix so schnell als möglich bereitzustelllen. Bitte fügen Sie die flashChart Parameter bei, die u. U. das Problem verursacht haben. Um mich zu kontaktieren, senden Sie eine email an mich und beschreiben Sie Ihr Problem oder besuchen Sie einfach mein Forum.
Haben Sie Probleme Anregungen? Scheuen Sie sich nicht, Scheuen Sie sich nicht, Diese E-Mail-Adresse ist vor Spambots geschützt! Zur Anzeige muss JavaScript eingeschaltet sein! Wenn Sie dieses Plugin mögen, bin ich auf keinen Fall böse, wenn Sie es mir oder anderen erzählen!

Danksagung

Ohne die außergewöhnlich gute Arbeit und gute Dokumentation der Entwickler von Open Flash Chart wäre es nicht möglich gewesen, dieses Joomla! plugin zu bauen. Deshalb vielen Dank an das Open Flash Chart Development Team! - sie haben eine tolle Arbeit zustande gebracht und zur Verfügung gestellt.