Class

MiniMapElement

Initializes a new instance of the MiniMapElement class with default input behavior for interactive mini map navigation.

Declaration

public MiniMapElement()

Identifies the ViewportControlBackColor dependency property that defines the background color of the viewport control rectangle.

Declaration

public static RadProperty ViewportControlBackColorProperty

Field Value

Identifies the ViewportControlBorderColor dependency property that defines the border color of the viewport control rectangle.

Declaration

public static RadProperty ViewportControlBorderColorProperty

Field Value

Declaration

protected bool isBringIntoView

Field Value

Declaration

protected bool suspendViewportUpdates

Field Value

Gets a value indicating whether a collapse or expand animation is currently active, preventing user interactions during the transition.

Declaration

public bool IsAnimating { get; protected set; }

Property Value

Gets or sets a value indicating whether the mini map is currently collapsed to show only the toggle button.

Declaration

public bool IsCollapsed { get; set; }

Property Value

Gets the main map element that this mini map is associated with for synchronization and viewport management.

Declaration

public RadMapElement MapElement { get; }

Property Value

Gets or sets the mini map display mode that determines how the mini map behaves in relation to the main map zoom level and viewport.

Declaration

public MiniMapMode MiniMapMode { get; set; }

Property Value

Gets or sets the size of the mini map display area, automatically scaled for DPI settings with layout invalidation support.

Declaration

public Size MiniMapSize { get; set; }

Property Value

Gets the toggle button element that allows users to expand or collapse the mini map display.

Declaration

public MiniMapToggleButtonElement ToggleMiniMapButton { get; }

Property Value

Gets or sets the background color of the viewport control rectangle that represents the main map's visible area within the mini map.

Declaration

public Color ViewportControlBackColor { get; set; }

Property Value

Gets or sets the border color of the viewport control rectangle that represents the main map's visible area within the mini map.

Declaration

public Color ViewportControlBorderColor { get; set; }

Property Value

Gets or sets the current zoom level of the mini map, with special handling for WholeWorld mode where zoom level is fixed at 1.

Declaration

public override int ZoomLevel { get; set; }

Property Value

Overrides BaseMapElement.ZoomLevel

Gets or sets the zoom offset used to calculate the mini map zoom level relative to the main map when MiniMapMode is set to OffsetZoom.

Declaration

public int ZoomOffset { get; set; }

Property Value

Arranges the mini map child elements within the specified final size, positioning the toggle button in the top-right corner.

Declaration

protected override SizeF ArrangeOverride(SizeF finalSize)

Parameters

Returns

Overrides BaseMapElement.ArrangeOverride(SizeF)

Brings the specified geographic location into view by centering the mini map viewport on that location.

Declaration

public override void BringIntoView(PointG location)

Parameters

Overrides BaseMapElement.BringIntoView(PointG)

Calculates the viewport dimensions and geographic bounds based on the current mini map mode and final size.

Declaration

protected override void CalculateViewport(SizeF finalSize)

Parameters

Overrides BaseMapElement.CalculateViewport(SizeF)

Collapses the mini map to show only the toggle button using animated size transition.

Declaration

public virtual void Collapse()

Creates and initializes the child elements of the mini map, including the toggle button for expand/collapse functionality.

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

Creates and configures the toggle button element for expanding and collapsing the mini map display.

Declaration

protected virtual MiniMapToggleButtonElement CreateToggleMiniMapButton()

Returns

Draws the viewport control rectangle that represents the main map's visible area within the mini map display.

Declaration

protected virtual void DrawViewportControlRectangle(IGraphics graphics, float angle, SizeF scale)

Parameters

Expands the mini map to show the full map display using animated size transition.

Declaration

public virtual void Expand()

Initializes the default field values and visual properties for the mini map element, including border settings and size configuration.

Declaration

protected override void InitializeFields()

Overrides BaseMapElement.InitializeFields()

Measures the required size for the mini map element, handling collapsed state and animation constraints.

Declaration

protected override SizeF MeasureOverride(SizeF availableSize)

Parameters

Returns

Overrides LightVisualElement.MeasureOverride(SizeF)

