Flutter Map Heatmap

https://pub.dev/documentation/flutter_map_heatmap/latest
Admin
A simple heatmap plugin written for the Flutter Map package, implemented as a tile provider to...
Tokens:23,271
Snippets:273
Trust Score:9.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### applyContent(Uint8List contentIntList)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/RGBA32BitmapHeader/applyContent.html

Updates the header content by copying the provided byte list into the internal header buffer starting after the header size.

```APIDOC
## void applyContent(Uint8List contentIntList)

### Description
Updates the internal header buffer by setting a range of bytes from the provided `contentIntList`. This method copies data into the header starting from the `rgba32HeaderSize` offset up to the `fileLength`.

### Parameters
- **contentIntList** (Uint8List) - Required - The list of bytes to be applied to the header content.
```

--------------------------------

### Get fileLength property

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/RGBA32BitmapHeader/fileLength.html

Calculates the total file length by adding contentSize and rgba32HeaderSize.

```dart
int get fileLength => contentSize + rgba32HeaderSize;
```

--------------------------------

### int get fileLength

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/RGBA32BitmapHeader/fileLength.html

Returns the total length of the file as an integer, calculated by adding the content size to the RGBA32 header size.

```APIDOC
## int get fileLength

### Description
Returns the total size of the bitmap file. This is a computed property that sums the content size and the RGBA32 header size.

### Signature
`int get fileLength`

### Returns
- **int** - The total length of the file.
```

--------------------------------

### Cancel Loading with Dio

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapTilesProvider/getImageWithCancelLoadingSupport.html

Example of using a Dio CancelToken to abort an HTTP request when the cancelLoading future completes.

```dart
final cancelToken = CancelToken();
cancelLoading.then((_) => cancelToken.cancel());
```

--------------------------------

### bool get supportsCancelLoading

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapTilesProvider/supportsCancelLoading.html

A boolean property that signals to flutter_map internals whether to use getImageWithCancelLoadingSupport for cancellable tile loading or the standard getImage method. It defaults to false and should be overridden when implementing cancellable loading logic.

```APIDOC
## bool get supportsCancelLoading

### Description
Indicates to flutter_map internals whether to call `getImage` (when `false`) or `getImageWithCancelLoadingSupport` (when `true`). If `true`, the implementation must override `getImageWithCancelLoadingSupport` to avoid an `UnimplementedError`.

### Usage
- **Default Value**: `false`
- **Platform Note**: This property is primarily relevant for the web platform to optimize performance by cancelling in-flight HTTP requests when tiles are disposed.
```

--------------------------------

### HeatMapTilesProvider({required HeatMapDataSource dataSource, required HeatMapOptions heatMapOptions})

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapTilesProvider/HeatMapTilesProvider.html

Initializes a new instance of HeatMapTilesProvider with the specified data source and heatmap options.

```APIDOC
## HeatMapTilesProvider

### Description
Creates a new instance of the HeatMapTilesProvider, which is used to provide heatmap tiles to the map.

### Parameters
- **dataSource** (HeatMapDataSource) - Required - The source of the data to be rendered on the heatmap.
- **heatMapOptions** (HeatMapOptions) - Required - The configuration options for the heatmap appearance and behavior.
```

--------------------------------

### Define layerOpacity property

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapOptions/layerOpacity.html

This property is used to set or get the opacity of the heatmap layer.

```dart
double layerOpacity;
```

--------------------------------

### Implement buildHeaded method

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/Bitmap/buildHeaded.html

This method initializes an RGBA32BitmapHeader with the current size, width, and height, then applies the content and returns the header as a Uint8List.

```dart
Uint8List buildHeaded() {
  final header = RGBA32BitmapHeader(size, width, height)
    ..applyContent(content);
  return header.headerIntList;
}
```

--------------------------------

### int contentSize

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/RGBA32BitmapHeader/contentSize.html

The contentSize property allows for getting or setting the size of the bitmap content as an integer.

```APIDOC
## int contentSize

### Description
Gets or sets the size of the bitmap content.

### Type
int

### Implementation
```dart
int contentSize;
```
```

--------------------------------

### GrayScaleHeatMapPainter(constructor)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/GrayScaleHeatMapPainter/GrayScaleHeatMapPainter.html

Initializes a new instance of the GrayScaleHeatMapPainter with the required base image and data points.

```APIDOC
## GrayScaleHeatMapPainter(constructor)

### Description
Creates a new instance of GrayScaleHeatMapPainter to handle heatmap rendering logic.

### Parameters
- **baseCircle** (Image) - Required - The base image used for the heatmap circles.
- **buffer** (double) - Optional - Buffer value for the painter, defaults to 0.
- **data** (List<DataPoint>) - Required - The list of data points to be rendered on the heatmap.
- **minOpacity** (dynamic) - Optional - The minimum opacity for the heatmap, defaults to 0.5.
- **min** (double?) - Optional - The minimum value for the heatmap scale.
- **max** (double?) - Optional - The maximum value for the heatmap scale.
```

--------------------------------

### HeatMapOptions()

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapOptions/HeatMapOptions.html

Constructor for initializing heatmap configuration options.

```APIDOC
## HeatMapOptions()

### Description
Creates a new instance of HeatMapOptions to configure the appearance and behavior of a heatmap layer.

### Parameters
- **radius** (double) - Optional - The radius of each data point in the heatmap. Defaults to 30.
- **minOpacity** (double?) - Optional - The minimum opacity for the heatmap layer.
- **blurFactor** (double) - Optional - The blur factor applied to the heatmap, ranging from 0 to 1. Defaults to 0.5.
- **layerOpacity** (double) - Optional - The overall opacity of the heatmap layer, ranging from 0 to 1. Defaults to 0.75.
- **gradient** (Map<double, MaterialColor>?) - Optional - A map defining the color gradient for the heatmap.
```

--------------------------------

### HeatMapImage(List<DataPoint> data, HeatMapOptions heatmapOptions, double size)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapImage/HeatMapImage.html

Initializes a new instance of HeatMapImage with the provided data points, configuration options, and dimensions.

