Palvelukartan upotusohjeet
Palvelukartan yksittäisiä näkymiä voi upottaa osaksi mitä tahansa verkkosivua.
Mitä tarkoittaa upotus?
Upotus (Embed-ominaisuus) tarkoittaa, että video, tiedosto tai muu esitys voidaan “upottaa” koodin avulla toiselle internet sivulle. Upottamisen avulla voidaan haluttua kohdetta tarkastella täten suoraan valitulta samalta sivulta, sen sijaan että katselija siirtyy toiselle sivulle.
Mitä tarkoittaa ID?
ID (identifier , suomeksi tunniste) tarkoittaa tietojenkäsittelyssä annettavaa yksilöllistä tunnistetta. Esimerkiksi henkilötunnus on numeromuotoinen tunniste.
Asiasanalista
Asiasanojen lista upotuksia varten. Asiasanoista käytetään myös nimeä palvelut tai palvelusanat. Löydät kaikki asiasanat listattuna yhdeltä sivulta.
Sinua saattaisi kiinnostaa
Palvelukartan upotustyökalu
Kun kartta on haluamassasi näkymässä, klikkaa sivun oikeassa yläkulmassa olevaa “Karttatyökalut” painiketta.
Karttatyökaluista löytyy upotustyökalu.
Upotustyökalun avulla pääsee esikatselemaan, miltä valittu näkymä upotettuna versiona näyttää.
Voit myös säätää upotuksen kokoa ja muita asetuksia. Lopuksi voit kopioida sivun alalaidassa olevan upotuskoodin osaksi haluamaasi sivua.
Mahdolliset upottettavat näkymät
Tässä ohjeessa listataan esimerkkejä mahdollisista upotettavista kohteista. Esimerkeissä kuvataan URL-osoite, jolla upotus muodostetaan. Mallia URL-osoitteen käytöstä upottamisessa voi ottaa Palvelukartan upotustyökalun upotuskoodista: https://palvelukartta.hel.fi/fi/embedder/
Ohjeita
Yksittäisen toimipisteen upotuksen voi luoda hakemalla haluttu toimipiste Palvelukartalta ja valitsemalla upotustyökalu.
Upotusosoite on muodoltaan:https://palvelukartta.hel.fi/fi/embed/unit/:id
:id on toimipisteen tunnus.
Toimipisteen lähellä olevat palvelut
Toimipisteen upotukseen voi lisätä muita lähellä olevia toimipisteitä palveluiden perusteella.
Esimerkki: kävelyreitin lähellä olevat museot ja kahvilat sadan metrin etäisyydellä:https://palvelukartta.hel.fi/fi/embed/unit/68398?services=961,239&distance=100
services on lista halutuista palveluista ja distance haluttu etäisyys, jolta toimipisteet näytetään.
HUOM! Distance, eli etäisyys voidaan lisätä vain reitti ja toimipiste tyyppisille tiedoille. Aluetyyppiseltä tiedolta distance osuus pitää jättää pois upotuslinkistä. Eli ylläolevasta esimerkistä osuus “&distance=100” pois.
Hakutulosjoukon voi upottaa tekemällä haluttu haku Palvelukartalla ja valitsemalla upotustyökalu.
Upotusosoite on muodoltaan: https://palvelukartta.hel.fi/fi/embed/search?q=:hakutermi
:hakutermi on vapaatekstihaun parametri.
Palvelun toimipisteet voidaan upottaa hakemalla haluttu palvelu Palvelukartan haun kautta ja valitsemalla upotustyökalu.
Upotusosoite on muodoltaan:https://palvelukartta.hel.fi/fi/embed/service/:id
:id on palvelun tunnus.
Vaihtoehtoisia parametreja palvelusivulle.
| Parametri | Oletusarvo | Kuvaus |
|---|---|---|
lat | Lat ja lon tiedot keskittää kartan kyseisen koordinaattiin ja zoomaa lähitasolle. latitude tieto tarvitaan longitude tiedon kanssa | |
lon | Lat ja lon tiedot keskittää kartan kyseisen koordinaattiin ja zoomaa lähitasolle. longitude tieto tarvitaan latitude tiedon kanssa | |
hide_marker | false | hide_marker true tieto piilottaa oletusarvoisen punaisen karttamerkin |
Halutut toimipisteet voidaan upottaa listaamalla niiden id:t seuraavalla tavalla: https://palvelukartta.hel.fi/fi/embed/search?units=8215,51342,8264,32359
Ohje: Vaihda numeroiden 8215, 51342 jne tilalle haluamasi toimipisteiden ID:t. Niitä voi olla enemmän tai vähemmän, kuin esimerkissä. Toimipisteiden ID:t löytyvät esimerkiksi Palvelukartalta.
Palvelukartan palveluluettelon avulla voidaan upottaa joukko palveluita ja niiden toimipisteet. Upotuksen voi luoda valitsemalla palveluluettalosta halutut solmut ja tekemällä haun, jonka jälkeen hakutulossivulla valitaan upotustyökalu.
Upotusosoite on muodoltaan: https://palvelukartta.hel.fi/fi/embed/search?service_node=1065,1066,1062
service_node on lista palvelujen id arvoja jotka on erotettu pilkuilla.
Osoite voidaan upottaa hakemalla haluttu osoite Palvelukartan hausta ja valitsemalla upotustyökalu.https://palvelukartta.hel.fi/fi/embed/address/:municipality/:street/:number
:municipality on kunta,
:street kadunnimi ja
:number osoitteen numero-osa.
Oletuksena upotus näyttää myös osoitteen lähipalveluiden toimipisteet. Nämä voidaan halutessa piilottaa lisäämällä parametri units=none.https://palvelukartta.hel.fi/fi/embed/address/helsinki/Eläintarhantie/3?units=none
Alueen upotus voidaan luoda siirtymällä Palvelukartan aluenäkymään, valitsemalla haluttu alue ja sen jälkeen valitsemalla upotustyökalu. Aluenäkymässä voidaan myös valita osoite, jos halutaan tarkastella tietyn osoitteen palvelualuetta.
Upotusosoite on muodoltaan:https://palvelukartta.hel.fi/fi/embed/area?selected=health_station_district&lat=60.2049198&lng=24.8995213
selected on alueen id (administrative division type palvelukartan rajapinnassa).
Vaihtoehtoiset arvot: lat valitun osoiteen latitude-koordinaatti ja
lng valitun osoitteen longitude-koordinaatti numero-osa.
Maantieteellisen alueen upotus
Maantieteellisten alueiden upotuksessa voidaan käyttää lisäarvoja, joiden avulla näytetään tiettyjä alueita ja niiden toimipisteitä:
districtson lista alueiden id:istä (administrative division palvelukartan rajapinnassa), joka määrittää mitkä alueet ovat valittuna.serviceson lista palveluista (id:t), joiden toimipisteet halutaan näyttää valittujen alueiden sisällä. Arvon pois jättäminen näyttää kaikki toimipisteet alueella.
https://palvelukartta.hel.fi/fi/embed/search?events=yso:p4354
Linked Events rajapinnan tapahtumien avainsanojen pohjalta voidaan luoda upotusnäkymä, joka näyttää tapahtumien toimipisteiden sijainnit ja listaa niiden tapahtumat. events arvolle voidaan antaa Linked Events rajapinnan avainsanan (keyword) id.
Koordinaattipisteen upottaminen
Alueellinen rajaus
Jos haluaa tehdä mielivaltaisen karttarajauksen, siihen voi käyttää bbox-parametria, joka määrittää koordinaatteina halutun alueen kartalla, jonka pitää näkyä upotuksessa.https://palvelukartta.hel.fi/fi/embed/?bbox=60.17645,24.93664,60.18527,24.97078
| Parametri | Oletusarvo | Kuvaus | Arvot | |
|---|---|---|---|---|
bbox | – | kartan rajat WGS-koordinaatteina, esim. 60.17645,24.93664,60.18527,24.97078 |
Upotuslinkkiin voi kerätä toimipisteiden ID:t ja jakaa sitä. Esim. https://palvelukartta.hel.fi/fi/search?units=8215,51342,41102,32359
Ohje: Vaihda numeroiden 8215, 51342 jne tilalle haluamasi toimipisteiden ID:t. Niitä voi olla enemmän tai vähemmän, kuin esimerkissä.
Upotuslinkkiin voi kerätä palveluiden ID:t ja määritellä kuinka pitkältä niitä haetaan. Esim. https://palvelukartta.hel.fi/fi/unit/50967?services=737,496&distance=100
Yllä olevassa erimerkissä 50967 on reitin ID, eli yksilöivä tunniste. ID näkyy reittiä katsottaessa palvelukartan osoiterivillä. Services=737,496 ovat palvelujen tunnisteita, joilla käsketään osoiteriviä hakemaan tuolla palvelutunnisteella olevia toimipisteitä. Distance=100 on metrimäärä, jonka päästä toimipisteitä haetaan.
Ohje: Vaihda esimerkin linkkiin numeron 50967 tilalle haluamasi toimipisteen ID ja vaihda services numeroiden (737 ja 496) tilalle haluamasi palveluiden ID:t.
Palveluiden ID:t löytyvät täältä.
Voit myös vaihtaa Distance luvun haluamaksesi. Esimerkissä etäisyys, jolta palveluita haetaan, on 100 metriä.
Toimipiste voi olla alue tai reitti. Alueita ja reittejä voi syöttää esim. Lipas liikuntapaikkojen rekisteriin.
HUOM! Alue-tyyppiseltä tiedolta pitää poistaa upotuslinkistä “&distance=100” osuus. Tässä esimerkkilinkki, johon on haettu aluelle ‘Pikko Leikosaaren’ (toimipiste ID 50892) ruoanlaittopaikat (palvelu ID 586)
https://palvelukartta.hel.fi/fi/unit/50892?services=586
Upotustyökalusta saa valita lisäksi listana toimipisteiden nimet. https://palvelukartta.hel.fi/fi/embed/unit/50967?services=737,496&distance=100&show_list=true
Upotustyökalussa listan sijaintia voi vaihtaa sivulle tai kartan alle:
Katso alla olevan linkin kautta video, jonka avulla kerrotaan, miten teet Drupal-sivustolle karttaupotuksen.
Upotusparametrit
Näillä yleisillä URL-parametreilla voidaan määrittää upotuksen asetuksia. Nämä voidaan myös määrittää Palvelukartan upotustyökalussa.
Taustakartta
Kaikissa upotusnäkymissä voi käyttää seuraavia valinnaisia query-parametreja URL-osoittessa. Osa parametreista löytyy myös upotustyökalusta visuaalisena.
| Parametri | Oletusarvo | Kuvaus | Arvot | |
|---|---|---|---|---|
map | servicemap | taustakartta | servicemap | palvelukartta |
accessible_map | suurikontrastinen kartta | |||
ortographic | ortografinen ilmakuva |
Kaupunki
Kaupungit vot rajata asettamalla city parametrin. Jos parametria ei aseteta oletusarvoisesti rajausta kaupunkien mukaan ei tehdä. city=helsinki,espoo,kauniainen
| Parametri | Oletusarvo | Kuvaus | Arvot | |
|---|---|---|---|---|
city | empty | city parametrilla voi rajata minkä kaupungin alueella toimipisteitä näytetään. Arvot toimivat listana joka erotellaan pilkulla esim. espoo,vantaa. Jos arvoa ei anneta rajausta ei tehdä ja kaikki toimipisteet näkyvät. | helsinki | helsingin toimipisteet |
espoo | espoon toimipisteet | |||
kauniainen | kauniaisen toimipisteet | |||
vantaa | vantaan toimipisteet |
Alueellinen rajaus
Jos kartan haluaa rajata tiettyyn alueeseen, siihen voi käyttää bbox-parametria, joka määrittää koordinaatteina halutun alueen kartalla.
| Parametri | Oletusarvo | Kuvaus | Arvot | |
|---|---|---|---|---|
bbox | – | kartan rajat WGS-koordinaatteina, esim. 60.14294,24.83800,60.20365,24.99757 |
bbox-parametrin karttarajaus tulkitaan niin, että upotuksen on pidettävä sisällään vähintään määritellyt parametrit, mutta upotuksen koosta ja muodosta riippuen se voi sisältää laajemmankin alueen.
Toimipisterajaus
Niissä upotusnäkymissä, joissa URL-osoite ei muulla tavoin määrää näytettäviä toimipisteitä, voidaan lisäksi käyttää seuraavaa parametria.
| Parametri | Oletusarvo | Kuvaus | Arvot | |
|---|---|---|---|---|
level | none | mitä toimipisteitä näytetään | all | kaikki |
none | ei mitään | |||
common | yleisimmät julkiset palvelut |
Arvoa all kannattaa välttää, sillä erilaisia toimipisteitä tulee helposti kartalle liikaa. Yleisimmät julkiset palvelut ovat koulut, terveysasemat ja päiväkodit.
Toimipistelistan näyttäminen upotuksessa
Upotuksessa näkyvät toimipisteet voidaan myös näyttää listana upotuksen sisällä kartan vieressä. Tämä mahdollistaa upotuksen tiedon saamisen saavutettavasti apuvälineiden avulla. Listan näyttäminen onnistuu parametrilla show_list=true Esimerkiksi:https://palvelukartta.hel.fi/fi/embed/search?q=kirjastot&show_list=true
Toimipisteiden piilottaminen
Jos toimipisteet haluaa piilottaa onnistuu se units=none parametrilla
HSL pysäkkien näyttäminen
Jos HSL pysäkit halutaan näyttää upotuksessa voi ne asettaa näkyväksi asettamalla parametrin transit=1. Oletusarvoisesti pysäkkejä ei näytetä upotuksissa ja pysäkit näkyvät parametrinkin kanssa vain lähelle kohdistetuissa näkymissä.
Muista!
Kopioi teksti täältä: https://github.com/City-of-Helsinki/servicemap-ui/wiki/Uusi-upotusohje-WIP
Taustakartta: ALT teksti
Kaupunki: ALT teksti
Alueellinen rajaus: ALT teksti
Toimipisterajaus: ALT teksti