addPersistentStyleLayer method

Future<void> addPersistentStyleLayer(
  1. String arg_properties,
  2. LayerPosition? arg_layerPosition
)

Adds a new style layer.

Whenever a new style is being parsed and currently used style has persistent layers, an engine will try to do following:

  • keep the persistent layer at its relative position
  • keep the source used by a persistent layer
  • keep images added through addStyleImage method

In cases when a new style has the same layer, source or image resource, style's resources would be used instead and MapLoadingError event will be emitted.

@param properties A map of style layer properties. @param layerPosition If not empty, the new layer will be positioned according to layer position parameters.

@return A string describing an error if the operation was not successful, or empty otherwise.

Implementation

Future<void> addPersistentStyleLayer(
    String arg_properties, LayerPosition? arg_layerPosition) async {
  final BasicMessageChannel<Object?> channel = BasicMessageChannel<Object?>(
      'dev.flutter.pigeon.mapbox_maps_flutter.StyleManager.addPersistentStyleLayer',
      codec,
      binaryMessenger: _binaryMessenger);
  final List<Object?>? replyList = await channel
      .send(<Object?>[arg_properties, arg_layerPosition]) as List<Object?>?;
  if (replyList == null) {
    throw PlatformException(
      code: 'channel-error',
      message: 'Unable to establish connection on channel.',
    );
  } else if (replyList.length > 1) {
    throw PlatformException(
      code: replyList[0]! as String,
      message: replyList[1] as String?,
      details: replyList[2],
    );
  } else {
    return;
  }
}