JavaScript API

« Übersicht | Demos

hockeydata.los.DivisionPicker

Mit dem DivisionPicker-Widget können mehrere Divisions zur Auswahl sowie die anzuzeigenden Widgets angegeben werden. Bei Auswahl einer Division werden die angegebenen Widgets mit der ausgewählten Division erneut geladen.

Klassenname hockeydata.los.DivisionPicker
Parameter options:Object
JavaScript URL Parameter los_divisionpicker
CSS URL Parameter los_divisionpicker
Verfügbare Sportarten und Ligen (Liga: Sportart) afboe: americanfootball
ebel: icehockey

Erforderliche Optionen

Property Typ / Default Beschreibung
apiKey string

 

"VOID"
 Dein API Schlüssel.
divisions Array|Object

 

null
 Definition der Divisions, die zur Auswahl stehen sollen. Wird ein Array angegeben, wird nur ein Auswahlfeld mit den angegeben Divisions angezeigt. Bei einem Objekt werden zwei Auswahlfelder angezeigt: eines mit den Keys des Objekts und ein zweites mit den zugehörigen Divisions des ausgewählten Keys.

 

Array: Objekte jeweils mit den Keys divisionId (number|string) und divisionName (string), Beispiel:

[
  { "divisionId": 13, "divisionName": "Grunddurchgang" },
  { "divisionId": 27, "divisionName": "Playoffs" }
].

Objekt: Die Keys sind die Werte für das erste Auswahlfeld, die zugehörigen Werte Arrays mit Objekten jeweils mit divisionId (number|string) und divisionName (string) für das zweite Auswahlfeld, Beispiel:

{
  "Saison 2016": [
    { "divisionId": 13, "divisionName": "Grunddurchgang" },
    { "divisionId": 27, "divisionName": "Playoffs" }
  ],
  "Saison 2015": [
    { "divisionId": 5, "divisionName": "Grunddurchgang" },
    { "divisionId": 11, "divisionName": "Playoffs" }
  ]
}.

Division-ID's können auch Strings sein (Permalinks).
» Division Finder
sport string

 

null
 Eindeutiger Name der Sportart (verfügbare Sportarten siehe oben).

Zusätzlich müssen ein oder mehrere Widgets definiert werden, die bei Auswahl der Division angezeigt werden sollen. Soll nur ein Widget angezeigt werden, genügt die Option widget und optional widgetOptions. Um meherere Widgets anzuzeigen, muss die Option widgets verwendet werden, wobei diese mit den Optionen widget und widgetOptions kombiniert werden kann.

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.
divisionId number|string

 

null
 Vorausgewählte Division-ID.
divisionIdUrlParameter string

 

divisionId
 Wird die Widget-Option divisionId nicht angegeben, wird die Division-ID aus dem URL-Parameter divisionIdUrlParameter genommen.
league string

 

null
 Eindeutiger Name der Liga (verfügbare Ligen siehe oben). Wird keine Liga angegeben, wird diese automatisch anhand der Sportart ermittelt.
tabs boolean

 

false
 Bei true werden die mit der Option widgets definierten Widgets in Tabs angezeigt. Ist widgets nicht definiert, wird immer false verwendet.
widget string

 

null
 Klassenname des Widgets, das angezeigt werden soll, wenn eine Division ausgewählt wird.
widgetOptions Object

 

{}
 Zusätzliche Widget-Optionen, die an das anzuzeigende Widget übergeben werden sollen. Es sind alle Widget-Optionen möglich, die das anzuzeigende Widget unterstützt. Ausnahmen: divisionId, $domNode, apiKey, autoReload, league, sport, widgetName.
widgets Array

 

null
 Definition der Widgets, die bei Auswahl einer Division angezeigt werden sollen. Jeder Eintrag ist ein Objekt mit folgenden Keys:

 

  • widget: Entspricht der Option widget, also der Klassenname des Widgets. Wird der Key nicht angegeben, wird die Option widget verwendet.
  • widgetOptions: Entspricht der Option widgetOptions, also zusätzliche Widget-Optionen. Dieser Key erweitert die Option widgetOptions. Somit ist es möglich, gleiche Widget-Optionen für alle Widgets mit der Option widgetOptions zu definieren und Widget-spezifische Widget-Optionen mit dem Key widgetOptions.
  • title: Überschrift vor jedem Widget bzw. Beschriftung des Tabs, wenn tabs auf true gesetzt ist. Ist tabs auf true gesetzt und es ist kein title definiert, wird der Klassenname des Widgets angezeigt.

Beispiel:

[
  {
    "title": "Schedule",
    "widget": "hockeydata.los.Schedule",
    "widgetOptions": { "limit": 10 }
  }, {
    "title": "Standings",
    "widget": "hockeydata.los.Standings",
    "widgetOptions": { "columnSet": "long" }
  }
]