קבלת שדות סינון

קבלת מידע מרחבי ממוקד, באמצעות שליחת קוארדינטות וביצוע חיתוך מול שכבות מידע של האתר ושכבות מידע של המשתמש.

govmap.getLayerFilterFields(layer, apiToken, language?);

פרמטרים

שם	סוג	תיאור
layer	string	שם (alias) או מזהה (id) שכבה
apiToken	string	מפתח אימות ל-API
language	'he' | 'en'	רשות. ברירת מחדל: he במידה והשכבה קיימת באנגלית

הערות

הפונקציה תחזיר אך ורק שדות לא מוסתרים.
במידה ולמשתמש אין הרשאת צפייה בכל הישויות בשכבה, השדה values יושמט מהתוצאה.

מבנה התשובה

השדה name מייצג את שם השדה הפנימי במערכת, ויש להשתמש בו בעת עבודה עם שירותי ה-API.
בשדה fieldType התשובה היא מסוג enum govmap.layerFilterFields, ראה נספח ב'.
עבור שדות מספריים ותאריכים בלבד, הערכים מחולקים לעד 10 סלים (buckets) — כל סל מייצג טווח ערכים רציף, והשדות min ו-max מציינים את גבולות הטווח. ערכי תאריך מיוצגים כ-epoch במילישניות.
עבור שדות שאינם מספר או תאריך, יוחזרו עד 50 הערכים השכיחים ביותר. במידה וקיימים ערכים נוספים, יתווסף איבר אחרון המהווה סיכום של יתר הערכים (Remainder Aggregation); איבר זה יכיל את השדה count בלבד, ללא שדה value.

    {
    "data": [
        {
            "name": "internal_field_name",
            "displayName": "שם תצוגה",
            "fieldType": 1,
            "displayOrder": 1, // סדר תצוגה בבועית המידע
            "values": {
                "fieldType": 1,             
                "totalFeatures": 5000,
                "nonNullValues": 4800,
                "distinctValues": 150,
                "min": 0,                   // שדות מסוג מספר או תאריך
                "max": 1000,                // שדות מסוג מספר או תאריך
                "buckets": [                
                    { "min": 5, "max": 14, "freq": 48 }
                    { "min": 19, "max": 48, "freq": 2 }
                ],
                "topValues": [
                    { "value": "1ערך", "count": 300 },
                    { "value": "2ערך", "count": 200 },
                    { "count": 120 }
                ]
            }
        }
    ]
}

דוגמה לבקשה

govmap.getLayerFilterFields('layer_1', 'YOUR_API_TOKEN').then(response => console.log(r));

דוגמה לתשובה

{
    "data": [
        {
            "name": "field_column_name",
            "displayName": "שם שדה",
            "displayOrder": 1,
            "values": {
                "fieldType": 1,             
                "totalFeatures": 5000,
                "nonNullValues": 4800,
                "distinctValues": 150,
                "min": 0,                   
                "max": 1000,                
                "buckets": [                
                    { "min": 0, "max": 100, "freq": 42 }
                ],
                "topValues": [              
                    { "value": "ערך", "count": 300 },
                    { "count": 120 }  
                ]
            }
        }
    ]
}