showMapScale property

bool get showMapScale

Check whether the map scale is shown.

Returns

True if the map scale is shown, false otherwise.

See also:

• areMapScalesDrawnByUser - Check rendering mode.
• mapScalePosition - Get the scale position.

Implementation

bool get showMapScale {
  final OperationResult resultString = objectMethod(
    _pointerId,
    'MapViewPreferences',
    'isMapScaleShown',
    dependencyId: _mapPointerId,
  );

  return resultString['result'];
}

set showMapScale (bool value)

Show or hide the map scale.

Controls whether the map scale bar is displayed on the map. The scale bar shows the correspondence between screen distance and real-world distance at the current zoom level. When areMapScalesDrawnByUser is false (the default), the SDK automatically draws the scale. When true, you must provide rendering instructions via GemMapController.registerOnRenderMapScale.

Parameters

• value: (bool) True to show the map scale, false to hide it.

See also:

• showMapScale getter - Check current visibility.
• areMapScalesDrawnByUser - Control SDK vs. custom rendering.
• mapScalePosition - Position the scale on screen.
• GemMapController.registerOnRenderMapScale - Custom scale rendering.

Implementation

set showMapScale(final bool value) {
  objectMethod(
    _pointerId,
    'MapViewPreferences',
    'showMapScale',
    args: value,
    dependencyId: _mapPointerId,
  );
}