Mash-Up-komponentti integroidaan omaan järjestelmään lisäämällä seuraavat kaksi HTML/Javascript-koodiriviä HTML-tiedostoon:
<script type="text/Javascript" src="http://www.yso.fi/onki.js"><script>
(tyypillisimmin head
-elementin sisään)
<input onkeyup="onki['X'].search(Y)" id="Z"/>
(body
-elementin sisään siihen kohtaan sivua, johon hakukenttä halutaan)
Samalle sivulle voidaan asettaa useita hakukenttiä. Jokaista hakukenttää kohden tarvitaan tällöin ylläolevan kuvauksen mukainen input
-elementti.
Jos hakukenttiä halutaan luoda dynaamisesti, ts. hakukentät eivät ole sivulla sivun latautuessa, hakukentän lisäyksen jälkeen on kutsuttava Javascript-funktiota initOnki()
.
Mash-up-komponentin ulkoasua voidaan muokata määrittämällä omia CSS-sääntöjä, esimerkiksi käyttäen komponentin elementtien class
-attribuutteja.
onki['X'].search() -metodin valinnaiset parametrit:
Parametri | Tyyppi | Selitys | Oletusarvo |
---|---|---|---|
lang | String | Haun rajaus tämänkielisiin käsitteiden labeleihin | "fi" |
maxHits | int | Hakutulosten maksimimäärä | 0 (rajoittamaton) |
parentRestriction | String | Haun rajaus tämän käsitteen alipuuhun | null (ei rajausta) |
typeRestriction | String | Haun rajaus tämäntyyppisiin käsitteisiin | null (ei rajausta, ellei haun kohteena olevaan ONKI-instanssiin ole asetettu oletusta (esim. YSOssa yso-meta:Class)) |
autocompletionSearch | boolean | Onko autocompletion-hakukenttä käytössä | true |
languageMenu | boolean | Onko kielivalintavalikko käytössä | true |
openonkibutton | boolean | Onko "Open ONKI Browser" -painike käytössä | true |
openonkilabel | String | "Open ONKI Browser" -painikkeen labeli | "Open ONKI Browser" |
onkimenu | boolean | Onko ONKI-instanssin (ontologian) valintavalikko käytössä | true |
prefix | boolean | Liitetäänkö hakutuloksista valittujen käsitteiden labeleihin nimiavaruus-prefix | true |
addConceptFunction | viite funktioon | Itse määriteltävä Javascript-funktio käsitteiden valintaan hakutuloksista omaan sovellukseen, funktio saa parametrit (uri, label, url); URL on linkki käsitteen HTML-esitysmuotoon, ellei se ole sama kuin URI, jolloin URLia ei ole määritetty; tämän käyttäminen on vaihtoehto conceptCollectorille | Käyttää ONKIn omaa toteutusta |
onkiFinder | viite funktioon (konstruktori-tyyppinen) | Javascript-komponentti hakutulosten näyttämiseen (tarkemmat speksit dokumentoidaan myöhemmin) | Käyttää ONKIn omaa toteutusta |
conceptCollector | viite funktioon (konstruktori-tyyppinen) | Javascript-komponentti käsitteiden valintaan hakutuloksista (tarkemmat speksit dokumentoidaan myöhemmin) | Käyttää ONKIn omaa toteutusta |
maxSelect | int | Valittavien käsitteiden maksimimäärä, vaatii toimiakseen conceptCollectorin (ei toimi itse määriteltyä addConceptFunction-funktiota käytettäessä) | 0 (rajoittamaton) |
returnType | string | Hakutuloksen tyyppi; parametri käytössä tällä hetkellä vain ONKI-Paikassa ("uri" / "polygon"), muissa ONKI-instansseissa palautusmuotona aina URI | null (haun kohteena olevan ONKI-instanssin oletus) |
termsNotUris | boolean | Noudetaanko termejä URI-tunnisteiden sijaan | false |
fieldName | String | Valittujen käsitteiden tallentamiseen käytettyjen piilokenttien nimi | "uri", jos noudetaan URI-tunnisteita; "term", jos termejä (edellisen parametrin perusteella) |
Parametrit annetaan JSON-muodossa: {'parametri1-nimi' : parametri1-arvo, 'parametri2-nimi' : parametri2-arvo}.
<input onkeyup="onki['yso'].search({'lang' : 'en', 'maxHits' : 20, 'onkimenu' : false, 'addConceptFunction' : myAddConceptFunction})" id="hakukenttä"/>