Class

LocalMapProvider

Initializes a new instance of the LocalMapProvider class with default settings and generates a unique identifier.

Declaration

public LocalMapProvider()

Initializes a new instance of the LocalMapProvider class with specified directory path and file naming format.

Declaration

public LocalMapProvider(string directoryPath, string fileFormat)

Parameters

Gets or sets the cache provider instance, which is always null for local providers as caching is not applicable.

Declaration

public IMapCacheProvider CacheProvider { get; set; }

Property Value

Implements IMapTileProvider.CacheProvider

Gets or sets the root directory path where tile image files are stored in the local file system.

Declaration

public virtual string DirectoryPath { get; set; }

Property Value

Gets or sets a value indicating whether caching is enabled, which is always false for local providers as files are already stored locally.

Declaration

public bool EnableCaching { get; set; }

Property Value

Implements IMapTileProvider.EnableCaching

Gets or sets the file naming format string used to construct tile file paths from coordinates and zoom level parameters.

Declaration

public virtual string FileFormat { get; set; }

Property Value

Gets the unique identifier for this local map provider instance.

Declaration

public virtual string Id { get; }

Property Value

Implements IMapProvider.Id

Gets or sets a value indicating whether this LocalMapProvider has completed initialization and is ready for tile loading.

Declaration

public bool Initialized { get; protected set; }

Property Value

Gets or sets the maximum zoom level supported by this local map provider for tile display and navigation.

Declaration

public virtual int MaxZoomLevel { get; set; }

Property Value

Implements IMapProvider.MaxZoomLevel

Gets or sets the minimum zoom level supported by this local map provider for tile display and navigation.

Declaration

public virtual int MinZoomLevel { get; set; }

Property Value

Implements IMapProvider.MinZoomLevel

Gets or sets a fallback image displayed when a requested tile file cannot be found or loaded from the local file system.

Declaration

public Image NoImageAvailable { get; set; }

Property Value

Gets the settings that control tile rendering behavior.

Declaration

public MapTileProviderSettings Settings { get; }

Property Value

Implements IMapTileProvider.Settings

Gets or sets the tile downloader instance, which is always null for local providers as tiles are loaded from local files.

Declaration

public IMapTileDownloader TileDownloader { get; set; }

Property Value

Implements IMapTileProvider.TileDownloader

Gets or sets the standard tile size in pixels used by this local map provider for all tile operations and rendering.

Declaration

public Size TileSize { get; set; }

Property Value

Implements IMapTileProvider.TileSize

Creates a shallow copy of this LocalMapProvider instance with all configuration settings and state information.

Declaration

public virtual object Clone()

Returns

Implements ICloneable.Clone()

Generates map visual elements for the specified viewport by providing tile images loaded from the local file system.

Declaration

public virtual IEnumerable<MapVisualElement> GetContent(IMapViewport viewport)

Parameters

Returns

Implements IMapProvider.GetContent(IMapViewport)

Retrieves the list of supported map views, which returns null for local map providers as they do not support multiple views.

Declaration

public virtual List<MapViewInfo> GetSupportedViews()

Returns

Implements IMapProvider.GetSupportedViews()

Retrieves a tile image from the local file system using the specified tile coordinates and zoom level.

Declaration

public Image GetTileImage(int x, int y, int zoom)

Parameters

Returns

Implements IMapTileProvider.GetTileImage(int, int, int)

Initializes the local map provider by setting the initialized state and triggering the initialization complete event.

Declaration

public virtual void Initialize()

Implements IMapProvider.Initialize()

Loads a tile image from the local file system using the specified coordinates and zoom level, returning a fallback image if not found.

Declaration

public virtual Image LoadTile(int x, int y, int zoom)

Parameters

Returns

Raises the InitializationComplete event to notify subscribers that provider initialization has finished.

Declaration

protected virtual void OnInitializationComplete(EventArgs e)

Parameters

Raises the InitializationError event to notify subscribers that provider initialization has failed.

Declaration

protected virtual void OnInitializationError(InitializationErrorEventArgs e)

Parameters

Raises the ProviderUpdated event to notify subscribers that provider content has changed.

Declaration

protected virtual void OnProviderUpdated(EventArgs e)

Parameters

Sets the active map view, which has no effect for local map providers as they do not support multiple views.

Declaration

public virtual void SetView(MapViewInfo view)

Parameters

Implements IMapProvider.SetView(MapViewInfo)

Responds to viewport changes by calculating visible tiles, loading tile images from local files, and preparing visual elements for rendering.

Declaration

public virtual void ViewportChanged(IMapViewport viewport, ViewportChangeAction action)

Parameters

Implements IMapProvider.ViewportChanged(IMapViewport, ViewportChangeAction)

Occurs when the local map provider has completed its initialization process and is ready for use.

Declaration

public event EventHandler InitializationComplete

Event Value

Implements IMapProvider.InitializationComplete

Occurs when provider initialization encounters an error during setup.

Declaration

public event InitializationErrorEventHandler InitializationError

Event Value

Implements IMapProvider.InitializationError

Occurs when the provider content has been updated with new tile data or configuration changes.

Declaration

public event EventHandler ProviderUpdated

Event Value

Implements IMapProvider.ProviderUpdated