image property

SignpostImg get image

Get the signpost image as a SignpostImg.

Prefer SignpostImg when you need SDK-managed metadata (uid, recommended size/aspectRatio, scalability) or to request raw image bytes; use getImage when you only need the raster image bytes.

Which image is rendered?

The native layer records, at the moment this handle is created, whether the underlying signpost matches the one on the currently-active NavigationInstruction (as reported by NavigationService.getNavigationInstruction()). If it does, calls on the returned SignpostImg re-resolve the image from the live instruction at render time — even if the engine has since replaced the instruction (next step, rematch, route recalculation, arrival) and the native memory backing this Dart handle has been recycled. This prevents use-after-free on the render thread.

For handles obtained from a RouteInstructionBase (route preview, static route-instruction list) or from SignpostDetails belonging to a non-active route, rendering uses the image captured at the moment this SignpostImg was created, as before.

Returns

  • SignpostImg: an abstract image object containing metadata and rendering helpers.

See also:

Implementation

SignpostImg get image {
  final OperationResult resultString = objectMethod(
    pointerId,
    'SignpostDetails',
    'getImg',
  );

  return SignpostImg.init(resultString['result']);
}