Merge branch 'release/2.1.0'

ddubrava · Aug 2, 2020 · c0ca0c3 · c0ca0c3
2 parents 171f0b3 + ae5ee41
commit c0ca0c3
Show file tree

Hide file tree

Showing 25 changed files with 1,140 additions and 257 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,13 @@
 # Changelog
 All notable changes from v1.0.0 will be documented in this file.
 
+## [2.1.0] - 2020-08-02
+### Added
+- Clusterer component
+
+### Changed
+- Clusterer input from ya-map was removed
+
 ## [2.0.1] - 2020-07-30
 ### Fixed
 - Wrong tag selector in README.md & QuickStart.md

diff --git a/docs/README.md b/docs/README.md
@@ -3,27 +3,4 @@ The library implements the base Yandex.Maps functionality. By the way you can ac
 
 Leave suggestions, problems, errors, difficulties in GitHub Issues. Star the repository and thanks for using the library!
 
-## Examples
-##### Popular
-- [Using a custom image for the placemark](https://stackblitz.com/edit/custom-placemark)
-- [Efficiently adding lots of placemarks to the map](https://stackblitz.com/edit/placemark-clusterer)
-- [Route to the point on the map](https://stackblitz.com/edit/route-to)
-- [Searching for organizations](https://stackblitz.com/edit/search-for-organizations)
-- [Calculating delivery cost](https://stackblitz.com/edit/calculating-delivery-cost)
-
-##### Panorama
-- [Panorama](https://stackblitz.com/edit/panorama)
-
-##### GeoObjects
-- [Changing a placemark icon when hovering over it](https://stackblitz.com/edit/changing-a-placemark-on-hover)
-- [Rectangle](https://stackblitz.com/edit/rectangle)
-- [Polygon](https://stackblitz.com/edit/geoobject-polygon)
-- [Circle](https://stackblitz.com/edit/geoobject-circle)
-
-##### Multiroute
-- [Building a driving multiroute](https://stackblitz.com/edit/multiroute)
-- [Building a pedestrian multiroute](https://stackblitz.com/edit/multiroute-pedestrian)
-
-##### Controls
-- [Search Control](https://stackblitz.com/edit/searchcontrol)
-- [RoutePanel Control](https://stackblitz.com/edit/route-panel)
+[filename](examples.md ':include')
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -4,6 +4,7 @@
 - Components
   - [Map](map.md 'Map | Angular Yandex Map')
   - [Panorama](panorama.md 'Panorama | Angular Yandex Map')
+  - [Clusterer](clusterer.md 'Clusterer | Angular Yandex Map')
   - [Placemark](placemark.md 'Placemark | Angular Yandex Map')
   - [GeoObject](geoobject.md 'GeoObject | Angular Yandex Map')
   - [Multiroute](multiroute.md 'Multiroute | Angular Yandex Map')

diff --git a/docs/clusterer.md b/docs/clusterer.md
@@ -0,0 +1,39 @@
+# Clusterer
+
+Component, geo object clusterer. Clusterizes objects in the visible area of the map. If the object does not fall within the visible area of the map, it will not be added to the map. Note, that the clusterer does not react to changing the coordinates of objects (either programmatically, or as the result of dragging). If you want to change the coordinates of some object in the clusterer, you should first delete the object from the clusterer and then add it back
+
+## Usage
+
+```html
+<ya-map [center]="[55.74, 37.58]">
+  <ya-clusterer>
+    <ya-placemark [geometry]="[55.74, 37.50]"></ya-placemark>
+    <ya-geoobject [feature]="{ geometry: { type: 'Point', coordinates: [55.73, 37.52] } }"></ya-geoobject>
+  </ya-clusterer>
+</ya-map>
+```
+
+## Inputs
+
+| Name         | Type         | Default | Required | Description                                                                              |
+|--------------|--------------|---------|----------|------------------------------------------------------------------------------------------|
+| options      | [ClustererOptions] |         | no       | Options for the clusterer                                                          |
+
+[ClustererOptions]: https://tech.yandex.com/maps/jsapi/doc/2.1/ref/reference/Clusterer-docpage/#Clusterer__param-options
+
+## Outputs
+
+| Name          | Type         | Supported event type | Description                                                    |
+|---------------|--------------|----------------------|----------------------------------------------------------------|
+| load          | [ILoadEvent] |                      | Emits immediately after this entity is added in root container |
+| hint          | [IEvent]     | hintopen, hintclose  | Action with hint                                               |
+| mapChange     | [IEvent]     | mapChange            | MMap reference changed                                         |
+| optionsChange | [IEvent]     | optionsChange        | Change to the object options                                   |
+| parentChange  | [IEvent]     | parentChange         | The parent object reference changed                            |
+
+[ILoadEvent]: https://github.com/ddubrava/angular-yandex-maps/blob/develop/projects/angular8-yandex-maps/src/lib/models/models.ts#L23
+[IEvent]: https://github.com/ddubrava/angular-yandex-maps/blob/develop/projects/angular8-yandex-maps/src/lib/models/models.ts#L34
+
+## ContentChildren
+- [Placemark](placemark.md)
+- [GeoObject](geoobject.md)
diff --git a/docs/controls.md b/docs/controls.md
@@ -15,7 +15,7 @@ Creating and managing controls on the map
 | Name       | Type   | Default | Required | Description                                                                                                              |
 |------------|--------|---------|----------|--------------------------------------------------------------------------------------------------------------------------|
 | type       | String |         | yes      | Control type. List of types you can find in left list - [Controls]. E.g. Control.FullscreenControl - 'FullscreenControl' |
-| parameters | any    |         | no       | Parameters for the Control                                                                                               |
+| parameters | Any    |         | no       | Parameters for the Control                                                                                               |
 
 [Controls]: https://tech.yandex.ru/maps/jsapi/doc/2.1/ref/reference/control.Button-docpage/
 

diff --git a/docs/geoobject.md b/docs/geoobject.md
@@ -1,6 +1,6 @@
 # GeoObject
 
-Component that can be displayed as a placemark, polyline, polygon, etc., depending on the geometry type.
+Component, geo object. Can be displayed as a placemark, polyline, polygon, etc., depending on the geometry type. You can also use auxiliary classes for simplified creation of geo objects with a specific geometry type
 
 ## Usage
 

diff --git a/docs/map.md b/docs/map.md
@@ -10,18 +10,16 @@ Component for creating and managing a map
 
 ## Inputs
 
-| Name         | Type         | Default | Required | Description                                                                            |
-|--------------|--------------|---------|----------|----------------------------------------------------------------------------------------|
-| onlyInstance | boolean      | false   | no       | The component returns only ILoadEvent. It's useful when you need only the ymaps object |
-| center       | Number[]     |         | yes      | Map center geocoordinates                                                              |
-| zoom         | Number       | 10      | no       | Map zoom level                                                                         |
-| state        | [MapState]   |         | no       | States for the map                                                                     |
-| options      | [MapOptions] |         | no       | Options for the map                                                                    |
-| clusterer    | [Clusterer]  |         | no       | Options for the Clusterer. Clusters ONLY Placemarks in the visible area of the map     |
+| Name         | Type         | Default | Required | Description                                                                              |
+|--------------|--------------|---------|----------|------------------------------------------------------------------------------------------|
+| onlyInstance | Boolean      | false   | no       | The component returns only [ILoadEvent]. It's useful when you need only the ymaps object |
+| center       | Number[]     |         | yes      | Map center geocoordinates                                                                |
+| zoom         | Number       | 10      | no       | Map zoom level                                                                           |
+| state        | [MapState]   |         | no       | States for the map                                                                       |
+| options      | [MapOptions] |         | no       | Options for the map                                                                      |
 
 [MapState]: https://tech.yandex.ru/maps/jsapi/doc/2.1/ref/reference/Map-docpage/#Map__param-state
 [MapOptions]: https://tech.yandex.ru/maps/jsapi/doc/2.1/ref/reference/Map-docpage/#Map__param-options
-[Clusterer]: https://tech.yandex.ru/maps/jsapi/doc/2.1/ref/reference/Clusterer-docpage/
 
 ## Outputs
 

diff --git a/docs/multiroute.md b/docs/multiroute.md
@@ -15,7 +15,7 @@ Component for Multi-route on the map
 | Name            | Type                                                    | Default | Required | Description                          |
 |-----------------|---------------------------------------------------------|---------|----------|--------------------------------------|
 | referencePoints | [IMultiRouteReferencePoint][][]                         |         | yes      | Reference points for the multi-route |
-| model           | [multiRouter.MultiRouteModel] || [MultiRouteModelJson]  |         | no       | Properties for the multiroute        |
+| model           | [multiRouter.MultiRouteModel] or [MultiRouteModelJson]  |         | no       | Properties for the multiroute        |
 | options         | [MultiRouteOptions]                                     |         | no       | Options for the multiroute           |
 
 [IMultiRouteReferencePoint]: https://tech.yandex.ru/maps/jsapi/doc/2.1/ref/reference/IMultiRouteReferencePoint-docpage/

diff --git a/docs/panorama.md b/docs/panorama.md
@@ -10,11 +10,11 @@ Component for creating and controlling the panorama player
 
 ## Inputs
 
-| Name    | Type            | Default | Required           | Description                                  |
-|---------|-----------------|---------|--------------------|----------------------------------------------|
-| point   | Number[]        |         | yes                | The point for searching for nearby panoramas |
-| layer   | yandex#panorama |         | yandex#airPanorama | The layer to search for panoramas            |
-| options | [PlayerOptions] |         | no                 | Options for the player                       |
+| Name    | Type                                  | Default | Required           | Description                                  |
+|---------|---------------------------------------|---------|--------------------|----------------------------------------------|
+| point   | Number[]                              |         | yes                | The point for searching for nearby panoramas |
+| layer   | yandex#panorama or yandex#airPanorama |         | yandex#airPanorama | The layer to search for panoramas            |
+| options | [PlayerOptions]                       |         | no                 | Options for the player                       |
 
 [PlayerOptions]:https://tech.yandex.com/maps/jsapi/doc/2.1/ref/reference/panorama.Player-docpage/#panorama.Player__param-options
 

diff --git a/docs/placemark.md b/docs/placemark.md
@@ -1,6 +1,6 @@
 # Placemark
 
-Component, geo object with the geometry geometry.Point.
+Component, geo object with the geometry geometry.Point
 
 ## Usage
 
@@ -12,11 +12,11 @@ Component, geo object with the geometry geometry.Point.
 
 ## Inputs
 
-| Name       | Type                                   | Default | Required | Description                                      |
-|------------|----------------------------------------|---------|----------|--------------------------------------------------|
-| geometry   | Number[] || Object || [IPointGeometry] |         | yes      | Placemark coordinates...more in Yandex.Maps docs |
-| properties | [PlacemarkProperties]                  |         | no       | Properties for the placemark                     |
-| options    | [PlacemarkOptions]                     |         | no       | States for the placemark                         |
+| Name       | Type                                   | Default | Required | Description                                                                                                   |
+|------------|----------------------------------------|---------|----------|---------------------------------------------------------------------------------------------------------------|
+| geometry   | Number[] or Object or [IPointGeometry] |         | yes      | Coordinates of the placemark, or a hash describing the geometry, or a reference to the point geometry object. |
+| properties | [PlacemarkProperties]                  |         | no       | Properties for the placemark                                                                                  |
+| options    | [PlacemarkOptions]                     |         | no       | States for the placemark                                                                                      |
 
 [IPointGeometry]: https://tech.yandex.ru/maps/jsapi/doc/2.1/ref/reference/IPointGeometry-docpage
 [PlacemarkProperties]: https://tech.yandex.ru/maps/jsapi/doc/2.1/ref/reference/Placemark-docpage/#Placemark__param-properties