יצירת מפה
פונקציה זו מאפשרת למשתמש ליצור את המפה בדף HTML. הפונקציה מקבלת כפרמטר את כל ההגדרות של המפה. הפונקציה מקבלת כפרמטר ראשון את מחרוזת ה- id של ה-div שיכיל את המפה וכפרמטר שני אובייקט של הגדרות המפה שחייב להכיל לפחות את ה-token שהמשתמש קיבל ל-Domain שלו.
תמיכה במספר מפות במקביל
כל פונקציות ה-API תומכות בפרמטר mapDivId, כך שניתן להפעיל כל פונקציה על מפה מסוימת לפי mapDivId.
כאשר יוצרים מספר מפות, ניתן לבצע פעולות ספציפיות לכל מפה בנפרד על ידי שליחת mapDivId: string לפונקציות השונות.
במידה ולא מציינים mapDivId, הפונקציות יפעלו על כל המפות ללא אפשרות להבדיל בין המפות השונות.
אפשר לקרוא לפונקציה createMap מספר פעמים עם מזהה מפה שונה בכל פעם, אך יש להמתין עד סיו ם תהליך אתחול המפה בטרם קוראים לפונקציה כדי לאתחל מפה נוספת.
פונקציית יצירת מפה
govmap.createMap(mapDivID, MapSetting);
אזהרה
אובייקט הגדרות המפה חייב להכיל token
פרמטרים לפונקציה
| תיאור | סוג |
|---|---|
| id של ה div שמכיל את המפה | string |
| אובייקט הגדרות המפה | object |
אובייקט הגדרות המפה
| שם | סוג | תיאור |
|---|---|---|
| onClick | function | פונקציה להפעלה בלחיצה על אזור המפה ע”י העכבר |
| onError | function | פונקציה להפעלה במקרה שגיאה |
| onPan | function | פונקציה להפעלה בשינוי מיקום המפה |
| onLoad | function | פונקציה להפעלה לאחר טעינת המפה |
| background | string | id של מפת הרקע, הערכים: 0 רחובות ומבנים 1 תצלום אוויר 2 משולב 3 תצלום אויר CIR 11 ללא מפה 15 מפת רקע באנגלית |
| center | object | נקודת המרכז של המפה { x: number, y: number } |
| setMapMarker | boolean | הצגת סמן במרכז המפ ה לאחר טעינת המפה |
| visibleLayers | []string | מערך של שמות שכבות שיהיו דלוקות על המפה |
| showXY | boolean | מסמן אם להציג את הקואורדינטות בשינוי מיקום העכבר על המפה |
| level | number | רמת התמקדות |
| token | string | מפתח אימות ל-API |
| identifyOnClick | boolean | מסמן אם לבצע תשאול שכבות בלחיצה על המפה. ערך ברירת מחדל: true |
| identifyOnlyBubble | boolean | הסתר את הסמן (marker) בעת לחיצה על המפה. ערך ברירת מחדל: false |
| identifyOnlySelect | boolean | הצגת בועית מידע ללא סמן (marker). ערך ברירת מחדל: false |
| layers | string[] | מערך של שמות שכבות שיופיעו ברשימת השכבות של המפה |
| bgButton | boolean | מסמן האם להציג את הכפתור שינוי רקע על המפה. ערך ברירת מחדל: true |
| zoomButtons | boolean | משתנה בוליאני המסמן האם להציג את כפתורי ההתמקדות על המפה. ערך ברירת מחדל: true |
| isEmbeddedToggle | boolean | מציין את מצב כפתור שינוי רקע בהתאם להגדרות הבאות true - כפתור שינוי רקע מבצע החלפת מפת רקע בין רחובות ומבנים לתצלום אוויר בלבד ואינו פותח ממשק בחירת מפת רקע. false – במידה ומידות המפה גדולות או שוות לרוחב 650 פיקסלים וגובה 440 פיקסלים, בלחיצה על כפתור שינוי רקע ייפתח ממשק בחירת מפות רקע. הערה: יש להעביר true ב-bgButton |
| layersMode | number | מספר המייצג את מצב כפתור שכבות בלחיצה על כפתור שכבות מידע ייפתח ממשק בהתאם למספר שנשלח: 1 - ממשק להדלקה או/ו כיבוי שכבות 2 - ממשק להדלקה או/ו כיבוי שכבות ומקרא 3 - ממשק מקרא בלבד 4 - לא יוצג כפתור שכבות על המפה. |
| extent | object | מאפשר לנעול את המפה בתיחום מסויים, אובייקט המכיל את גבולות המפה במבנה {xmin: number, ymin: number, xmax: number, ymax: number} ואם null - אין נעילה |
קוד לדוגמה:
<html>
<head>
<script src="https://www.govmap.gov.il/govmap/api/govmap.api.js" defer onload="initGovMap()"></script>
<script type="text/javascript">
function initGovMap() {
govmap.createMap('map', {
onClick: function (e) {
console.log('onClick', e);
},
onPan: function (e) {
console.log('onPan', e);
},
token: 'YOUR_API_TOKEN',
layers: ["GASSTATIONS","PARCEL_HOKS", "KSHTANN_ASSETS", "bus_stops", "PARCEL_ALL"],
showXY: true,
identifyOnClick: true,
isEmbeddedToggle: false,
background: "1",
layersMode: 1,
zoomButtons:false
});
}
</script>
</head>
<body>
<div id="map" style="width:600px;height:600px;">
</div>
</body>
</html>