```APIDOC
## HeatMapImage Constructor

### Signature
`HeatMapImage(List<DataPoint> data, HeatMapOptions heatmapOptions, double size)`

### Description
Creates a new HeatMapImage instance which initializes the internal heatmap generator with the provided data points and configuration.

### Parameters
- **data** (List<DataPoint>) - Required - The list of data points to be rendered on the heatmap.
- **heatmapOptions** (HeatMapOptions) - Required - Configuration options for the heatmap appearance and behavior.
- **size** (double) - Required - The dimension (width and height) of the heatmap image.
```

--------------------------------

### HeatMap(HeatMapOptions options, double width, double height, List<DataPoint> data)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMap/HeatMap.html

Initializes a new HeatMap widget with the provided configuration options, dimensions, and data points.

```APIDOC
## HeatMap Constructor

### Description
Initializes a new instance of the HeatMap widget. This constructor sets the configuration options, defines the widget dimensions, and provides the initial data points for rendering.

### Signature
HeatMap(HeatMapOptions options, double width, double height, List<DataPoint> data)

### Parameters
- **options** (HeatMapOptions) - Required - Configuration settings for the heatmap.
- **width** (double) - Required - The width of the heatmap widget.
- **height** (double) - Required - The height of the heatmap widget.
- **data** (List<DataPoint>) - Required - A list of DataPoint objects to be displayed on the heatmap.
```

--------------------------------

### Initialize RGBA32BitmapHeader

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/RGBA32BitmapHeader/RGBA32BitmapHeader.html

Constructs the header by defining the file structure and pixel format using ByteData.

```dart
RGBA32BitmapHeader(this.contentSize, int width, int height) {
  headerIntList = Uint8List(fileLength);

  final ByteData bd = headerIntList.buffer.asByteData();
  bd.setUint8(0x0, 0x42);
  bd.setUint8(0x1, 0x4d);
  bd.setInt32(0x2, fileLength, Endian.little);
  bd.setInt32(0xa, rgba32HeaderSize, Endian.little);
  bd.setUint32(0xe, 108, Endian.little);
  bd.setUint32(0x12, width, Endian.little);
  bd.setUint32(0x16, -height, Endian.little);
  bd.setUint16(0x1a, 1, Endian.little);
  bd.setUint32(0x1c, 32, Endian.little); // pixel size
  bd.setUint32(0x1e, 3, Endian.little); //BI_BITFIELDS
  bd.setUint32(0x22, contentSize, Endian.little);
  bd.setUint32(0x36, 0x000000ff, Endian.little);
  bd.setUint32(0x3a, 0x0000ff00, Endian.little);
  bd.setUint32(0x3e, 0x00ff0000, Endian.little);
  bd.setUint32(0x42, 0xff000000, Endian.little);
}
```

--------------------------------

### Implementation of the ready property

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMap/ready.html

Defines the Completer instance used to track the readiness of the HeatMap.

```dart
final Completer<void> ready = Completer<void>();
```

--------------------------------

### Initialize Bitmap.fromHeadless

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/Bitmap/Bitmap.fromHeadless.html

Constructs a new Bitmap instance with specified width, height, and raw byte content.

```dart
Bitmap.fromHeadless(this.width, this.height, this.content);
```

--------------------------------

### Initialize HeatMap widget

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMap/HeatMap.html

The constructor requires options, dimensions, and a list of data points to initialize the color palette.

```dart
HeatMap(this.options, this.width, this.height, this.data) {
  _initColorPalette();
}
```

--------------------------------

### HeatMap(HeatMapOptions options, double width, double height, List<DataPoint> data)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMap-class.html

Constructor to initialize a new HeatMap instance with specific options, dimensions, and data points.

```APIDOC
### Constructor
HeatMap(HeatMapOptions options, double width, double height, List<DataPoint> data)

### Parameters
- **options** (HeatMapOptions) - Configuration options for the heatmap.
- **width** (double) - The width of the heatmap image.
- **height** (double) - The height of the heatmap image.
- **data** (List<DataPoint>) - The list of data points to be rendered on the heatmap.
```

--------------------------------

### Initialize HeatMapOptions

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapOptions/HeatMapOptions.html

Constructor definition for configuring heatmap layer settings.

```dart
HeatMapOptions(
    {this.radius = 30,
    this.minOpacity = 0.3,
    double blurFactor = 0.5,
    double layerOpacity = 0.75,
    Map<double, MaterialColor>? gradient})
    : gradient = gradient ?? defaultGradient,
    layerOpacity = layerOpacity >= 0 && layerOpacity <=1 ? layerOpacity : 0.75,
    blurFactor = blurFactor >= 0 && blurFactor <=1 ? blurFactor : 0.75;
```

--------------------------------

### Implement cloneHeadless method

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/Bitmap/cloneHeadless.html

Creates a new Bitmap instance using the width, height, and content of the current instance.

```dart
Bitmap cloneHeadless() {
  return Bitmap.fromHeadless(
    width,
    height,
    Uint8List.fromList(content),
  );
}
```

--------------------------------

### Initialize HeatMapTilesProvider

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapTilesProvider/HeatMapTilesProvider.html

Constructor definition for creating a new HeatMapTilesProvider instance.

```dart
HeatMapTilesProvider(
    {required this.dataSource, required this.heatMapOptions});
```

--------------------------------

### Initialize GrayScaleHeatMapPainter

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/GrayScaleHeatMapPainter/GrayScaleHeatMapPainter.html

Constructor definition for creating a new instance of GrayScaleHeatMapPainter.

```dart
GrayScaleHeatMapPainter(
    {required this.baseCircle,
    this.buffer = 0,
    required this.data,
    minOpacity = 0.5,
    this.min,
    this.max});
```

--------------------------------

### Initialize DataPoint

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/DataPoint/DataPoint.html

Constructor for creating a new DataPoint instance with specified x, y, and z coordinates.

```dart
DataPoint(this.x, this.y, this.z);
```

--------------------------------

### Initialize InMemoryHeatMapDataSource

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/InMemoryHeatMapDataSource/InMemoryHeatMapDataSource.html

