OSM Map control

Unit OSM.TilesProvider

Description
Uses
Classes, Interfaces, Objects and Records
Functions and Procedures
Types
Constants
Variables

Description

Generic (no real implementation) base class for tile image provider. Stores properties that could be specific to real providers.

(c) Fr0sT-Brutal https://github.com/Fr0sT-Brutal/Delphi_OSMMap

Overview

Classes, Interfaces, Objects and Records

Name Description
Record TPropertyValue Value and description of one option of a required property that is used to generate tile URL
Record TRequiredProperty Value and description of a required property that is used to generate tile URL.
Class TTilesProvider Abstract base class for tile image provider.
Class TTilesProviderWithProps Tiles provider that implements storing of properties
Class TDummyTilesProvider Dummy tile provider class, used as a stub in map control if no real provider is assigned.

Functions and Procedures

procedure RegisterTilesProvider(TilesProviderClass: TTilesProviderClass);
function FormatTileURL(const Template: string; const Tile: TTile; Provider: TTilesProvider): string;

Types

TTileProviderFeature = (...);
TTileProviderFeatures = set of TTileProviderFeature;
TRequiredProperties = array of TRequiredProperty;
TTilesProviderClass = class of TTilesProvider;

Variables

TilesProviders: TArray<TTilesProviderClass>;

Description

Functions and Procedures

procedure RegisterTilesProvider(TilesProviderClass: TTilesProviderClass);

Add class of tiles provider to global TilesProviders array. Handles multiple calls with the same class (by ignoring duplicates).

function FormatTileURL(const Template: string; const Tile: TTile; Provider: TTilesProvider): string;

Format URL for a given tile using OpenLayers-compatible URL template. Template could contain following placeholders enclosed in {}'s:

  • {x} - horizontal tile number

  • {y} - vertical tile number

  • {z} - zoom level

  • {?|?|...} - set of any values used to determine random subdomain

  • {?-?} - range of digits or chars used to determine random subdomain

  • {key} - provider API key (Provider.APIKey property)

  • {?} - where "?" is any string - provider property named "?" (obtained via Provider.Properties)

Types

TTileProviderFeature = (...);

Specific feature of a tile provider

Values
  • tpfRequiresAPIKey
TTileProviderFeatures = set of TTileProviderFeature;

This item has no description.

TRequiredProperties = array of TRequiredProperty;

This item has no description.

TTilesProviderClass = class of TTilesProvider;

This item has no description.

Variables

TilesProviders: TArray<TTilesProviderClass>;

Global list of registered tiles providers. Use it if you want to support multiple providers within the same app.

Authors

Generated by PasDoc 0.16.0.