Skip to content

Commit a9261a3

Browse files
committed
Update PinConfig examples
1 parent 5e66578 commit a9261a3

File tree

1 file changed

+12
-6
lines changed
  • packages/google_maps_flutter/google_maps_flutter_platform_interface/lib/src/types

1 file changed

+12
-6
lines changed

packages/google_maps_flutter/google_maps_flutter_platform_interface/lib/src/types/bitmap.dart

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -999,7 +999,7 @@ class BytesMapBitmap extends MapBitmap {
999999
/// PinConfig(
10001000
/// backgroundColor: Colors.blue,
10011001
/// borderColor: Colors.white,
1002-
/// glyph: Glyph.color(Colors.blue)
1002+
/// glyph: CircleGlyph(color: Colors.blue)
10031003
/// )
10041004
/// ```
10051005
///
@@ -1009,7 +1009,7 @@ class BytesMapBitmap extends MapBitmap {
10091009
/// ```dart
10101010
/// PinConfig(
10111011
/// backgroundColor: Colors.blue,
1012-
/// glyph: Glyph.text('Pin', Colors.white)
1012+
/// glyph: TextGlyph(text: 'Pin', textColor: Colors.white)
10131013
/// )
10141014
/// ```
10151015
///
@@ -1018,8 +1018,8 @@ class BytesMapBitmap extends MapBitmap {
10181018
///
10191019
/// ```dart
10201020
/// PinConfig(
1021-
/// glyph: Glyph.bitmapDescriptor(
1022-
/// BitmapDescriptor.asset(
1021+
/// glyph: BitmapGlyph(
1022+
/// bitmap: BitmapDescriptor.asset(
10231023
/// ImageConfiguration(size: Size(12, 12)),
10241024
/// 'assets/cat.png'
10251025
/// )
@@ -1053,7 +1053,13 @@ class PinConfig extends BitmapDescriptor {
10531053
/// The border color of the pin.
10541054
final Color? borderColor;
10551055

1056-
/// The glyph that is displayed on the pin marker.
1056+
/// The glyph that is displayed on the pin marker. If null, the default
1057+
/// circular glyph is used.
1058+
///
1059+
/// Can be one of the following:
1060+
/// * [CircleGlyph] to define a circular glyph with a custom color.
1061+
/// * [BitmapGlyph] to define a glyph with a specified bitmap.
1062+
/// * [TextGlyph] to define a glyph with a specified text and its color.
10571063
final AdvancedMarkerGlyph? glyph;
10581064

10591065
@override
@@ -1073,7 +1079,7 @@ abstract class AdvancedMarkerGlyph extends BitmapDescriptor {
10731079
const AdvancedMarkerGlyph._() : super._();
10741080
}
10751081

1076-
/// Defines a glyph using the default circle, but with a custom color.
1082+
/// Defines a circular glyph with a given color.
10771083
class CircleGlyph extends AdvancedMarkerGlyph {
10781084
/// Constructs a glyph instance, using the default circle, but with
10791085
/// a custom color.

0 commit comments

Comments
 (0)