Skip to content

Commit

Permalink
chore: Update CHANGELOG and README.
Browse files Browse the repository at this point in the history
  • Loading branch information
andreeaceachir142 committed May 23, 2024
1 parent 4e84609 commit 3cd5ae0
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 0 deletions.
2 changes: 2 additions & 0 deletions packages/map-template/.github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ When loading the MapsIndoors Map component for the first time, the map will resp
|`miTransitionLevel`|`number`|The zoom level on which to transition from Mapbox to MapsIndoors data. Default value is 17. This feature is only available for Mapbox. |
|`category`|`string`|If you want to indicate an active category on the map. The value should be the Key (Administrative ID). |
|`searchAllVenues`|`bool`|If you want to perform search across all venues in the solution. |
|`hideNonMatches`|`bool`|Determine whether the locations on the map should be filtered (only show the matched locations and hide the rest) or highlighted (show all locations and highlight the matched ones with a red dot by default). If set to true, the locations will be filtered. |

## Using Query Parameters

Expand Down Expand Up @@ -117,6 +118,7 @@ The supported query parameters are the following:
22. `miTransitionLevel` - The zoom level on which to transition from Mapbox to MapsIndoors data. Default value is 17. This feature is only available for Mapbox.
23. `category` - If you want to indicate an active category on the map. The value should be the Key (Administrative ID).
24. `searchAllVenues` - If you want to perform search across all venues in the solution.
25. `hideNonMatches` - Determine whether the locations on the map should be filtered (only show the matched locations and hide the rest) or highlighted (show all locations and highlight the matched ones with a red dot by default). If set to true, the locations will be filtered.

**Note!** All the query parameters need to be separated with the `&` symbol, without any spaces in between.
**Note!** When using parameters such as `directionsTo`, `directionsFrom`, `locationId`, `externalIDs`, and `tileStyle` make sure you are using the correct `apiKey` parameter to which they belong.
Expand Down
6 changes: 6 additions & 0 deletions packages/map-template/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.46.0] - 2024-05-23

### Added

- Added new property `hideNonMatches` which determines whether the locations on the map should be filtered (only show the matched locations and hide the rest) or highlighted (show all locations and highlight the matched ones with a red dot by default). If set to true, the locations will be filtered.

## [1.45.0] - 2024-05-15

### Added
Expand Down
2 changes: 2 additions & 0 deletions packages/map-template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ Note that when using the React component, the properties should conform to JSX p
|`mi-transition-level`|`miTransitionLevel`|`number`|The zoom level on which to transition from Mapbox to MapsIndoors data. Default value is 17. This feature is only available for Mapbox. |
|`category`|`category`|`string`|If you want to indicate an active category on the map. The value should be the Key (Administrative ID). |
|`search-all-venues`|`searchAllVenues`|`bool`|If you want to perform search across all venues in the solution. |
|`hide-non-matches`|`hideNonMatches`|`bool`|Determine whether the locations on the map should be filtered (only show the matched locations and hide the rest) or highlighted (show all locations and highlight the matched ones with a red dot by default). If set to true, the locations will be filtered. |

## Using Query Parameters

Expand Down Expand Up @@ -168,6 +169,7 @@ The supported query parameters are the following:
22. `miTransitionLevel` - The zoom level on which to transition from Mapbox to MapsIndoors data. Default value is 17. This feature is only available for Mapbox.
23. `category` - If you want to indicate an active category on the map. The value should be the Key (Administrative ID).
24. `searchAllVenues` - If you want to perform search across all venues in the solution.
25. `hideNonMatches` - Determine whether the locations on the map should be filtered (only show the matched locations and hide the rest) or highlighted (show all locations and highlight the matched ones with a red dot by default). If set to true, the locations will be filtered.

**Note!** All the query parameters need to be separated with the `&` symbol, without any spaces in between.
**Note!** When using parameters such as `directionsTo`, `directionsFrom`, `locationId`, `externalIDs`, and `tileStyle` make sure you are using the correct `apiKey` parameter to which they belong.
Expand Down

0 comments on commit 3cd5ae0

Please sign in to comment.