Handles the completion of the collapse animation, finalizing the collapsed state and updating the toggle button state.

Declaration

protected virtual void OnCollapseAnimationFinished(object sender, AnimationStatusEventArgs e)

Parameters

Handles the completion of the expand animation, finalizing the expanded state and updating the toggle button state.

Declaration

protected virtual void OnExpandAnimationFinished(object sender, AnimationStatusEventArgs e)

Parameters

Handles viewport changes from the main map element, synchronizing the mini map display when in OffsetZoom mode.

Declaration

protected virtual void OnMapElementViewportChanged(object sender, ViewportChangedEventArgs e)

Parameters

Handles property change notifications, specifically managing layout invalidation when the MaxSize property changes.

Declaration

protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides BaseMapElement.OnPropertyChanged(RadPropertyChangedEventArgs)

Handles the completion of map provider initialization by cloning the provider for mini map use and updating the viewport display.

Declaration

public override void OnProviderInitializationComplete(IMapProvider mapProvider)

Parameters

Overrides BaseMapElement.OnProviderInitializationComplete(IMapProvider)

Handles the toggle button state changed event, triggering expand or collapse operations based on the new toggle state.

Declaration

protected virtual void OnToggleMiniMapButtonToggleStateChanged(object sender, StateChangedEventArgs args)

Parameters

Handles the toggle button state changing event, preventing state changes during animation transitions.

Declaration

protected virtual void OnToggleMiniMapButtonToggleStateChanging(object sender, StateChangingEventArgs args)

Parameters

Paints the mini map in OffsetZoom mode with clipping and viewport control rectangle overlay.

Declaration

protected virtual void PaintDynamicMiniMap(IGraphics graphics, float angle, SizeF scale)

Parameters

Overrides the base paint element method to prevent default painting behavior in favor of mode-specific rendering.

Declaration

protected override void PaintElement(IGraphics graphics)

Parameters

Overrides BaseMapElement.PaintElement(IGraphics)

Paints the mini map element with mode-specific rendering logic and viewport control rectangle display.

Declaration

protected override void PaintElement(IGraphics graphics, float angle, SizeF scale)

Parameters

Overrides BaseMapElement.PaintElement(IGraphics, float, SizeF)

Paints the content from map providers, with caching support during animations for improved performance.

Declaration

protected override void PaintProvidersContent(IGraphics graphics)

Parameters

Overrides BaseMapElement.PaintProvidersContent(IGraphics)

Paints the mini map in StaticZoom mode with clipping and viewport control rectangle overlay.

Declaration

protected virtual void PaintStaticMiniMap(IGraphics graphics, float angle, SizeF scale)

Parameters

Paints the mini map in WholeWorld mode with scaled rendering and viewport control rectangle overlay.

Declaration

protected virtual void PaintWholeWorldMiniMap(IGraphics graphics, float angle, SizeF scale)

Parameters

Performs pan operations on the mini map with mode-specific handling for WholeWorld, StaticZoom, and OffsetZoom modes.

Declaration

public override void Pan(long x, long y)

Parameters

Overrides BaseMapElement.Pan(long, long)

Associates the mini map with a new main map element, managing event subscriptions for viewport synchronization.

Declaration

protected virtual void SetMapElement(RadMapElement mapElement)

Parameters

Sets the mini map display mode, managing event subscriptions and triggering necessary layout and viewport updates.

Declaration

protected virtual void SetMiniMapMode(MiniMapMode mode)

Parameters

Sets the zoom offset value and triggers viewport updates when the mini map is in OffsetZoom mode.

Declaration

protected virtual void SetZoomOffset(int value)

Parameters

Subscribes to the main map viewport change events to maintain synchronization between the mini map and main map displays.

Declaration

protected virtual void Subscribe()

Unsubscribes from the main map viewport change events to prevent memory leaks and unwanted synchronization during disposal.

Declaration

protected virtual void Unsubscribe()

Performs zoom operations on the mini map, with restrictions based on the current mini map mode settings.

Declaration

public override void Zoom(int zoomLevel, bool animate, Point center)

Parameters

Overrides BaseMapElement.Zoom(int, bool, Point)