> For the complete documentation index, see [llms.txt](https://docs.os.uk/more-than-maps/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.os.uk/more-than-maps/advanced-applications/os-ngd-data-in-dashboards/os-power-bi-map-visual/os-power-bi-map-visual-getting-started-guide/installation.md).

# Installation

Installing the OS Power BI Map Visual is straightforward and requires only a few steps.

## Installing the OS Power BI Map Visual

{% stepper %}
{% step %}

#### Download the visual

The visual is open source and can be downloaded for free from the [OS GitHub repository](https://github.com/OrdnanceSurvey/os-powerbi-map/releases). Download the `.pbiviz` file of the latest release from this page.
{% endstep %}

{% step %}

#### Click the three small dots under the Visualizations pane in Power BI

The context menu should provide options to import or remove a visual from Power BI.

<figure><img src="/files/20ef92dc334bb7ed3497e7fd7f1b1967f988a4c1" alt="Importing a visual using the OS Maps plugin from the Power BI visualizations pane. Image shows the &#x27;Import a visual from a file&#x27; option highlighted from the context menu of the OS Maps for Power BI Visualisation plugin." width="188"><figcaption><p>Importing a visual using the OS Maps plugin from the Power BI Visualizations pane.</p></figcaption></figure>
{% endstep %}

{% step %}

#### Click *Import a visual from a file* from the right-click context menu

The file explorer should open to allow you to navigate to the folder containing the `.pbiviz` file.
{% endstep %}

{% step %}

#### Select the `.pbiviz` file

Once you have downloaded the `.pbiviz` file from the [Releases page of the OS GitHub repository](https://github.com/OrdnanceSurvey/os-powerbi-map/releases), select the file from the relevant folder, then click *OK* to import it into the app.

After installing the visual, click the *OS icon* and add it to a report. When you add a visual to a report, you’ll be presented with a landing page:

<figure><img src="/files/zrkuF5ImZqGx9vPlGXCj" alt="OS Power BI Map Visual landing page in Power BI. The main page shows options to add an OS API Key with later steps to create and customise a visualisation." width="563"><figcaption><p>The OS Power BI Map Visual landing page.</p></figcaption></figure>
{% endstep %}
{% endstepper %}

## Linking the OS Power BI Map Visual to the OS Maps API

Rendering a basemap requires an OS Maps API Key, available from the [OS Data Hub](https://osdatahub.os.uk/). If you already have access to the OS Data Hub, skip to the [Adding an OS basemap page](/more-than-maps/advanced-applications/os-ngd-data-in-dashboards/os-power-bi-map-visual/os-power-bi-map-visual-getting-started-guide/adding-an-os-basemap.md); otherwise, sign up for access to the OS Data Hub using the instructions below.

### Signing up for the OS Data Hub

For Public Sector Geospatial Agreement (PSGA) Members:

* Register via the appropriate [Public Sector Plan on the OS Data Hub](https://osdatahub.os.uk/plans).
* You’ll need to be invited by the administrator of your organisation’s OS Data Hub account. (It’s usually someone in your GIS / Geospatial Team). If you can’t find your OS Data Hub Administrator or want to know their contact details, please contact <powerbiapp@os.uk> or your OS Account Manager.

For individuals and commercial organisations:

* Register via an [OS Open Data plan on the OS Data Hub](https://osdatahub.os.uk/plans) to use the OS Maps API for free.

{% hint style="warning" %}
Please note that the maximum zoom levels will be capped for maps using the free OS OpenData plan. The maximum zoom levels will incur a cost as they are classed as Premium data. A Premium data toggle is present within the visual to control this, so you can choose whether to use Premium data or stick to free OS OpenData.

For more information on which zoom levels are OS OpenData and which are Premium data for the OS Maps API, please see the tables on the [OS Maps API Layer and Styles page](https://docs.os.uk/os-apis/accessing-os-apis/os-maps-api/layers-and-styles).

* Users requiring maps without restrictions will require a Premium OS data licence. This can be acquired via an [OS Partner](https://www.ordnancesurvey.co.uk/customers/businesses/find-a-business-partner).
  {% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.os.uk/more-than-maps/advanced-applications/os-ngd-data-in-dashboards/os-power-bi-map-visual/os-power-bi-map-visual-getting-started-guide/installation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
