# Scale bar

> **Note (legacy): Not compatible with the Maps SDK v10**
> 
> This plugin is not compatible with the Maps SDK v10 or higher. The Maps SDK v10 and higher comes with scale bar functionality built in. See the [Scale bar](https://docs.mapbox.com/android/maps/api/latest/mapbox-maps-android/com.mapbox.maps.plugin.scalebar/-scale-bar/) documentation.

Your browser doesn't support HTML5 video. Open [link to the video](https://docs.mapbox.com/android/ja/android/ja/assets/medias/plugins-example-scalebar-plugin-activity-1c989fc0aadc36d466e4cd3a2a8fbf17.mp4).

This example uses the [Scale bar plugin](https://docs.mapbox.com/android/ja/legacy/plugins/guides/scalebar/) to add a scale bar to the map.

You must install the plugin before running the application.

> **Note**
> 
> This example is a part of the [Mapbox Android Demo app](https://github.com/mapbox/mapbox-android-demo). You can find the values for all referenced resources in the [`res`](https://github.com/mapbox/mapbox-android-demo/tree/master/MapboxAndroidDemo/src/main/res) directory. For example, see [`res/values/activity_strings.xml`](https://github.com/mapbox/mapbox-android-demo/tree/master/MapboxAndroidDemo/src/main/res/values/activity_strings.xml) for `R.string.*` references used in this example. The dependencies can be found [here.](https://github.com/mapbox/mapbox-navigation-android-examples/blob/main/app/build.gradle) The examples use View binding. [See setup documention if necessary.](https://developer.android.com/topic/libraries/view-binding)

Title: `activity_scalebar_plugin`

[View on GitHub](https://github.com/mapbox/mapbox-android-demo/tree/master/MapboxAndroidDemo/src/main/res/layout/activity_scalebar_plugin.xml)

```xml
<?xml version="1.0" encoding="utf-8"?>
<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:mapbox="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <com.mapbox.mapboxsdk.maps.MapView
        android:id="@+id/mapView"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        mapbox:mapbox_cameraTargetLat="23.585781"
        mapbox:mapbox_cameraTargetLng="58.545909"
        mapbox:mapbox_cameraZoom="13.674097" />

    <com.google.android.material.floatingactionbutton.FloatingActionButton
        android:id="@+id/switch_scalebar_style_fab"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_gravity="bottom|right"
        android:layout_marginBottom="16dp"
        android:layout_marginEnd="16dp"
        android:layout_marginRight="16dp"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:srcCompat="@drawable/ic_swap_horiz_white_24dp"
        mapbox:fabSize="normal" />
</FrameLayout>
```

**Java**

Title: `ScalebarPluginActivity.java`

[View on GitHub](https://github.com/mapbox/mapbox-android-demo/tree/master/MapboxAndroidDemo/src/main/java/com/mapbox/mapboxandroiddemo/examples/plugins/ScalebarPluginActivity.java)

```java
package com.mapbox.mapboxandroiddemo.examples.plugins;

import android.os.Bundle;
import androidx.annotation.NonNull;
import androidx.appcompat.app.AppCompatActivity;
import android.view.View;
import android.widget.Toast;

import com.mapbox.mapboxandroiddemo.R;
import com.mapbox.mapboxsdk.Mapbox;
import com.mapbox.mapboxsdk.maps.MapView;
import com.mapbox.mapboxsdk.maps.MapboxMap;
import com.mapbox.mapboxsdk.maps.OnMapReadyCallback;
import com.mapbox.mapboxsdk.maps.Style;
import com.mapbox.pluginscalebar.ScaleBarOptions;
import com.mapbox.pluginscalebar.ScaleBarPlugin;

/**
 * Use the Scale Bar Plugin to provide a visual indication of how far various map features are from
 * one another at a certain zoom level. The scalebar can be customized with options such as the
 * text color/size, referesh interval, margins, and border width.
 */
public class ScalebarPluginActivity extends AppCompatActivity implements OnMapReadyCallback {

  private MapView mapView;
  private ScaleBarPlugin scaleBarPlugin;
  private ScaleBarOptions[] listOfScalebarStyleVariations;
  private String[] listOfStyles = new String[] {Style.LIGHT, Style.DARK, Style.SATELLITE_STREETS, Style.OUTDOORS};
  private int index = 0;

  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    // Mapbox access token is configured here. This needs to be called either in your application
    // object or in the same activity which contains the mapview.
    Mapbox.getInstance(this, getString(R.string.access_token));
    setContentView(R.layout.activity_scalebar_plugin);
    mapView = findViewById(R.id.mapView);
    mapView.onCreate(savedInstanceState);
    mapView.getMapAsync(this);
  }

  @Override
  public void onMapReady(@NonNull final MapboxMap mapboxMap) {
    mapboxMap.setStyle(listOfStyles[index], new Style.OnStyleLoaded() {
      @Override
      public void onStyleLoaded(@NonNull final Style style) {

        initStyling();

        // Create a new ScaleBarPlugin object
        scaleBarPlugin = new ScaleBarPlugin(mapView, mapboxMap);

        scaleBarPlugin.create(listOfScalebarStyleVariations[index]);

        findViewById(R.id.switch_scalebar_style_fab).setOnClickListener(new View.OnClickListener() {
          @Override
          public void onClick(View view) {

            if (index == listOfScalebarStyleVariations.length - 1) {
              index = 0;
            }

            mapboxMap.setStyle(listOfStyles[index], new Style.OnStyleLoaded() {
              @Override
              public void onStyleLoaded(@NonNull Style style) {

                scaleBarPlugin.create(listOfScalebarStyleVariations[index]);

              }
            });

            index++;

          }
        });

        Toast.makeText(ScalebarPluginActivity.this, getString(R.string.zoom_map_fab_instruction),
          Toast.LENGTH_LONG).show();
      }
    });
  }

  private void initStyling() {
    listOfScalebarStyleVariations = new ScaleBarOptions[] {

      // Using the plugin's default styling to start
      new ScaleBarOptions(this),

      // Random styling option #2
      new ScaleBarOptions(this)
        .setTextColor(R.color.mapboxRed)
        .setTextSize(40f)
        .setBarHeight(15f)
        .setBorderWidth(5f)
        .setMetricUnit(true)
        .setRefreshInterval(15)
        .setMarginTop(30f)
        .setMarginLeft(16f)
        .setTextBarMargin(15f),

      // Random styling option #3
      new ScaleBarOptions(this)
        .setTextColor(R.color.mapbox_blue)
        .setTextSize(60f)
        .setBarHeight(15f)
        .setBorderWidth(5f)
        .setMetricUnit(true)
        .setRefreshInterval(15)
        .setMarginTop(30f)
        .setMarginLeft(30f)
        .setTextBarMargin(25f),

      // Random styling option #4
      new ScaleBarOptions(this)
        .setTextColor(R.color.mapboxYellow)
        .setTextSize(30f)
        .setBarHeight(15f)
        .setBorderWidth(5f)
        .setMetricUnit(false)
        .setRefreshInterval(15)
        .setMarginTop(30f)
        .setMarginLeft(30f)
        .setTextBarMargin(25f),
    };
  }

  @Override
  protected void onStart() {
    super.onStart();
    mapView.onStart();
  }

  @Override
  protected void onResume() {
    super.onResume();
    mapView.onResume();
  }

  @Override
  protected void onPause() {
    super.onPause();
    mapView.onPause();
  }

  @Override
  protected void onStop() {
    super.onStop();
    mapView.onStop();
  }

  @Override
  public void onSaveInstanceState(Bundle outState) {
    super.onSaveInstanceState(outState);
    mapView.onSaveInstanceState(outState);
  }

  @Override
  public void onLowMemory() {
    super.onLowMemory();
    mapView.onLowMemory();
  }

  @Override
  public void onDestroy() {
    super.onDestroy();
    mapView.onDestroy();
  }
}
```