The constructor requires a list of WeightedLatLng objects and computes the bounds based on the provided points.

```dart
InMemoryHeatMapDataSource({required this.data})
    : bounds = LatLngBounds.fromPoints(data.map((e) => e.latLng).toList());
```

--------------------------------

### AltBaseCirclePainter()

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/AltBaseCirclePainter/AltBaseCirclePainter.html

Initializes a new instance of AltBaseCirclePainter with the required radius and optional blur factor.

```APIDOC
## AltBaseCirclePainter()

### Description
Creates a new instance of the AltBaseCirclePainter class used for rendering circle-based heatmaps.

### Parameters
- **radius** (double) - Required - The radius of the circle.
- **blurFactor** (double) - Optional (default: 0.5) - The factor used to determine the blur intensity of the circle.
```

--------------------------------

### Uint8List buildHeaded()

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/Bitmap/buildHeaded.html

Constructs an RGBA32 bitmap header and returns it as a list of integers.

```APIDOC
## Uint8List buildHeaded()

### Description
Constructs an RGBA32 bitmap header using the current size, width, and height, applies the provided content, and returns the resulting header as a `Uint8List`.

### Signature
`Uint8List buildHeaded()`

### Returns
- **Uint8List** - The byte representation of the bitmap header.
```

--------------------------------

### cloneHeadless

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/Bitmap-class.html

Creates a copy of the current Bitmap instance.

```APIDOC
### Method
Bitmap cloneHeadless()

### Description
Returns a new Bitmap instance that is a clone of the current object.
```

--------------------------------

### Initialize GriddedHeatMapDataSource

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/GriddedHeatMapDataSource/GriddedHeatMapDataSource.html

Constructor for creating a new data source instance, requiring a list of weighted coordinates and a radius.

```dart
GriddedHeatMapDataSource({required this.data, required this.radius})
    : bounds = LatLngBounds.fromPoints(data.map((e) => e.latLng).toList());
```

--------------------------------

### Implement buildImage method

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/Bitmap/buildImage.html

This method uses a Completer to handle the asynchronous decoding of the image data returned by buildHeaded.

```dart
Future<ui.Image> buildImage() async {
  final Completer<ui.Image> imageCompleter = Completer();
  final headedContent = buildHeaded();
  ui.decodeImageFromList(headedContent, (ui.Image img) {
    imageCompleter.complete(img);
  });
  return imageCompleter.future;
}
```

--------------------------------

### buildHeaded

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/Bitmap-class.html

Generates a byte array containing the bitmap header and the raw content.

```APIDOC
### Method
Uint8List buildHeaded()

### Description
Returns a Uint8List representing the full bitmap file data including the header.
```

--------------------------------

### Initialize AltBaseCirclePainter

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/AltBaseCirclePainter/AltBaseCirclePainter.html

Constructor for creating an instance of AltBaseCirclePainter with required radius and optional blurFactor.

```dart
AltBaseCirclePainter({required this.radius, this.blurFactor = 0.5});
```

--------------------------------

### Implementing the paint method

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/AltBaseCirclePainter/paint.html

This implementation defines the drawing logic for the circle, including calculating the bounding rectangle, setting up a radial gradient, and drawing the path on the canvas.

```dart
@override
void paint(Canvas canvas, Size size) {
  final _width = size.width;
  final _height = size.height;
  final r2 = radius;

  final rect = Rect.fromPoints(Offset(_width / 2 - r2, _height / 2 - r2),
      Offset(_width / 2 + r2, _height / 2 + r2));

  var pointPaint = Paint()..color = Colors.black;

  pointPaint.strokeWidth = 4;

  final gradient = RadialGradient(
          colors: const [Color.fromRGBO(0, 0, 0, 1), Color.fromRGBO(0, 0, 0, 0)],
          stops: const [0, 1],
          radius: blurFactor)
      .createShader(rect);

  canvas.drawPath(
      Path()
        ..addArc(rect, 0, math.pi * 2)
        ..close(),
      Paint()..shader = gradient);
}
```

--------------------------------

### RGBA32BitmapHeader(int contentSize, int width, int height)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/RGBA32BitmapHeader-class.html

Constructs a new RGBA32BitmapHeader instance with the specified content size, width, and height.

```APIDOC
### Constructor
RGBA32BitmapHeader(int contentSize, int width, int height)

### Parameters
- **contentSize** (int) - The size of the content.
- **width** (int) - The width of the bitmap.
- **height** (int) - The height of the bitmap.
```

--------------------------------

### AltBaseCirclePainter Constructor

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/AltBaseCirclePainter-class.html

Creates an instance of AltBaseCirclePainter to define the visual properties of the circle to be painted.

```APIDOC
## AltBaseCirclePainter({required double radius, double blurFactor = 0.5})

### Description
Initializes a new painter instance with a specified radius and an optional blur factor for the gradient effect.

### Parameters
- **radius** (double) - Required - The radius of the circle to be painted.
- **blurFactor** (double) - Optional - The radius of the gradient applied to the painted circle. Defaults to 0.5.
```

--------------------------------

### applyContent(Uint8List contentIntList)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/RGBA32BitmapHeader-class.html

Applies the provided content list to the bitmap header.

```APIDOC
### Method
void applyContent(Uint8List contentIntList)

### Parameters
- **contentIntList** (Uint8List) - The content data to be applied to the header.
```

--------------------------------

### HeatMapLayer Implementation

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapLayer/HeatMapLayer.html

The constructor initializes the heatmap layer, defaulting to HeatMapOptions if none are provided.

```dart
HeatMapLayer(
    {super.key,
    HeatMapOptions? heatMapOptions,
    required this.heatMapDataSource,
    List<WeightedLatLng>? initialData,
    this.reset,
    this.tileDisplay = const TileDisplay.fadeIn(),
    this.maxZoom = 18.0})
    : heatMapOptions = heatMapOptions ?? HeatMapOptions();
```

--------------------------------

### HeatMapPaint Constructor

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapPaint-class.html

