JavaScript API
hockeydata.los.KnockoutStage.Compact
Das kompakte KO-Phasen-Widget zeigt den aktuellen Stand der Begegnungen (Encounters) einer bestimmten Division tabellarisch an.
| Klassenname | hockeydata.los.KnockoutStage.Compact |
| Parameter | options:Object |
| JavaScript URL Parameter | los_knockoutstage_compact |
| CSS URL Parameter | los_knockoutstage_compact |
| Verfügbare Sportarten und Ligen (Liga: Sportart) | ebel: icehockey |
Erforderliche Optionen
| Property | Typ / Default | Beschreibung |
|---|---|---|
| apiKey | string „VOID“ | Dein API Schlüssel. |
| sport | string null | Eindeutiger Name der Sportart (verfügbare Sportarten siehe oben). |
Zusätzlich muss die Division-ID angegeben werden. Diese kann entweder direkt mit der Widget-Option divisionId angegeben oder aus dem URL-Parameter mit der Widget-Option divisionIdUrlParameter gelesen werden.
Zusätzliche Optionen
| Property | Typ / Default | Beschreibung |
|---|---|---|
| $domNode | jQuery Object jQuery(„<div/>“) | Ein DOM Blockelement, das als Platzhalter für das Widget dient, normalerweise ein <div>. Bei Einbindung mit HTML Markup nicht notwendig, da das DOM Element verwendet wird, das das Widget einbindet. |
| autoReload | boolean false | Bei true werden die Daten im Hintergrund automatisch aktualisiert. |
| columnDefinition | Object null | Definition der Spalten. Bei null wird die Definition der Sportart und optional der Liga verwendet, sofern diese geladen wurde. |
| columns | Array null | Definiert welche Spalten aus der Spaltendefinition tatsächlich angezeigt werden sollen. Ein String-Array mit den Spaltennamen oder ein String mit Spaltennamen getrennt durch Beistrich. Bei null werden die Spalten der Option columnSet verwendet.» Verfügbare Spalten |
| columnSet | string default | Vorgegebenes Set an Spalten. Wird nur verwendet, wenn columns nicht gegeben ist.» Verfügbare Spalten-Sets |
| dataUrl | string null | Die URL zum Laden der Daten. Bei null wird diese anhand der Option league ermittelt. |
| divisionId | number|string null | Eindeutige ID oder Permalink der Division (Division Finder). |
| divisionIdUrlParameter | string divisionId | Wird die Widget-Option divisionId nicht angegeben, wird die Division-ID aus dem URL-Parameter divisionIdUrlParameter genommen. |
| error | Function function() { … } | Callback-Funktion, die aufgerufen wird, wenn das Laden der Daten fehlschlägt. Als Parameter wird ein Objekt mit statusId, statusMsg und data übergeben. |
| hideHeaders | boolean true | Bei true werden die Spaltenheader zwar eingefügt, aber per CSS ausgeblendet. |
| league | string null | Eindeutiger Name der Liga (verfügbare Ligen siehe oben). Wird keine Liga angegeben, wird diese automatisch anhand der Sportart ermittelt. |
| paint | Function function() { … } | Callback-Funktion, die aufgerufen wird, wenn das Laden der Daten erfolgreich ist. Als Parameter wird ein Objekt mit statusId, statusMsg und data übergeben. |
| requestData | Object {} | Zusätzliche Parameter, die beim Request zum Laden der Daten übergeben werden. apiKey und divisionId werden automatisch aus den entsprechenden Optionen übernommen. |
| rowLink | string|Function null | Link, der beim Klick auf eine Zeile aufgerufen wird. Bei einem String wird das erste %s durch die Encounter-ID und das zweite %s durch die Division-ID ersetzt. Bei einer Callback-Funktion werden die Encounter-ID und die Division-ID als Parameter übergeben. |
| textNoData | string null | Text, der angezeigt werden soll, wenn zwar der Webservice-Aufruf erfolgreich war, aber keine Daten zurückgeliefert wurden. |
Zusätzliche Optionen
Die Optionen werden an das Widget hockeydata.util.IntelliTable weitergegeben, daher können Optionen für die Tabelle ebenfalls übergeben werden. Ausnahmen: $domNode, headers.
Verfügbare Spalten
Je nach Liga kann es vorkommen, dass manche Spalten keine Werte enthalten, da diese nicht erfasst werden.
| Spaltenname | Beschreibung | Sportart(en) |
|---|---|---|
| awayTeamLogo | Gastteam Logo | icehockey |
| awayTeamLongname | Gastteam Langname | icehockey |
| awayTeamScore | Gastteam Punkte | icehockey |
| awayTeamShortname | Gastteam Kurzname | icehockey |
| id | Spiel ID | icehockey |
| homeTeamLogo | Heimteam Logo | icehockey |
| homeTeamLongname | Heimteam Langname | icehockey |
| homeTeamScore | Heimteam Punkte | icehockey |
| homeTeamShortname | Heimteam Kurzname | icehockey |
| scoreDivider | Punktetrenner | icehockey |
| Set-Name | Spalten | Sportart |
|---|---|---|
| default | homeTeamShortname, homeTeamLogo, homeTeamScore, scoreDivider, awayTeamScore, awayTeamLogo, awayTeamShortname | icehockey |