https://github.com/gluonhq/maps

https://github.com/gluonhq/maps

java javafx map

Last synced: 5 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/gluonhq/maps
• Owner: gluonhq
• License: gpl-3.0
• Created: 2016-09-23T07:04:11.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-07-29T12:21:12.000Z (7 months ago)
• Last Synced: 2025-01-29T08:47:01.092Z (13 days ago)
• Topics: java, javafx, map
• Language: Java
• Homepage: https://gluonhq.com/labs/maps/
• Size: 523 KB
• Stars: 146
• Watchers: 14
• Forks: 35
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• aboutfx - Gluon Maps

README

        
[![Gluon](.github/assets/gluon_logo.svg)](https://gluonhq.com)

[![Build](https://github.com/gluonhq/maps/actions/workflows/build.yml/badge.svg)](https://github.com/gluonhq/maps/actions/workflows/build.yml)

[![Maven Central](https://img.shields.io/maven-central/v/com.gluonhq/maps)](https://search.maven.org/#search|ga|1|com.gluonhq.maps)

[![License](https://img.shields.io/github/license/gluonhq/maps)](https://opensource.org/licenses/GPL-3.0)

[![javadoc](https://javadoc.io/badge2/com.gluonhq/maps/javadoc.svg)](https://javadoc.io/doc/com.gluonhq/maps)

[![JFXCentral](https://img.shields.io/badge/Find_me_on-JFXCentral-blue?logo=googlechrome&logoColor=white)](https://www.jfx-central.com/libraries/gluonmaps)

# Gluon Maps

Gluon Maps provides an easy way to integrate [OpenStreetMaps](https://www.openstreetmap.org) into a JavaFX application.

It is blazing fast and offers layer overlays, multiple tile-sets, and much more.

## API Overview

### MapPoint

Represents a set of latitude and longitude values.

```

MapPoint point = new MapPoint(latitude, longitude);

```

### MapLayer

Shows the map tiles along with any user defined nodes.

This class can be extended by overloading the `layoutLayer` method.

The following code snippet shows how to create a custom layer that displays red circles at the given map points:

```

public class CustomMapLayer extends MapLayer {

    @Override

    protected void layoutLayer() {

        for (Pair candidate : points) {

            MapPoint point = new MapPoint(lat, long);

            Node icon = new Circle(5, Color.RED);

            Point2D mapPoint = getMapPoint(point.getLatitude(), point.getLongitude());

            icon.setVisible(true);

            icon.setTranslateX(mapPoint.getX());

            icon.setTranslateY(mapPoint.getY());

        }

    }

}

```

### MapView

Top level map component which supports multiple `MapLayer`.

The section of viewable map can be changed using input events (mouse/touch/gestures),

or by calling the methods `setCenter` and `setZoom` directly.

```

MapView mapView = new MapView();

mapView.addLayer(new CustomMapLayer());

mapView.setZoom(3);

```

## Usage

`Map` can be added to a JavaFX project by using the artifact published in Maven Central:

Maven:

```

    com.gluonhq

    maps

    ${version}

```

Gradle:

```

dependencies {

    implementation 'com.gluonhq:maps:${version}'

}

```

The project can be also be installed in the local Maven repository:

```

mvn install

```

## Sample

A [sample](https://github.com/gluonhq/maps/tree/master/samples/) is provided in the repository to get started with the library.

To run the sample:

```

mvn javafx:run -f samples

```

## Contribution

All contributions are welcome!

There are two common ways to contribute:

- Submit [issues](https://github.com/gluonhq/maps/issues) for bug reports, questions, or requests for enhancements.

- Contributions can be submitted via [pull request](https://github.com/gluonhq/maps/pulls), provided you have signed the [Gluon Individual Contributor License Agreement (CLA)](https://cla.gluonhq.com).

Follow [contributing rules](https://github.com/gluonhq/maps/blob/master/CONTRIBUTING.md) for this repository.

## Commercial License

Commercial licences available at: http://gluonhq.com/labs/maps/buy/