Initializes a new HeatMapPaint widget with the required configuration options, dimensions, and data points.

```APIDOC
## HeatMapPaint({Key? key, required HeatMapOptions options, required double width, required double height, required List<DataPoint> data})

### Description
Creates a HeatMapPaint widget instance to display heatmap data on a map.

### Parameters
- **key** (Key?) - Optional - Controls how the widget is replaced in the tree.
- **options** (HeatMapOptions) - Required - Configuration settings for the heatmap rendering.
- **width** (double) - Required - The width of the heatmap canvas.
- **height** (double) - Required - The height of the heatmap canvas.
- **data** (List<DataPoint>) - Required - The list of data points to be rendered on the heatmap.
```

--------------------------------

### Initialize WeightedLatLng

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/WeightedLatLng/WeightedLatLng.html

Use this constructor to create a new WeightedLatLng instance with a specific location and intensity.

```dart
WeightedLatLng(this.latLng, this.intensity);
```

--------------------------------

### Bitmap.cloneHeadless()

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/Bitmap/cloneHeadless.html

Creates a new Bitmap instance based on the current bitmap's width, height, and content.

```APIDOC
## Bitmap.cloneHeadless()

### Description
Creates a new `Bitmap` instance by copying the width, height, and content of the current `Bitmap` object into a new headless instance.

### Signature
`Bitmap cloneHeadless()`

### Returns
- **Bitmap** - A new instance of `Bitmap` initialized with the same dimensions and pixel data as the original.
```

--------------------------------

### Future<ui.Image> buildImage()

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/Bitmap/buildImage.html

Asynchronously builds a ui.Image representation of the heatmap. It uses a Completer to handle the image decoding process from the byte list generated by buildHeaded.

```APIDOC
## Future<ui.Image> buildImage()

### Description
Generates a `ui.Image` object from the heatmap data. This method is asynchronous and returns a `Future` that completes once the image has been decoded.

### Signature
`Future<ui.Image> buildImage()`

### Returns
- **Future<ui.Image>** - A future that resolves to the decoded `ui.Image` object.
```

--------------------------------

### Bitmap.fromHeadless(int width, int height, Uint8List content)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/Bitmap/Bitmap.fromHeadless.html

Creates a new Bitmap instance using the specified width, height, and raw byte content.

```APIDOC
## Bitmap.fromHeadless

### Description
Creates a new Bitmap instance with the provided dimensions and raw byte content.

### Signature
`Bitmap.fromHeadless(int width, int height, Uint8List content)`

### Parameters
- **width** (int) - The width of the bitmap.
- **height** (int) - The height of the bitmap.
- **content** (Uint8List) - The raw byte content of the bitmap.
```

--------------------------------

### Implement getTileUrl method

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapTilesProvider/getTileUrl.html

This implementation uses populateTemplatePlaceholders to generate the tile URL, handling both WMS options and standard URL templates.

```dart
String getTileUrl(TileCoordinates coordinates, TileLayer options) =>
    populateTemplatePlaceholders(
      options.wmsOptions?.getUrl(
            coordinates,
            options.tileSize.toInt(),
            options.resolvedRetinaMode == RetinaMode.simulation,
          ) ??
          options.urlTemplate ??
          (throw ArgumentError(
              '`wmsOptions` or `urlTemplate` must be provided to generate a tile URL')),
      coordinates,
      options,
    );
```

--------------------------------

### Initialize HeatMapImage

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapImage/HeatMapImage.html

Constructs a new HeatMapImage instance by initializing the internal HeatMap generator with the provided data, options, and dimensions.

```dart
HeatMapImage(this.data, HeatMapOptions heatmapOptions, double size)
    : generator = HeatMap(heatmapOptions, size, size, data);
```

--------------------------------

### Bitmap.fromHeadless

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/Bitmap-class.html

Creates a new Bitmap instance from raw RGBA content with specified dimensions.

```APIDOC
### Constructor
Bitmap.fromHeadless(int width, int height, Uint8List content)

### Description
Initializes a new Bitmap object using raw RGBA data.

### Parameters
- **width** (int) - The width of the bitmap.
- **height** (int) - The height of the bitmap.
- **content** (Uint8List) - The raw RGBA byte data.
```

--------------------------------

### HeatMapPainter(Image heatMapImage)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapPainter/HeatMapPainter.html

Initializes a new instance of the HeatMapPainter class with the specified heatmap image.

```APIDOC
## HeatMapPainter(Image heatMapImage)

### Description
Creates a new instance of the HeatMapPainter class. This constructor requires an Image object to represent the heatmap data.

### Parameters
- **heatMapImage** (Image) - Required - The image data to be used by the heatmap painter.
```

--------------------------------

### WeightedLatLng(LatLng latLng, double intensity)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/WeightedLatLng-class.html

Constructor to create a new WeightedLatLng instance with a specified coordinate and intensity.

```APIDOC
### Constructor
`WeightedLatLng(LatLng latLng, double intensity)`

Creates a new instance of `WeightedLatLng` by wrapping a `LatLng` object with a `double` intensity value.
```

--------------------------------

### HeatMapLayer(Key? key, HeatMapOptions? heatMapOptions, required HeatMapDataSource heatMapDataSource, List<WeightedLatLng>? initialData, Stream<void>? reset, TileDisplay tileDisplay, double maxZoom)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapLayer/HeatMapLayer.html

Initializes a new HeatMapLayer instance to be used within a flutter_map widget.

```APIDOC
## HeatMapLayer Constructor

### Description
Creates a new instance of a HeatMapLayer to render heatmap data on a map.

### Parameters
- **key** (Key?) - Optional - The widget key.
- **heatMapOptions** (HeatMapOptions?) - Optional - Configuration options for the heatmap.
- **heatMapDataSource** (HeatMapDataSource) - Required - The source of the heatmap data.
- **initialData** (List<WeightedLatLng>?) - Optional - Initial list of weighted coordinates to display.
- **reset** (Stream<void>?) - Optional - A stream to trigger a reset of the layer.
- **tileDisplay** (TileDisplay) - Optional - Defines how tiles are displayed (defaults to TileDisplay.fadeIn()).
- **maxZoom** (double) - Optional - The maximum zoom level for the layer (defaults to 18.0).
```

