TomTom Maps for JavaScript
    Preparing search index...

    Interface Circle

    Circular search geometry (non-standard GeoJSON extension).

    Defines a circular search area by center point and radius. This is a convenience type since standard GeoJSON does not include circles.

    Note: This is not part of the official GeoJSON specification. It's a Maps SDK extension that gets converted to the appropriate API format internally.

    Coordinate Format: [longitude, latitude] (standard GeoJSON order)

    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

    Properties

    coordinates: Position

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

    [4.9041, 52.3676]
    
    radius: number

    Radius of the circle in meters.

    Defines the search area around the center point. Places within or near this radius will be included in results.

    1000 // 1 kilometer
    
    type: "Circle"

    Geometry type identifier. Must be the literal string 'Circle'.