Skip to content

Minor documentation updates #1377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
danbits wants to merge 2 commits into from
Closed

Minor documentation updates #1377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ff4877
Update controller argument name in usage example
danbits Sep 26, 2022
11b9e12
Remove outdated reference to raster mixed mode
danbits Sep 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions getting-started/explanation/raster-vs-vector-tiles.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,3 @@ However it does add complexity to the rendering process as each element needs to
### Using Vector Tiles

Due to the complications mentioned above, 'flutter\_map' does not natively support vector tiles. However, vector tiles can be used with a [community maintained plugin (`vector_map_tiles`)](https://github.com/greensopinion/flutter-vector-map-tiles) to do this.

The plugin also supports 'mixed' mode to get the best of both worlds: using raster images during animations to improve performance, and vector rendering to provide sharp visuals and custom theming when idle.
4 changes: 2 additions & 2 deletions usage/basics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

```dart
FlutterMap(
controller: MapController(),
mapController: MapController(),
Copy link
Copy Markdown
Author

@danbits danbits Sep 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JaffaKetchup Should this line be included as well?

Copy link
Copy Markdown
Member

@JaffaKetchup JaffaKetchup Sep 27, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. Sorry, missed this one!

options: MapOptions(),
children: [],
),
Expand All @@ -18,7 +18,7 @@ This is the main widget for this library, and it takes three main properties. op
* ``[`children`](layers/) (required)

Takes a list of `Widget`s that will be displayed on the map. These can be any widget, but are usually`Layer`s.
* ``[`controller`](controller.md) (optional)
* ``[`mapController`](controller.md) (optional)

Takes a `MapController` that can be used to programmatically control the map, as well as listen to an events `Stream`.

Expand Down