--------------------------------

### Implementation of the generate method

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMap/generate.html

This method waits for the heatmap to be ready, checks for empty data, and orchestrates the generation of the base shape, grayscale map, and final colorized image.

```dart
Future<Uint8List> generate() async {
  await ready.future;

  // if there is no data then return a transparent image
  if (data.isEmpty) {
    return kTransparentImage;
  }
  // generate shape to be used for all points on the heatmap
  final baseShape = await _getBaseShape();

  final grayscale = await _grayscaleHeatmap(baseShape);

  final heatmapBytes = await _colorize(grayscale);

  return heatmapBytes;
}
```

--------------------------------

### Implement generateReplacementMap

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapTilesProvider/generateReplacementMap.html

Override this method to define custom URL template placeholders. Ensure that the implementation handles zoom offsets, TMS coordinate conversion, and subdomains correctly.

```dart
@visibleForOverriding
Map<String, String> generateReplacementMap(
  String urlTemplate,
  TileCoordinates coordinates,
  TileLayer options,
) {
  final zoom = (options.zoomOffset +
          (options.zoomReverse
              ? options.maxZoom - coordinates.z.toDouble()
              : coordinates.z.toDouble()))
      .round();

  return {
    'x': coordinates.x.toString(),
    'y': (options.tms ? ((1 << zoom) - 1) - coordinates.y : coordinates.y)
        .toString(),
    'z': zoom.toString(),
    's': options.subdomains.isEmpty
        ? ''
        : options.subdomains[
            (coordinates.x + coordinates.y) % options.subdomains.length],
    'r': options.resolvedRetinaMode == RetinaMode.server ? '@2x' : '',
    'd': options.tileSize.toString(),
    ...options.additionalOptions,
  };
}
```

--------------------------------

### HeatMapOptions Constructor

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapOptions-class.html

Creates a new instance of HeatMapOptions to define the visual settings for a heatmap layer.

```APIDOC
### HeatMapOptions({double radius = 30, double? minOpacity = 0.3, double blurFactor = 0.5, double layerOpacity = 0.75, Map<double, MaterialColor>? gradient})

#### Parameters
- **radius** (double) - Default radius size applied during the painting of each point.
- **minOpacity** (double?) - The minimum opacity used when calculating the heatmap of an area (0 to 1).
- **blurFactor** (double) - The blur factor applied during painting (0 to 1).
- **layerOpacity** (double) - Opacity of the heatmap layer when displayed on a map.
- **gradient** (Map<double, MaterialColor>?) - Color gradient used for the heat map.
```

--------------------------------

### bool shouldRepaint(BaseCirclePainter oldDelegate)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/BaseCirclePainter/shouldRepaint.html

Determines if the painter should repaint based on whether the new instance represents different information than the old instance.

```APIDOC
## bool shouldRepaint(BaseCirclePainter oldDelegate)

### Description
Called whenever a new instance of the custom painter delegate class is provided to the RenderCustomPaint object. If the new instance represents different information than the old instance, the method should return true, otherwise it should return false.

### Parameters
- **oldDelegate** (BaseCirclePainter) - Required - The previous instance of the delegate.

### Returns
- **bool** - Returns true if the painter should repaint, false otherwise.
```

--------------------------------

### HeatMapImage(List<DataPoint> data, HeatMapOptions heatmapOptions, double size)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapImage-class.html

Creates a new HeatMapImage instance to serve as an image provider for heatmap data.

```APIDOC
## HeatMapImage(List<DataPoint> data, HeatMapOptions heatmapOptions, double size)

### Description
Constructs a HeatMapImage object which acts as an ImageProvider for rendering heatmaps.

### Parameters
- **data** (List<DataPoint>) - Required - The list of data points to be rendered on the heatmap.
- **heatmapOptions** (HeatMapOptions) - Required - Configuration options for the heatmap appearance.
- **size** (double) - Required - The size of the generated heatmap image.
```

--------------------------------

### Implement supportsCancelLoading

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapTilesProvider/supportsCancelLoading.html

The default implementation returns false, indicating that getImageWithCancelLoadingSupport is not supported.

```dart
bool get supportsCancelLoading => false;
```

--------------------------------

### HeatMapTilesProvider(HeatMapDataSource dataSource, HeatMapOptions heatMapOptions)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapTilesProvider-class.html

Constructs a new HeatMapTilesProvider instance with the specified data source and heatmap configuration.

```APIDOC
### Constructor
HeatMapTilesProvider({required HeatMapDataSource dataSource, required HeatMapOptions heatMapOptions})
```

--------------------------------

### DataPoint.fromOffset Implementation

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/DataPoint/DataPoint.fromOffset.html

This factory constructor initializes a DataPoint using the dx and dy coordinates from an Offset, with a default intensity of 1.

```dart
factory DataPoint.fromOffset(Offset offset) {
  return DataPoint(offset.dx, offset.dy, 1);
}
```

--------------------------------

### Initialize HeatMapState

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapState/HeatMapState.html

Constructor for HeatMapState that accepts HeatMapOptions and initializes the imageSink stream controller.

```dart
HeatMapState(this.options) {
  imageSink = StreamController.broadcast();
}
```

--------------------------------

### Initialize HeatMapPainter

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapPainter/HeatMapPainter.html

Constructor for creating a new instance of HeatMapPainter with a specified heatmap image.

```dart
HeatMapPainter(this.heatMapImage);
```

--------------------------------

### GrayScaleHeatMapPainter constructor

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/GrayScaleHeatMapPainter-class.html

Creates a new instance of the GrayScaleHeatMapPainter to handle heatmap rendering.

