This is the documentation of version 1.0.0-rc.2. Go to the latest version, 1.0.0-rc.5.
TomTom Maps for JavaScript
    Preparing search index...

    Interface Circle

    Circular search geometry (non-standard GeoJSON extension).

    It defines a circular search area by center point and radius. It is a convenience type, because standard GeoJSON has no circles.

    Note that it is not part of the official GeoJSON specification. It is a Maps SDK extension, converted to the appropriate API format internally.

    Coordinates are in [longitude, latitude] order, as in standard GeoJSON.

    const circle: Circle = {
    type: 'Circle',
    coordinates: [4.9041, 52.3676], // Amsterdam center
    radius: 2000 // 2km radius
    };
    interface Circle {
        coordinates: Position;
        radius: number;
        type: "Circle";
    }
    Index
    coordinates: Position

    Center point of the circle in [longitude, latitude] format.

    [4.9041, 52.3676]
    
    radius: number

    Radius of the circle in meters.

    It defines the search area around the center point. Results include places within or near this radius.

    1000 // 1 kilometer
    
    type: "Circle"

    Geometry type identifier. It must be the literal string 'Circle'.