Skip to content

Latest commit

聽

History

History
417 lines (331 loc) 路 19.1 KB

API.md

File metadata and controls

417 lines (331 loc) 路 19.1 KB
Raw

This file documents efforts toward establishing a public API for iD.

URL parameters

iD Standalone

iD supports several URL parameters. When constructing a URL to a standalone instance of iD (e.g. https://ideditor-release.netlify.app), the following parameters are available in the hash portion of the URL:

  • background - The value of the id property of the source in iD's imagery list, or a custom tile URL. A custom URL is specified in the format custom:<url>, where the URL can contain the standard tile URL placeholders {x}, {y} and {z}/{zoom}, {ty} for flipped TMS-style Y coordinates, and {switch:a,b,c} for DNS multiplexing.
    Example: background=custom:https://{switch:a,b,c}.tile.openstreetmap.org/{zoom}/{x}/{y}.png
  • comment - Prefills the changeset comment. Pass a url encoded string.
    Example: comment=CAR%20crisis%2C%20refugee%20areas%20in%20Cameroon
  • disable_features - Disables features in the list.
    Example: disable_features=water,service_roads,points,paths,boundaries
    Available features: points, traffic_roads, service_roads, paths, buildings, building_parts, indoor, landuse, boundaries, water, rail, pistes, aerialways, power, past_future, others
  • gpx - A custom URL for loading a gpx track. Specifying a gpx parameter will automatically enable the gpx layer for display.
    Example: gpx=https://gist.githubusercontent.com/answerquest/9445352b60ca5b44714675eae00f243a/raw/56a6343a29223318f4a697bfd16cbb2c3b8155ad/sample_boundary.gpx
  • hashtags - Prefills the changeset hashtags. Pass a url encoded list of event hashtags separated by commas, semicolons, or spaces. Leading '#' symbols are optional and will be added automatically. (Note that hashtag-like strings are automatically detected in the comment).
    Example: hashtags=%23hotosm-task-592,%23MissingMaps
  • id - The character 'n', 'w', or 'r', followed by the OSM ID of a node, way or relation, respectively. Selects the specified entity, and, unless a map parameter is also provided, centers the map on it.
    Example: id=n1207480649
  • locale - A code specifying the localization to use, affecting the language, layout, and keyboard shortcuts. Multiple codes may be specified in order of preference. The first valid code will be the locale, while the rest will be used as fallbacks if certain text hasn't been translated. The default locale preferences are set by the browser.
    Example: locale=ja, locale=pt-BR, locale=nl,fr,de
    Available values: Any of the supported locales.
  • map - A slash-separated zoom/latitude/longitude.
    Example: map=20.00/38.90085/-77.02271
  • maprules - A path to a MapRules service endpoint for enhanced tag validation.
    Example: maprules=https://path/to/file.json
  • offset - Background imagery alignment offset in meters, formatted as east,north.
    Example: offset=-10,5
  • photo_overlay - The street-level photo overlay layers to enable.
    Example: photo_overlay=streetside,mapillary,kartaview
    Available values: streetside (Microsoft Bing), mapillary, mapillary-signs, mapillary-map-features, kartaview
  • photo_dates - The range of capture dates by which to filter street-level photos. Dates are given in YYYY-MM-DD format and separated by _. One-sided ranges are supported.
    Example: photo_dates=2019-01-01_2020-12-31, photo_dates=2019-01-01_, photo_dates=_2020-12-31
  • photo_username - The Mapillary or KartaView username by which to filter street-level photos. Multiple comma-separated usernames are supported.
    Example: photo_user=quincylvania, photo_user=quincylvania,chrisbeddow
  • photo - The service and ID of the street-level photo to show.
    Example: photo=streetside/718514589
    Available prefixes: streetside/, mapillary/, kartaview
  • presets - A comma-separated list of preset IDs. These will be the only presets the user may select.
    Example: presets=building,highway/residential,highway/unclassified
  • rtl=true - Force iD into right-to-left mode (useful for testing).
  • source - Prefills the changeset source. Pass a url encoded string.
    Example: source=Bing%3BMapillary
  • validationDisable - The issues identified by these types/subtypes will be disabled (i.e. Issues will not be shown at all). Each parameter value should contain a urlencoded, comma-separated list of type/subtype match rules. An asterisk * may be used as a wildcard.
    Example: validationDisable=crossing_ways/highway*,crossing_ways/tunnel*
  • validationWarning - The issues identified by these types/subtypes will be treated as warnings (i.e. Issues will be surfaced to the user but not block changeset upload). Each parameter value should contain a urlencoded, comma-separated list of type/subtype match rules. An asterisk * may be used as a wildcard.
    Example: validationWarning=crossing_ways/highway*,crossing_ways/tunnel*
  • validationError - The issues identified by these types/subtypes will be treated as errors (i.e. Issues will be surfaced to the user but will block changeset upload). Each parameter value should contain a urlencoded, comma-separated list of type/subtype match rules. An asterisk * may be used as a wildcard.
    Example: validationError=crossing_ways/highway*,crossing_ways/tunnel*
  • walkthrough=true - Start the walkthrough automatically
iD on openstreetmap.org (Rails Port)

When constructing a URL to an instance of iD embedded on the OpenStreetMap website (e.g. https://www.openstreetmap.org/edit?editor=id), the following parameters are available as URL hash parameters. Example: https://www.openstreetmap.org/edit?editor=id#gpx=https://gist.githubusercontent.com/answerquest/9445352b60ca5b44714675eae00f243a/raw/56a6343a29223318f4a697bfd16cbb2c3b8155ad/sample_boundary.gpx

  • map
  • gpx
  • background
  • comment
  • disable_features
  • hashtags
  • locale
  • maprules
  • offset
  • photo
  • photo_dates
  • photo_overlay
  • photo_username
  • presets
  • source
  • validationDisable
  • validationWarning
  • validationError

For a description of these parameters, refer to the iD standalone section above.

In addition, the following parameters are available as URL query parameters:

  • lat, lon, zoom
    Example: https://www.openstreetmap.org/edit?editor=id&lat=46.4705&lon=11.2423&zoom=16
  • node, way, relation - Selects the specified OSM object (similar to the id parameter of the standalone version of iD).
    Example: https://www.openstreetmap.org/edit?editor=id&node=1
  • locale - Same as standalone, but the default locale is set by the language settings in your OSM user account.
    Example: https://www.openstreetmap.org/edit?editor=id&locale=de
  • gpx - Expects a trace ID of a public gps trace uploaded on OpenStreetMap.
    Example: https://www.openstreetmap.org/edit?editor=id&gpx=4009513

Environment variables

Environment variables or a dotenv file can be used to configure certain aspects of iD at build time.

  • ID_API_CONNECTION_URL, ID_API_CONNECTION_CLIENT_ID, ID_API_CONNECTION_CLIENT_SECRET - Custom OAuth2 connection details to an OSM API server.
  • ID_API_CONNECTION_API_URL Optional url to use for OSM API calls aftern the initial authentication is complete when using a custom OAuth2 connection (see above). If unspecified, ID_API_CONNECTION_URL will be used for both the authentication and subsequent API calls.
  • ID_API_CONNECTION - Either live or dev, if only either one should be made offered for editing.
  • ID_PRESETS_CDN_URL - The URL where iD should fetch it's tagging presets from. Needs to point to a CORS enabled web server which is serving the package.json and dist folder of a repository built on @ideditor/schema-builder.
  • ENV__ID_OCI_CDN_URL - URL to a hosted version of the osm-community-index
  • ENV__ID_NSI_CDN_URL - URL to a hosted version of the name-suggestion-index
  • ENV__ID_WMF_SITEMATRIX_CDN_URL - URL to a hosted version of the wmf-sitematrix
  • ID_TAGINFO_API_URL - URL to a taginfo service.
  • ID_NOMINATIM_API_URL - URL to a nominatim geocoding service.

CSS selectors

iD has a documented and stable set of classes that can be used to apply style or attach behavior to the visual representation of map data via CSS selectors. These classes relate to the vocabulary of the OSM data model, a related geometric vocabulary established by iD, and to the tags present on OSM entities.

OSM Data Model classes

An SVG element on the map to which an iD.osmEntity has been bound as a datum shall have a class with that datum's type, i.e. either .node or .way. (If and when we add visual representations for relations, .relation may also be valid.)

The visual representation of a single entity may be composed of several elements, e.g. ways are composed of casing and stroke. Such elements will have a distinct class identifying the particular aspect of representation, e.g. .casing and .stroke.

The particular type of SVG element (path, circle, image etc.) that is used to implement that visual representation is explicitly NOT part of the public API. Avoid naming specific tags in CSS selectors; as iD evolves, we may need to change what SVG elements we use in order to implement a particular visual style.

Geometric classes

In addition to the OSM element vocabulary of nodes, ways, and relations, iD has established a related geometric vocabulary consisting of points, vertices, midpoints, lines, and areas.

A point is a node that is not a member of any way. Elements representing points have a .point class. Since a point is always a node, they also have a .node class.

A vertex is a node that is a member of one or more ways. Elements representing points have .vertex and .node classes.

A midpoint is a virtual point drawn midway between two vertices along a way. Midpoints indicate the direction that the way, but can also be selected and dragged to create a new point along the way. Midpoints are classed with a .midpoint class.

A line is a way that is not an area. Elements representing lines have a .line class. Since a line is also a way, they also have a .way class.

An area is a way that is circular, has certain tags, or lacks certain other tags (see iD.osmWay#isArea for the exact definition). Elements representing areas have .area and .way classes.

Tag classes

Elements also receive classes according to certain of the OSM key-value tags that are assigned to them.

Tag classes are prefixed with tag- (see iD.svgTagClasses for details).

Primary

An element may be classed with at most one primary tag class based on its main OSM key -- "building", "highway", "railway", "waterway", etc. (e.g. .tag-highway .tag-highway-residential).

Secondary

An element may be classed with one or more secondary tag classes based on other interesting OSM keys -- "bridge", "tunnel", "barrier", "surface", etc. (e.g. .tag-bridge .tag-bridge-yes).

Status

An element may be classed with at most one status tag. Status tagging in OSM can be either key or value based, but iD attempts to detect most common lifecycle tagging schemes -- "construction", "proposed", "abandoned", "disused", etc. (e.g. .tag-status .tag-status-construction).

Unpaved Surfaces (highways only)

Most vehicular highways in OSM are assumed to have a smooth paved surface. A highway element may receive the special tag class .tag-unpaved if it contains certain OSM tags indicating a bumpy surface.

Special classes

  • A node that is a member of two or more ways shall have the .shared class.

  • A node that is an endpoint of a linear way shall have the .endpoint class.

  • Two or more nodes at identical coordinates shall each have an .overlapped class. (TODO)

  • Elements comprising the entity currently under the cursor shall have the .hover class. (The :hover psuedo-class is insufficient when an entity's visual representation consists of several elements, only one of which can be :hovered.)

  • Elements that are currently active (being clicked or dragged) shall have the .active class.

  • Elements that are currently selected shall have the .selected class.

Customized Deployments

iD may be used to edit maps in a non-OpenStreetMap environment. This requires certain parts of the iD code to be replaced at runtime by custom code or data.

iD is written in a modular style and bundled with rollup.js, which makes hot code replacement tricky. (ES6 module exports are immutable live bindings). Because of this, the parts of iD which are designed for customization are exported as live bound objects that can be overridden at runtime before initializing the iD context.

Services

The iD.services object includes code that talks to other web services.

To replace the OSM service with a custom service that exactly mimics the default OSM service:

iD.services.osm = serviceMyOSM;

Some services may be removed entirely. For example, to remove the Mapillary service:

iD.services.mapillary = undefined;
// or
delete iD.services.mapillary;

Background Imagery

iD's background imagery database is stored in the iD.fileFetcher.cache().imagery array and can be overridden or modified prior to creating the iD context.

Note that the "None" and "Custom" options will always be shown in the list.

To remove all imagery from iD:

iD.fileFetcher.cache().imagery = [];

To replace all imagery with a single source:

iD.fileFetcher.cache().imagery = [{
    "id": "ExampleImagery",
    "name": "My Imagery",
    "type": "tms",
    "template": "http://{switch:a,b,c}.tiles.example.com/{z}/{x}/{y}.png"
}];

Each imagery source should have the following properties:

  • id - Unique identifier for this source (also used as a url parameter)
  • name - Display name for the source
  • type - Source type, currently only tms is supported
  • template - Url template, valid replacement tokens include:
    • {z}, {x}, {y} - for Z/X/Y scheme
    • {-y} or {ty} - for flipped Y
    • {u} - for quadtile scheme
    • {switch:a,b,c} - for parts of the url that can be cycled for connection parallelization

Optional properties:

  • description - A longer source description which, if included, will be displayed in a popup when viewing the background imagery list
  • overlay - If true, this is an overlay layer (a transparent layer rendered above base imagery layer). Defaults to false
  • zoomExtent - Allowable min and max zoom levels, defaults to [0, 22]
  • polygon - Array of coordinate rings within which imagery is valid. If omitted, imagery is assumed to be valid worldwide
  • overzoom - Can this imagery be scaled up when zooming in beyond the max zoom? Defaults to true
  • terms_url - Url to link to when displaying the imagery terms
  • terms_html - Html content to display in the imagery terms
  • terms_text - Text content to display in the imagery terms
  • best - If set to true, this imagery is considered "better than Bing" and may be chosen by default when iD starts. Will display with a star in the background imagery list. Defaults to false

For more details about the iD.fileFetcher.cache().imagery structure, see update_imagery.js.

Presets

iD's preset database is stored in the iD.fileFetcher.cache().presets object and can be overridden or modified prior to creating the iD context.

The format of the presets object is documented as part of the schema-builder project.

To add a new preset to iD's existing preset database.

iD.fileFetcher.cache().presets.presets["aerialway/zipline"] = {
    geometry: ["line"],
    fields: ["incline"],
    tags: { "aerialway": "zip_line" },
    name: "Zipline"
};

To completely replace iD's default presets with your own:

iD.fileFetcher.cache().presets = myPresets;

To run iD with the minimal set of presets that only match basic geometry types:

iD.fileFetcher.cache().presets = {
    presets: {
        "area": {
            "name": "Area",
            "tags": {},
            "geometry": ["area"]
        },
        "line": {
            "name": "Line",
            "tags": {},
            "geometry": ["line"]
        },
        "point": {
            "name": "Point",
            "tags": {},
            "geometry": ["point"]
        },
        "vertex": {
            "name": "Vertex",
            "tags": {},
            "geometry": ["vertex"]
        },
        "relation": {
            "name": "Relation",
            "tags": {},
            "geometry": ["relation"]
        }
    }
};

Minimum Editable Zoom

The minimum zoom at which iD enters the edit mode is configured using the context.minEditableZoom() accessor. The default value is 16. To change this initialise the iD context as:

var id = iD.coreContext()
  .minEditableZoom(zoom_level)

This should be set with caution for performance reasons. The OpenStreetMap API has a limitation of 50000 nodes per request.

Custom Presets

iD supports deployments which use a custom set of presets. You can supply presets via the presets accessor:

var id = iD.coreContext().presets({
    presets: { ... },
    fields: { ... },
    defaults: { ... },
    categories: { ... }
});

All four parts (presets, fields, defaults, and categories) must be supplied. In addition, several base presets and fields must be included.

Basic geometric presets must be included so that every feature matches at least one preset. For example:

"area": {
    "name": "Area",
    "tags": {},
    "geometry": ["area"],
    "matchScore": 0.1
},
"line": {
    "name": "Line",
    "tags": {},
    "geometry": ["line"],
    "matchScore": 0.1
},
"point": {
    "name": "Point",
    "tags": {},
    "geometry": ["point", "vertex"],
    "matchScore": 0.1
},
"relation": {
    "name": "Relation",
    "tags": {},
    "geometry": ["relation"],
    "matchScore": 0.1
}

A "name" field must be included:

"name": {
    "key": "name",
    "type": "localized",
    "label": "Name",
    "placeholder": "Common name (if any)"
}