```APIDOC
## GrayScaleHeatMapPainter({required Image baseCircle, double buffer = 0, required List<DataPoint> data, dynamic minOpacity = 0.5, double? min, double? max})

### Description
Initializes the painter with the base image, data points, and optional configuration for opacity and value ranges.

### Parameters
- **baseCircle** (Image) - Required - The base image used for each data point.
- **buffer** (double) - Optional - Buffer size for the painter.
- **data** (List<DataPoint>) - Required - The list of data points to render.
- **minOpacity** (dynamic) - Optional - The minimum opacity for the heatmap.
- **min** (double?) - Optional - The minimum value for scaling.
- **max** (double?) - Optional - The maximum value for scaling.
```

--------------------------------

### onReady

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMap/onReady.html

A getter that returns a Future which completes when the HeatMap instance is fully initialized and ready.

```APIDOC
## Future<void> get onReady

### Description
A getter that returns a Future that completes when the HeatMap is ready. This can be used to await the initialization of the heatmap component.

### Signature
`Future<void> get onReady`
```

--------------------------------

### Implementing the paint method

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/BaseCirclePainter/paint.html

This implementation defines how to draw a circle with a radial gradient on the provided canvas.

```dart
@override
void paint(Canvas canvas, Size size) {
  final _width = size.width;
  final _height = size.height;

  var pointPaint = Paint()..color = Colors.green;

  pointPaint.strokeWidth = 4;

  final circlePaint = Paint();
  final rect = Rect.fromCircle(
      center: Offset(_width / 2, _height / 2), radius: radius);

  // create radial gradient
  final gradient = const RadialGradient(
          colors: [Color.fromRGBO(0, 0, 0, 1), Color.fromRGBO(0, 0, 0, 0)],
          stops: [0, 1],
          radius: 0.5,
          focalRadius: 0.85)
      .createShader(rect);

  circlePaint.shader = gradient;

  canvas.drawCircle(rect.center, radius, circlePaint);
  canvas.drawCircle(rect.center, radius, circlePaint);
}
```

--------------------------------

### Future<HeatMapImage> obtainKey(ImageConfiguration configuration)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapImage/obtainKey.html

Converts an ImageProvider's settings and an ImageConfiguration into a key that uniquely identifies the image to be loaded. This method is used by the image loading system to determine if an image is already cached or needs to be fetched.

```APIDOC
### Method Signature
`Future<HeatMapImage> obtainKey(ImageConfiguration configuration)`

### Description
Converts an ImageProvider's settings plus an ImageConfiguration to a key that describes the precise image to load. The returned key unambiguously identifies the image, including its scale, for the `loadImage` method.

### Parameters
- **configuration** (ImageConfiguration) - The configuration object used to determine the specific image properties.

### Returns
- **Future<HeatMapImage>** - A future that resolves to the key identifying the image. If the result is available synchronously, a `SynchronousFuture` is returned.
```

--------------------------------

### getImageWithCancelLoadingSupport(TileCoordinates coordinates, TileLayer options, Future<void> cancelLoading)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapTilesProvider/getImageWithCancelLoadingSupport.html

Retrieves a tile as an ImageProvider with support for cancelling the loading process. This method is intended to be overridden when supportsCancelLoading is set to true.

```APIDOC
## Method: getImageWithCancelLoadingSupport

### Description
Retrieves a tile as an image, based on its coordinates and the `TileLayer`. For this method to be called instead of `getImage`, `supportsCancelLoading` must be overridden to `true`.

### Signature
`ImageProvider<Object> getImageWithCancelLoadingSupport(TileCoordinates coordinates, TileLayer options, Future<void> cancelLoading)`

### Parameters
- **coordinates** (TileCoordinates) - The coordinates of the tile to retrieve.
- **options** (TileLayer) - The configuration options for the tile layer.
- **cancelLoading** (Future<void>) - A future that completes when the underlying tile is disposed or pruned, signaling that the loading process should be cancelled.

### Usage Notes
- This method is designed to allow implementations to cancel HTTP requests or other in-flight processing.
- It is primarily applicable to the web platform.
- If an image Codec is required during cancellation, decode `transparentImage`.
```

--------------------------------

### GriddedHeatMapDataSource({required List<WeightedLatLng> data, required double radius})

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/GriddedHeatMapDataSource/GriddedHeatMapDataSource.html

Initializes a new instance of GriddedHeatMapDataSource with the specified weighted data points and radius.

```APIDOC
## GriddedHeatMapDataSource

### Description
Creates a new instance of GriddedHeatMapDataSource. This constructor calculates the bounds of the heatmap based on the provided list of weighted coordinates.

### Constructor Signature
`GriddedHeatMapDataSource({required List<WeightedLatLng> data, required double radius})`

### Parameters
- **data** (List<WeightedLatLng>) - Required - A list of weighted latitude and longitude points to be displayed on the heatmap.
- **radius** (double) - Required - The radius used for the grid-based heatmap calculation.
```

--------------------------------

### Implementation of applyContent

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/RGBA32BitmapHeader/applyContent.html

This method updates the headerIntList by setting the range from the specified header size to the file length using the provided content list.

```dart
void applyContent(Uint8List contentIntList) {
  headerIntList.setRange(
    rgba32HeaderSize,
    fileLength,
    contentIntList,
  );
}
```

--------------------------------

### Implement size property

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/Bitmap/size.html

Calculates the total bitmap size by multiplying width, height, and bitmapPixelLength.

```dart
int get size => (width * height) * bitmapPixelLength;
```

--------------------------------

### Initialize HeatMapPaint

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapPaint/HeatMapPaint.html

Constructor definition for creating a new HeatMapPaint instance.

```dart
const HeatMapPaint(
    {Key? key,
    required this.options,
    required this.width,
    required this.height,
    required this.data})
    : super(key: key);
```

--------------------------------

### DataPoint(double x, double y, double z)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/DataPoint-class.html

Creates a new DataPoint instance with specified x, y coordinates and intensity z.

```APIDOC
### Constructor
DataPoint(double x, double y, double z)

### Description
Creates a new DataPoint instance with the specified x and y coordinates and intensity value z.

### Parameters
- **x** (double) - The x coordinate.
- **y** (double) - The y coordinate.
- **z** (double) - The intensity value.
```

--------------------------------

### bool shouldRepaint(HeatMapPainter oldDelegate)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapPainter/shouldRepaint.html

Determines if the custom painter should be repainted. Returns true if the new instance represents different information than the old instance, otherwise false.

```APIDOC
## bool shouldRepaint(HeatMapPainter oldDelegate)

### Description
Called whenever a new instance of the custom painter delegate class is provided to the RenderCustomPaint object. If the new instance represents different information than the old instance, the method should return true to trigger a repaint.

### Parameters
- **oldDelegate** (HeatMapPainter) - Required - The previous instance of the HeatMapPainter delegate.

### Returns
- **bool** - Returns true if the painter should be repainted, false otherwise.
```

--------------------------------

### HeatMapPainter(Image heatMapImage)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapPainter-class.html

Constructor for creating a new HeatMapPainter instance with a specified heatmap image.

```APIDOC
## HeatMapPainter(Image heatMapImage)

### Description
Creates a new instance of the HeatMapPainter class to render the provided heatmap image.

### Parameters
- **heatMapImage** (Image) - Required - The image data to be rendered as a heatmap.
```

--------------------------------

### shouldRepaint

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/AltBaseCirclePainter-class.html

Determines whether the painter needs to be repainted when a new instance is provided.

```APIDOC
## shouldRepaint(covariant AltBaseCirclePainter oldDelegate)

### Description
Called whenever a new instance of the custom painter delegate class is provided to the RenderCustomPaint object to determine if a repaint is necessary.

### Parameters
- **oldDelegate** (AltBaseCirclePainter) - Required - The previous instance of the painter.
```

--------------------------------

### BaseCirclePainter constructor

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/BaseCirclePainter/BaseCirclePainter.html

Initializes a new instance of BaseCirclePainter with the specified radius and optional blur factor.

```APIDOC
## BaseCirclePainter.new

### Description
Creates a new instance of the BaseCirclePainter class used for heatmap circle rendering.

### Signature
BaseCirclePainter({required double radius, double? blurFactor})

### Parameters
- **radius** (double) - Required - The radius of the circle to be painted.
- **blurFactor** (double?) - Optional - A factor used to determine the blur intensity of the circle.
```

--------------------------------

### bool shouldRepaint(GrayScaleHeatMapPainter oldDelegate)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/GrayScaleHeatMapPainter/shouldRepaint.html

Determines if the painter should repaint by comparing the current data with the old delegate's data.

```APIDOC
## bool shouldRepaint(GrayScaleHeatMapPainter oldDelegate)

### Description
Called whenever a new instance of the custom painter delegate class is provided. It returns true if the new instance represents different information than the old instance, triggering a repaint.

### Parameters
- **oldDelegate** (GrayScaleHeatMapPainter) - Required - The previous instance of the painter delegate.

### Returns
- **bool** - Returns true if the painter should repaint, false otherwise.
```

--------------------------------

### generate()

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMap-class.html

Generates the heatmap image as a byte array.

```APIDOC
### Method
Future<Uint8List> generate()

### Description
Asynchronously generates the heatmap image based on the provided data and options, returning the result as a Uint8List.
```

--------------------------------

### Implement getImage for HeatMapTilesProvider

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapTilesProvider/getImage.html

This implementation filters data points based on tile coordinates and returns a HeatMapImage provider. It requires supportsCancelLoading to be false.

```dart
@override
ImageProvider getImage(TileCoordinates coordinates, TileLayer options) {
  var tileSize = options.tileSize;

  // disable zoom level 0 for now. ned to refactor _filterData
  List<DataPoint> filteredData =
      coordinates.z != 0 ? _filterData(coordinates, options) : [];
  var scale = coordinates.z / 22 * 1.22;
  final radius = heatMapOptions.radius * scale;
  var imageHMOptions = HeatMapOptions(
    radius: radius,
    minOpacity: heatMapOptions.minOpacity,
    gradient: heatMapOptions.gradient,
  );
  return HeatMapImage(filteredData, imageHMOptions, tileSize);
}
```

--------------------------------

### bool shouldRepaint(AltBaseCirclePainter oldDelegate)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/AltBaseCirclePainter/shouldRepaint.html

Called whenever a new instance of the custom painter delegate class is provided to the RenderCustomPaint object. Returns true if the new instance represents different information than the old instance, otherwise returns false.

```APIDOC
## bool shouldRepaint(AltBaseCirclePainter oldDelegate)

### Description
Called whenever a new instance of the custom painter delegate class is provided to the RenderCustomPaint object. If the new instance represents different information than the old instance, the method should return true, otherwise it should return false.

### Parameters
- **oldDelegate** (AltBaseCirclePainter) - Required - The previous instance of the painter delegate.

### Returns
- **bool** - Returns true if the painter should be repainted, false otherwise.
```

--------------------------------

### Map<String, String> generateReplacementMap(String urlTemplate, TileCoordinates coordinates, TileLayer options)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapTilesProvider/generateReplacementMap.html

Generates a map of placeholders to replacements, used by populateTemplatePlaceholders to resolve URL templates. It is recommended to use TileLayer.additionalOptions for custom placeholders instead of overriding this method directly.

```APIDOC
## generateReplacementMap

### Description
Generates a Map of placeholders to replacements, to be used in `populateTemplatePlaceholders`. Instead of overriding this directly, consider using `TileLayer.additionalOptions` to inject additional placeholders.

### Signature
`Map<String, String> generateReplacementMap(String urlTemplate, TileCoordinates coordinates, TileLayer options)`

### Parameters
- **urlTemplate** (String) - The URL template string.
- **coordinates** (TileCoordinates) - The coordinates of the tile.
- **options** (TileLayer) - The configuration options for the tile layer.

### Returns
- **Map<String, String>** - A map containing the resolved values for placeholders like 'x', 'y', 'z', 's', 'r', and 'd', along with any additional options.
```

--------------------------------

### paint

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/AltBaseCirclePainter-class.html

Method to perform the actual drawing of the circle on the provided canvas.

```APIDOC
## paint(Canvas canvas, Size size)

### Description
Called whenever the object needs to paint. The coordinate space is configured with the origin at the top left of the box defined by the size argument.

### Parameters
- **canvas** (Canvas) - Required - The canvas on which to draw.
- **size** (Size) - Required - The size of the area to be painted.
```

--------------------------------

### void paint(Canvas canvas, Size size)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/BaseCirclePainter/paint.html

The paint method is called whenever the object needs to render itself. It provides a Canvas and the Size of the area available for drawing.

```APIDOC
## void paint(Canvas canvas, Size size)

### Description
Called whenever the object needs to paint. The given Canvas has its coordinate space configured such that the origin is at the top left of the box.

### Parameters
- **canvas** (Canvas) - The canvas on which to draw.
- **size** (Size) - The size of the box to paint within.
```

--------------------------------

### Implement obtainKey for HeatMapImage

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapImage/obtainKey.html

Returns a SynchronousFuture containing the current instance to identify the image resource synchronously.

```dart
@override
Future<HeatMapImage> obtainKey(ImageConfiguration configuration) {
  return SynchronousFuture(this);
}
```

--------------------------------

### Initialize BaseCirclePainter

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/BaseCirclePainter/BaseCirclePainter.html

Constructor definition for BaseCirclePainter requiring a radius and optional blurFactor.

```dart
BaseCirclePainter({required this.radius, this.blurFactor});
```

--------------------------------

### void paint(Canvas canvas, Size size)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/AltBaseCirclePainter/paint.html

The paint method is called whenever the object needs to render itself. It uses the provided Canvas and Size to draw a radial gradient circle based on the painter's configuration.

```APIDOC
## void paint(Canvas canvas, Size size)

### Description
Called whenever the object needs to paint. The given Canvas has its coordinate space configured such that the origin is at the top left of the box. The area of the box is the size of the `size` argument.

### Parameters
- **canvas** (Canvas) - The canvas on which to paint.
- **size** (Size) - The size of the area to paint within.
```

--------------------------------

### Add dependencies to pubspec.yaml

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/index.html

Include the required packages in your project's pubspec file.

```yaml
dependencies:
  flutter_map: ^6.0.0
  flutter_map_heatmap: any # or the latest version on Pub
  latlong2: ^0.9.0
```

--------------------------------

### Implementation of populateTemplatePlaceholders

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapTilesProvider/populateTemplatePlaceholders.html

The internal implementation of the method, which uses generateReplacementMap to resolve placeholders and throws an ArgumentError if a placeholder value is missing.

```dart
@visibleForOverriding
String populateTemplatePlaceholders(
  String urlTemplate,
  TileCoordinates coordinates,
  TileLayer options,
) {
  final replacementMap =
      generateReplacementMap(urlTemplate, coordinates, options);

  return urlTemplate.replaceAllMapped(
    templatePlaceholderElement,
    (match) {
      final value = replacementMap[match.group(1)!];
      if (value != null) return value;
      throw ArgumentError(
        'Missing value for placeholder: {${match.group(1)}}',
      );
    },
  );
}
```

--------------------------------

### Initialize HeatMapDataPoint

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapDataPoint/HeatMapDataPoint.html

Use this constructor to define a point on the heatmap with x and y coordinates and an optional intensity value.

```dart
HeatMapDataPoint(this.x, this.y, {this.intensity = 1});
```

--------------------------------

### String toString()

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/WeightedLatLng/toString.html

Returns a string representation of the WeightedLatLng object, including its latLng and intensity properties.

```APIDOC
## String toString()

### Description
Returns a string representation of the WeightedLatLng object. This is primarily used for debugging or logging purposes to inspect the object state.

### Signature
`String toString()`

### Returns
- **String** - A string formatted as 'WeightedLatLng{latLng: $latLng, intensity: $intensity}'.
```

--------------------------------

### DataPoint.fromOffset(Offset offset)

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/DataPoint/DataPoint.fromOffset.html

Creates a new DataPoint instance using the dx and dy coordinates from the provided Offset, with a default intensity of 1.

```APIDOC
## DataPoint.fromOffset

### Description
Creates a DataPoint from a Flutter `Offset` object. This factory constructor extracts the `dx` and `dy` values from the offset and initializes the point with a default intensity of 1.

### Signature
`DataPoint.fromOffset(Offset offset)`

### Parameters
- **offset** (Offset) - Required - The coordinate offset containing the x and y values to be used for the DataPoint.
```

--------------------------------

### buildImage

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/Bitmap-class.html

Converts the bitmap data into a Flutter Image object.

```APIDOC
### Method
Future<Image> buildImage()

### Description
Asynchronously converts the current bitmap data into a displayable Image object.
```

--------------------------------

### HeatMapLayer Constructor

Source: https://pub.dev/documentation/flutter_map_heatmap/latest/flutter_map_heatmap/HeatMapLayer-class.html

The constructor for the HeatMapLayer widget, used to initialize the heatmap layer with data and configuration options.

```APIDOC
## HeatMapLayer({Key? key, HeatMapOptions? heatMapOptions, required HeatMapDataSource heatMapDataSource, List<WeightedLatLng>? initialData, Stream<void>? reset, TileDisplay tileDisplay = const TileDisplay.fadeIn(), double maxZoom = 18.0})

### Description
Creates a new HeatMapLayer widget to display heatmap data on a map.

### Parameters
- **key** (Key?) - Optional - Controls how one widget replaces another widget in the tree.
- **heatMapOptions** (HeatMapOptions?) - Optional - Configuration options for the heatmap appearance.
- **heatMapDataSource** (HeatMapDataSource) - Required - The source providing data points for the heatmap.
- **initialData** (List<WeightedLatLng>?) - Optional - Initial list of weighted coordinates to display.
- **reset** (Stream<void>?) - Optional - A stream to trigger a reset of the heatmap layer.
- **tileDisplay** (TileDisplay) - Optional - Defines how tiles are displayed (defaults to fadeIn).
- **maxZoom** (double) - Optional - The maximum zoom level at which the heatmap is rendered (defaults to 18.0).
```
Tokens:
Raw